Django+channels实现WebSocket笔记

consumer类的学习

channel layer属于纯粹的异步接口，如果想要从同步代码调用，需要使用装饰器asgiref.sync.async_to_sync

配置CHANNEL_LAYER的基本语法如下

CHANNEL_LAYERS = {
    "default": {
        "BACKEND": "channels_redis.core.RedisChannelLayer",
        "CONFIG": {
            "hosts": [("redis-server-name", 6379)],
        },
    },
}

默认获取channel_layer的方式是调用接口：channels.layers.get_channel_layer()，如果是在consumer中调用接口的话可以直接使用self.channel_layer

同步函数

对于channel layer的方法（包括send()、group_send()，group_add()等）

都属于异步方法，这意味着在调用的时候都需要使用await，而如果想要在同步代码中使用它们，就需要使用装饰器asgiref.sync.async_to_sync

from asgiref.sync import async_to_sync

async_to_sync(channel_layer.send)("channel_name", {...})

通过channel layer发送了什么

不同于channel1.x，channel2.0的channel layer 仅适用于高级应用程序之间的通讯。当用户发送message的时候，会先传送到consumer中，然后对应的consumer会监听对应的group或者channel，而不是直接将message传输到socket中

这意味着用户可以传输高level的event到channel layer，然后让consumer进行处理这些event然后选择低level的网络连接进行执行

比如，Andrew Godwin的存储库的的实例channels_examples通过channel layer 发送这样一个事件

await self.channel_layer.group_send(
    room.group_name,
    {
        "type": "chat.message",
        "room_id": room_id,
        "username": self.scope["user"].username,
        "message": message,
    }
)

然后consumer定义一个处理函数接收这个事件并转化成websocket框架

async def chat_message(self, event):
    """
    Called when someone has messaged our chat.
    """
    # Send a message down to the client
    await self.send_json(
        {
            "msg_type": settings.MSG_TYPE_MESSAGE,
            "room": event["room_id"],
            "username": event["username"],
            "message": event["message"],
        },
    )

所有基于SyncConsumer或AsyncConsumer的consumer都提供了两个属性：self.channel_layer和self.channel_name属性，分别为指向channel layer的指针和consumer的channel layer的名字

发送到channel的message或者添加到channel的group的message，都会由consumer接收，就像来自连接的客户端的事件一样，根据相应的命名方式选择对应的consumer，命名方法是将.替换成_，在上述的例子中，type的value是chat.message，对应的处理方法就是chat_message

如果是从AsyncConsumer继承的话所有的event处理方法都要使用异步方法（async def），同样的，如果是SyncConsumer的话就要使用同步方法（def）

single channel

每个应用程序实例，比如long-running的HTTP请求或者websocket连接都会产生一个相应的consumer实例，此时如果还启用了channel layer的话，consumer还会再生成一个对应的channel layer，并开始监听它的event

这就意味着可以从进程的外部（从其他的consumer或者管理命令）来发送consumer event，而对于对应的consumer，也会做出响应，将这些来自consumer的event当做来自客户端的event一样进行处理

channel_name可以在consumer中调用self.channel_name属性获取

class ChatConsumer(WebsocketConsumer):

    def connect(self):
        # Make a database row with our channel name
        Clients.objects.create(channel_name=self.channel_name)

    def disconnect(self, close_code):
        # Note that in some rare cases (power loss, etc) disconnect may fail
        # to run; this naive example would leave zombie channel names around.
        Clients.objects.filter(channel_name=self.channel_name).delete()

    def chat_message(self, event):
        # Handles the "chat.message" event when it's sent to us.
        self.send(text_data=event["text"])

但是，由于混合了来自channel layer和连接协议的event，需要确保类型名称不会发生冲突，建议像这里的代码一样添加前缀名称(chat.)来进行区分，避免冲突

而要发送某个channel，只需要找到对应的名称，调用channel_layer.send就可以了

from channels.layers import get_channel_layer

channel_layer = get_channel_layer()
await channel_layer.send("channel_name", {
    "type": "chat.message",
    "text": "Hello there!",
})

group

对于大多数情况来说，发送到单人的channel并没有用，更多的情况下希望可以以广播的方式将message一次性发送给多个channel或者consumer，这不仅适用于想在向房间内的每个人发送消息，还适用于发送给连接了多个浏览器/标签/设备的用户

对于group来说

• 是一个广播系统
• 允许从命名组中添加和删除channel，也支持发送group
• 提供group到期清理应用程序无法处理的连接

你可以在connect方法中添加组，在disconnect中删除组，代码如下

# This example uses WebSocket consumer, which is synchronous, and so
# needs the async channel layer functions to be converted.
from asgiref.sync import async_to_sync

class ChatConsumer(WebsocketConsumer):

    def connect(self):
        async_to_sync(self.channel_layer.group_add)("chat", self.channel_name)

    def disconnect(self, close_code):
        async_to_sync(self.channel_layer.group_discard)("chat", self.channel_name)

如果想要发送message到group中，可以使用group_send方法

class ChatConsumer(WebsocketConsumer):

    ...

    def receive(self, text_data):
        async_to_sync(self.channel_layer.group_send)(
            "chat",
            {
                "type": "chat.message",
                "text": text_data,
            },
        )

    def chat_message(self, event):
        self.send(text_data=event["text"])

在consumer外调用channel layer

如果在consumer的范围外发送message到channel layer的时候，self.channel_layer是不可用的，此时需要使用get_channel_layer方法

from channels.layers import get_channel_layer
channel_layer = get_channel_layer()

在实例化之后就可以进行调用了，但是需要注意的是，get_channel_layer()需要异步使用，调用的时候需要添加await

for chat_name in chats:
    await channel_layer.group_send(
        chat_name,
        {"type": "chat.system_message", "text": announcement_text},
    )```
####或者也可以使用async_to_sync来使用

 

from asgiref.sync import async_to_sync

async_to_sync(channel_layer.group_send)("chat", {"type": "chat.force_disconnect"})