Django 中的并发请求处理：使用 channels 实现实时通信。

2023-08-09 00:40

短信预约 -IT技能 免费直播动态提醒

Django 是一个广受欢迎的 Python Web 框架，它为开发人员提供了一个强大的工具箱，使他们可以轻松地构建高效、可扩展的 Web 应用程序。然而，对于那些需要实现实时通信的应用程序来说，Django 的默认请求处理方式并不是最佳的选择。幸运的是，Django Channels 提供了一种更好的方式来处理并发请求，使得实时通信变得更加容易。

Django Channels 是 Django 的一个扩展，它基于 ASGI（异步服务器网关接口）协议，提供了一种异步的、事件驱动的并发请求处理方式。使用 Channels，我们可以轻松地实现 WebSockets、长轮询、实时聊天等实时通信功能。接下来，我们将通过一个简单的示例来演示如何使用 Channels 实现实时通信。

首先，我们需要安装 Channels。使用 pip 命令即可：

pip install channels

接下来，我们需要创建一个 ASGI 应用程序。在 Django 2.0 及以上版本中，可以使用内置的 asgi.py 文件来创建 ASGI 应用程序。如果你的 Django 版本低于 2.0，你需要手动创建一个 asgi.py 文件。下面是一个简单的 asgi.py 文件示例：

import os
from django.core.asgi import get_asgi_application
from channels.routing import ProtocolTypeRouter, URLRouter
from channels.auth import AuthMiddlewareStack
from myapp import routing

os.environ.setdefault("DJANGO_SETTINGS_MODULE", "myproject.settings")

application = ProtocolTypeRouter({
    "http": get_asgi_application(),
    "websocket": AuthMiddlewareStack(
        URLRouter(
            routing.websocket_urlpatterns
        )
    ),
})

在这个示例中，我们首先导入了必要的模块，包括 Django 的 get_asgi_application 函数和 Channels 的 ProtocolTypeRouter、URLRouter 和 AuthMiddlewareStack 类。然后，我们设置了 DJANGO_SETTINGS_MODULE 环境变量，并创建了一个 ProtocolTypeRouter 对象，用于处理不同类型的请求。这个对象包含两个键值对，分别对应 HTTP 和 WebSocket 请求。对于 HTTP 请求，我们使用 get_asgi_application 函数获取默认的 Django 应用程序。对于 WebSocket 请求，我们使用 AuthMiddlewareStack 和 URLRouter 将请求路由到正确的处理程序。

接下来，我们需要创建一个 WebSocket 处理程序。在 Channels 中，WebSocket 处理程序是一个异步的 Python 函数，它接收一个 WebSocket 对象作为输入，并使用它来发送和接收实时消息。下面是一个简单的 WebSocket 处理程序示例：

import json
from channels.generic.websocket import AsyncWebsocketConsumer

class MyConsumer(AsyncWebsocketConsumer):
    async def connect(self):
        await self.accept()

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

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

在这个示例中，我们首先导入了必要的模块，包括 json 模块和 AsyncWebsocketConsumer 类。然后，我们创建了一个名为 MyConsumer 的类，它继承自 AsyncWebsocketConsumer。这个类中定义了两个异步函数：connect 和 receive。

在 connect 函数中，我们调用了 accept 函数，这个函数用于接受 WebSocket 连接。在 receive 函数中，我们首先将传入的文本数据解析为 JSON 格式，然后提取出 message 字段。最后，我们使用 send 函数将消息发送回客户端。

现在，我们已经创建了一个 ASGI 应用程序和一个 WebSocket 处理程序，接下来我们需要将它们连接起来。为此，我们需要创建一个 URL 配置文件，将 WebSocket 路由到正确的处理程序。下面是一个简单的 URL 配置文件示例：

from django.urls import re_path
from myapp.consumers import MyConsumer

websocket_urlpatterns = [
    re_path(r"ws/myapp/(?P<room_name>w+)/$", MyConsumer.as_asgi()),
]

在这个示例中，我们首先导入了必要的模块，包括 re_path 函数和 MyConsumer 类。然后，我们创建了一个名为 websocket_urlpatterns 的列表，这个列表包含了一个正则表达式和一个处理程序。这个正则表达式用于匹配 WebSocket 请求的 URL，其中 (?Pw+) 表示将 URL 中的 room_name 参数提取出来，并将它传递给处理程序。最后，我们使用 MyConsumer.as_asgi() 函数将处理程序转换为一个 ASGI 应用程序。

现在，我们已经完成了 ASGI 应用程序、WebSocket 处理程序和 URL 配置文件的创建。接下来，我们需要在模板中引入 JavaScript 代码，以便与 WebSocket 服务器建立连接并发送和接收消息。下面是一个简单的 JavaScript 代码示例：

var roomName = "myroom";
var socket = new WebSocket("ws://" + window.location.host + "/ws/myapp/" + roomName + "/");

socket.onopen = function() {
    console.log("WebSocket connection established.");
};

socket.onmessage = function(event) {
    var message = JSON.parse(event.data).message;
    console.log("Received message: " + message);
};

socket.onclose = function() {
    console.log("WebSocket connection closed.");
};

function sendMessage(message) {
    socket.send(JSON.stringify({
        "message": message
    }));
}

在这个示例中，我们首先定义了一个名为 roomName 的变量，它表示 WebSocket 要连接到的房间名称。然后，我们使用 WebSocket 构造函数创建了一个 WebSocket 对象，并传递了 WebSocket 服务器的 URL。在 onopen、onmessage 和 onclose 事件处理函数中，我们分别处理连接建立、消息接收和连接关闭事件。最后，我们定义了一个名为 sendMessage 的函数，它用于发送消息到 WebSocket 服务器。

现在，我们已经完成了所有的代码编写工作。为了测试我们的实时通信功能，我们可以在终端中启动 Django 开发服务器，并使用浏览器访问我们的应用程序。下面是一个简单的命令示例：