Django Channels中WebSocket连接失败问题求助

1. 确认ASGI配置正确性 #

确保asgi.py正确集成Channels路由，示例配置如下：

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

os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'your_project.settings')

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

• 检查your_app.routing导入路径是否拼写正确
• 必须使用ASGI服务器启动项目，比如执行daphne your_project.asgi:application，而非默认的runserver（新版Django runserver虽支持ASGI，但daphne更适合排查问题）

2. 验证路由匹配规则 #

确保routing.py的路由与前端请求路径完全匹配：
如果前端请求ws://localhost:8000/ws/board/7/，路由需写成：

from django.urls import re_path
from . import consumers

websocket_urlpatterns = [
    re_path(r'ws/board/(?P<key>\d+)/$', consumers.BoardConsumer.as_asgi()),
]

• 正则表达式末尾必须加$，避免部分匹配导致路由不命中
• 若测试固定路由/test，路由要对应写成re_path(r'ws/test/$', consumers.BoardConsumer.as_asgi())，前端请求路径同步改为ws://localhost:8000/ws/test/

3. 检查消费者类实现 #

确保consumers.py的消费者类正确继承并实现核心方法：

from channels.generic.websocket import AsyncWebsocketConsumer
import json

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

        await self.channel_layer.group_add(
            self.room_group_name,
            self.channel_name
        )

        await self.accept()
        await self.send(text_data=json.dumps({
            'message': 'you are now connected'
        }))

    async def disconnect(self, close_code):
        await self.channel_layer.group_discard(
            self.room_group_name,
            self.channel_name
        )

• 重点确认connect方法中调用了await self.accept()，这是建立连接的必要步骤
• 若使用同步消费者，需去掉async/await，改用self.accept()

4. 验证Settings.py配置 #

确保settings中正确添加Channels相关配置：

INSTALLED_APPS = [
    # 其他应用
    'channels',
    'your_app',
]

ASGI_APPLICATION = 'your_project.asgi.application'
CHANNEL_LAYERS = {
    'default': {
        'BACKEND': 'channels.layers.InMemoryChannelLayer',
    },
}

• 确认channels已加入INSTALLED_APPS
• 开发环境优先使用InMemoryChannelLayer，排除Redis等第三方依赖干扰
• 检查是否有中间件拦截WebSocket请求，比如CSRF中间件：WebSocket无需CSRF验证，若前端错误携带CSRF Token需移除相关代码

5. 前端代码检查 #

确认WebSocket初始化路径正确，动态变量渲染无误：

document.addEventListener('DOMContentLoaded', function() {
    const key = "{{ key }}"; // 确保模板变量正确渲染
    const wsProtocol = window.location.protocol === 'https:' ? 'wss:' : 'ws:';
    const wsUrl = `${wsProtocol}//${window.location.host}/ws/board/${key}/`;
    const socket = new WebSocket(wsUrl);

    socket.onopen = function(e) {
        console.log('you are now connected');
    };

    socket.onerror = function(e) {
        console.error('WebSocket error:', e);
    };
});

• 查看页面源码，确认渲染后的wsUrl与预期一致
• 打开浏览器开发者工具Network标签，查看WebSocket请求的具体错误状态（如404、500）及响应内容

6. 服务器运行状态确认 #

• 关闭所有旧的Django进程，避免端口占用
• 用daphne启动服务器后，查看控制台日志，排查是否有路由匹配失败、消费者初始化错误等信息

内容的提问来源于stack exchange，提问作者God-status