django-channels 入门

2018/6/5 posted in  python

基本的流程组件

routing.py

添加websocket的基本监听路径,所有的websocket的相关内容放置在这个路径之下

在routing之中使用ProtocolTypeRouter来定义相应的application入口,这个是2.0引入的新特性,在第一个版本中不这么使用

# mysite/routing.py
from channels.auth import AuthMiddlewareStack
from channels.routing import ProtocolTypeRouter, URLRouter
import chat.routing

application = ProtocolTypeRouter({
    # (http->django views is added by default)
    'websocket': AuthMiddlewareStack(
        URLRouter(
            chat.routing.websocket_urlpatterns
        )
    ),
})

外层中间件使用ProtocolTypeRouter,并结合使用AuthMiddlewareStack中间件来将routing文件指定到内部文件。

# chat/routing.py
from django.conf.urls import url

from . import consumers

websocket_urlpatterns = [
    url(r'^ws/chat/(?P<room_name>[^/]+)/$', consumers.ChatConsumer),
]

内部文件也使用类似urlpatterns的模式来进行,这里是讲这个chat 下面room_name的所有都制定到ChatConsumer里面。可以发现这里制定的是Consumer对象而不是具体的一个方法。这个和老版本的还是有一些区别的。

在setting中需要加入这个application的配置项

# mysite/settings.py
# Channels
ASGI_APPLICATION = 'mysite.routing.application'

Consumer

在定义WebSocket的时候最后加上/ws/的路径,这样能够更好地区分Http请求和webscoket请求,从而更好进行优化。同时也更方便在部署的时候让nginx更好的将不同的目录给不同的部件去解析。WSGI Server使用 Gunicorn + Django 来解析Http请求;ASGI Server 可以使用Daphne+Channels来解析WebSocket请求。

对于小型的网站可以使用Daphne Server就可以同时解析HTTP和socket请求,从而不需要划分。

# chat/consumers.py
from channels.generic.websocket import WebsocketConsumer
import json

class ChatConsumer(WebsocketConsumer):
    def connect(self):
        self.accept()

    def disconnect(self, close_code):
        pass

    def receive(self, text_data):
        text_data_json = json.loads(text_data)
        message = text_data_json['message']

        self.send(text_data=json.dumps({
            'message': message
        }))

这个是最基本同步连接请求,从同步端接收请求等

同步请求的Consumer如下

# chat/consumers.py
from channels.generic.websocket import AsyncWebsocketConsumer
import json

class ChatConsumer(AsyncWebsocketConsumer):
    async def connect(self):
        self.room_name = self.scope['url_route']['kwargs']['room_name']
        self.room_group_name = 'chat_%s' % self.room_name

        # Join room group
        await self.channel_layer.group_add(
            self.room_group_name,
            self.channel_name
        )

        await self.accept()

    async def disconnect(self, close_code):
        # Leave room group
        await self.channel_layer.group_discard(
            self.room_group_name,
            self.channel_name
        )

    # Receive message from WebSocket
    async def receive(self, text_data):
        text_data_json = json.loads(text_data)
        message = text_data_json['message']

        # Send message to room group
        await self.channel_layer.group_send(
            self.room_group_name,
            {
                'type': 'chat_message',
                'message': message
            }
        )

    # Receive message from room group
    async def chat_message(self, event):
        message = event['message']

        # Send message to WebSocket
        await self.send(text_data=json.dumps({
            'message': message
        }))