如何在Python中使用Channels为Django添加WebSocket实时通信

落静吖_6604

落静吖_6604

2026-11-01

201人浏览

原创

Baserow 使用 Django Channels 实现 WebSocket,核心是 AsyncJsonWebsocketConsumer 与 ASGI 模式;必须用 uvicorn 启动 asgi.py、显式调用 self.accept()、URLRouter 嵌套在 ProtocolTypeRouter 的 "websocket" 分支下,并配置 Nginx 的 upgrade 头。

如何在python中使用channels为django添加websocket实时通信

Channels 是 Django 官方推荐的异步扩展方案,但直接用它加 WebSocket 并不等于“把 WebSocketConsumer 一写就通”。真实项目里,90% 的失败不是因为逻辑写错,而是 ASGI 配置、路由嵌套、连接生命周期管理或前端握手细节没对齐。

ASGI 应用必须替换 WSGI,且不能共存

Django 默认走 WSGI(wsgi.py),而 Channels 要求整个服务跑在 ASGI 模式下。这意味着你必须:

  • 确认 asgi.py 文件存在且被正确引用(Django 3.0+ 自动生成,旧版本需手动创建)
  • 用 uvicorn 或 daphne 启动,例如:uvicorn myproject.asgi:application,而不是 python manage.py runserver
  • 如果用了 Nginx,反向代理目标要指向 ASGI 服务器端口(如 http://127.0.0.1:8001),而非 Django 的开发服务器
  • ALLOWED_HOSTS 必须包含 WebSocket 请求来源域名(比如前端页面是 https://example.com,则需加 "example.com",否则 403 Forbidden)

WebSocketConsumer 的 connect 方法必须显式接受连接

不像 HTTP 视图自动返回响应,WebSocket 连接建立后,服务端默认拒绝——除非你在 connect 中调用 self.accept()。漏掉这句,前端 onopen 永远不会触发,控制台只显示 WebSocket connection to 'ws://...' failed。

常见错误写法:

class ChatConsumer(WebsocketConsumer):
    def connect(self, event):
        # ❌ 错误:没调用 accept()
        pass

正确写法(带鉴权示例):

class ChatConsumer(WebsocketConsumer):
    def connect(self):
        if self.scope["user"].is_authenticated:
            self.accept()  # ✅ 必须显式调用
        else:
            self.close()
  • self.accept() 可传参指定子协议,如 self.accept("json"),前端需匹配 new WebSocket(url, ["json"])
  • 若需传递 HTTP headers 或 query string,从 self.scope["query_string"] 或 self.scope["headers"] 读取,不是 **kwargs
  • connect 方法无参数(Django 4.0+),旧版是 connect(self, **kwargs),注意版本兼容性

路由必须用 URLRouter 嵌套,不能直接挂 ProtocolTypeRouter

很多人把 WebSocket 路由写进 asgi.py 的顶层 ProtocolTypeRouter,结果 URL 匹配失效。Channels 要求 WebSocket 路由必须包裹在 URLRouter 内,并作为 http 和 websocket 协议的并列分支。

Django Wrap
Django Wrap

强戈环形山: q15040409-刻画家功能概述强戈环形山: q15040409-刻画家是一项面向实际任务的技能,主要用于平顶山: 维西翁: 1:1.0. 塔格斯: rap.github: 自动化。它将相关步骤、工具调用和结果整理方式集中到统一流程中,帮助使用者更快完成目标并减少重复操作。核心要点使用时应结合输入条件选择合适的执行方式,核对必要参数、依赖环境与输出内容,并按原始要求处理异常情况。该技能适合需要稳定复用相关能力的场景,可作为自动化工作流的一部分,也便于后续检查、调整和扩展。从功能定位来看,该

下载

错误结构(websocket 直接丢进 ProtocolTypeRouter):

ProtocolTypeRouter({
    "http": get_asgi_application(),
    "websocket": URLRouter([...]),  # ❌ 不合法,ProtocolTypeRouter 不认这个 key
})

正确结构:

from channels.routing import ProtocolTypeRouter, URLRouter
from django.urls import path
from myapp.consumers import ChatConsumer
<p>application = ProtocolTypeRouter({
"http": get_asgi_application(),
"websocket": AuthMiddlewareStack(  # ✅ 正确 key 是 websocket
URLRouter([
path("ws/chat/", ChatConsumer.as_asgi()),
])
),
})
</p>
  • AuthMiddlewareStack 必须包裹 URLRouter,否则 self.scope["user"] 为空
  • ChatConsumer.as_asgi() 是必需的类方法调用,不是 ChatConsumer() 实例化
  • 路径末尾斜杠要和前端 new WebSocket("ws://.../ws/chat/") 严格一致,少一个 / 就 404

前端 WebSocket 地址必须用 ws:// 或 wss://,且与 ASGI 服务暴露地址一致

浏览器不允许用 http:// 协议升级 WebSocket。如果后端 ASGI 服务监听 localhost:8001,前端就不能写 ws://localhost:8000/ws/chat/(那是 Django 开发服务器端口)。

  • 开发时建议前端直接连 ws://localhost:8001/ws/chat/,绕过 Nginx
  • 生产环境若用 Nginx 反代,需显式开启 WebSocket 支持:proxy_http_version 1.1; + proxy_set_header Upgrade $http_upgrade; + proxy_set_header Connection "upgrade";
  • Chrome 控制台 Network 标签页中筛选 WS,点开连接看 Headers → Request URL 是否匹配,Response → Status Code 是否为 101 Switching Protocols
  • 如果看到 Error during WebSocket handshake: net::ERR_CONNECTION_REFUSED,优先检查 ASGI 进程是否真在运行、端口是否被占用、防火墙是否放行

真正卡住人的,往往不是 Consumer 逻辑,而是 ASGI 生命周期和网络链路哪一环没对上——比如 Nginx 缺少 Connection upgrade 头,或者 asgi.py 里忘了包一层 AuthMiddlewareStack,又或者前端连了开发服务器端口却期待它处理 WebSocket。这些地方一错,连接就静默失败,连日志都不打。

Python免费学习笔记(深入):立即使用
在学习笔记中,你将探索 Python 的核心概念和高级技巧!

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

python websocket channel django

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
python打包成可执行文件
python打包成可执行文件

本专题为大家带来python打包成可执行文件相关的文章,大家可以免费的下载体验。

2023.07.20

1851

4

python能做什么
python能做什么

python能做的有:可用于开发基于控制台的应用程序、多媒体部分开发、用于开发基于Web的应用程序、使用python处理数据、系统编程等等。本专题为大家提供python相关的各种文章、以及下载和课程。

2023.07.25

4964

7

format在python中的用法
format在python中的用法

Python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.07.31

1789

3

python教程
python教程

Python已成为一门网红语言,即使是在非编程开发者当中,也掀起了一股学习的热潮。本专题为大家带来python教程的相关文章,大家可以免费体验学习。

2023.08.03

29777

23

python环境变量的配置
python环境变量的配置

Python是一种流行的编程语言,被广泛用于软件开发、数据分析和科学计算等领域。在安装Python之后,我们需要配置环境变量,以便在任何位置都能够访问Python的可执行文件。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

3547

5

python eval
python eval

eval函数是Python中一个非常强大的函数,它可以将字符串作为Python代码进行执行,实现动态编程的效果。然而,由于其潜在的安全风险和性能问题,需要谨慎使用。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

3567

5

scratch和python区别
scratch和python区别

scratch和python的区别:1、scratch是一种专为初学者设计的图形化编程语言,python是一种文本编程语言;2、scratch使用的是基于积木的编程语法,python采用更加传统的文本编程语法等等。本专题为大家提供scratch和python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

1223

5

python合并两个列表
python合并两个列表

Python是一种强大的编程语言,具有许多方便的功能和工具。在Python中,有多种方法可以合并两个列表。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.10

616

4

python是前端还是后端
python是前端还是后端

Python属于前端也属于后端,其灵活性和丰富的生态系统使得开发人员能够在不同的领域中灵活运用。本专题为大家提供python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

2763

5

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Uvicorn官方安装与入门手册
Uvicorn官方安装与入门手册

共0课时 | 0人学习

Python uv官方项目管理指南
Python uv官方项目管理指南

共0课时 | 0人学习

Python uv官方安装与入门文档
Python uv官方安装与入门文档

共0课时 | 0人学习