ASGI Proc 文件与 Heroku 上的 WebSocket

概述

WebSocket 是一种基于 TCP 协议实现的双向通信标准，它允许客户端和服务器之间建立持久连接，实现实时数据传输和通信。在交互性强的网络应用程序中，WebSocket 的应用越来越广泛。Heroku 作为一种云计算平台，为应用程序提供了 WebSocket 支持。

ASGI 是一个用于异步处理请求和响应的 Python Web 服务器和应用程序接口的规范，与 WSGI 相比，ASGI 具有更好的异步处理和高并发处理能力，因此在 WebSocket 应用程序中得到了广泛的应用。

ASGI Proc 文件是在 Heroku 上运行 WebSocket 应用程序所必需的文件，只有在正确的配置下，WebSocket 应用程序才能完成连接并进行通信。

ASGI Proc 文件

ASGI Proc 文件是在 Heroku 上运行 WebSocket 应用程序所必需的文件，该文件的结构如下：

web: daphne myproject.asgi:application --port $PORT --bind 0.0.0.0 -v2

其中，myproject.asgi 是 WebSocket 应用程序所在的模块和 ASGI 应用程序的接口，-v2 表示在应用程序中输出日志信息。

WebSocket 应用程序

WebSocket 应用程序是基于 ASGI 规范的 Python 应用程序，它使用 daphne 或 uvicorn 等 ASGI 服务器运行，并通过 channels 应用程序框架实现 WebSocket 的连接和通信。

WebSocket 应用程序的实现过程非常相似，它们都需要一个名为 application 的函数来实现与服务器的通信。下面是一个使用 channels 应用程序框架实现的 WebSocket 应用程序实例：

from channels.auth import AuthMiddlewareStack
from channels.routing import ProtocolTypeRouter, URLRouter
from django.core.asgi import get_asgi_application
from django.urls import re_path

from . import consumers

application = ProtocolTypeRouter({
    "http": get_asgi_application(),
    "websocket": AuthMiddlewareStack(
        URLRouter([
            re_path(r'ws/chat/(?P<room_name>\w+)/$', consumers.ChatConsumer.as_asgi()),
        ])
    ),
})

这个应用程序包含一个 ChatConsumer 类，用于处理 WebSocket 的连接和通信。当 WebSocket 连接到服务器时，ChatConsumer.as_asgi() 方法被调用，返回一个 WebSocket 连接对象，该对象在接收到来自客户端的消息时调用 ChatConsumer.receive() 方法。下面是一个 ChatConsumer 的实现示例：

import json

from asgiref.sync import async_to_sync
from channels.generic.websocket import WebsocketConsumer

class ChatConsumer(WebsocketConsumer):
    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
        async_to_sync(self.channel_layer.group_add)(
            self.room_group_name,
            self.channel_name
        )

        self.accept()

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

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

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

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

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

部署到 Heroku

部署 WebSocket 应用程序到 Heroku 平台需要经过以下步骤：

1. 创建一个 Heroku 应用程序并绑定相关插件
2. 配置 ASGI Proc 文件
3. 将应用程序部署到 Heroku 上

下面是一个部署到 Heroku 平台的 WebSocket 应用程序的示例项目：https://github.com/PrettyPrinted/heroku-django-channels

参考

• ASGI Procfile
• Channels
• Django WebSocket Examples with Django Channels
• Heroku Architecture