当前位置： 首页 > news >正文

Django系列之Channels

news 2025/6/29 2:57:32

1. Channels 介绍

Django 中的 HTTP 请求是建立在请求和响应的简单概念之上的。浏览器发出请求，Django服务调用相应的视图函数，并返回响应内容给浏览器渲染。但是没有办法做到 服务器主动推送消息给浏览器。

因此，WebSocket 就应运而生了。WebSocket 是一种基于 HTTP 基础上进行全双工通讯的协议。WebSocket允许服务端主动向客户端推送数据。在WebSocket协议中，浏览器和服务器只需要完成一次握手就可以创建持久性的连接，并在浏览器和服务器之间进行双向的数据传输。

Django Channels 实现了 WebSocket 能力。Channels 允许 Django 以非常类似于传统 HTTP 的方式支持WebSockets。Channels 也允许在运行 Django 的服务器上运行后台任务，HTTP 请求表现以前一样，但也支持通过 Channels 进行路由。

Django channels安装：pip install channels

2. channels 单人聊天

配置文件 settings.py:

INSTALLED_APPS = [...'app01.apps.App01Config','channels'
]
ASGI_APPLICATION = 'djangoProject.asgi.application'

主路由文件 urls.py:

from app01 import views as vw1urlpatterns = [path('admin/', admin.site.urls),path("chatone", vw1.chat)
]

主业务视图文件 app01/views.py:

from django.shortcuts import renderdef chat(request):return render(request, "chatting.html")

主业务html文件 chatting.html:

<!DOCTYPE html>
<html lang="en">
<head><meta charset="UTF-8"><title>Title</title><style>.message {height: 300px;border: 1px solid #dddddd;width: 100%;}</style>
</head>
<body><div class="message" id="message"></div><div><input type="text" placeholder="请输入聊天内容：" id="txt"><input type="button" value="点击发送" onclick="sendMessage()"><input type="button" value="关闭连接" onclick="closeConn()"></div><script>// 实例化websocket对象，并客户端主动以websocket方式连接服务端wbsocket = new WebSocket("ws://127.0.0.1:8080/room/123/");// 创建好websocket连接成功后自动触发（服务端执行self.accept()后）wbsocket.onopen = function (event) {var tag = document.createElement("div");tag.innerText = '[连接成功！]';document.getElementById("message").appendChild(tag);};// 创建连接失败后自动触发wbsocket.onerror = function (event) {var tag = document.createElement("div");tag.innerText = '[连接失败！]';document.getElementById("message").appendChild(tag);};// 当websocket接收到服务器发来的消息时会自动触发wbsocket.onmessage = function (event) {var tag = document.createElement("div");tag.innerText = event.data;document.getElementById("message").appendChild(tag);};// 当服务端主动断开客户端时自动触发（服务端执行self.close()后）wbsocket.onclose = function (event) {var tag = document.createElement("div");tag.innerText = '[连接已断开！]';document.getElementById("message").appendChild(tag);};// 页面上客户端点击向服务端"关闭连接"时触发function closeConn() {wbsocket.close();       // 客户端主动断开连接，服务端会执行 websocket_disconnect()var tag = document.createElement("div");tag.innerText = '[连接已断开啦！]';document.getElementById("message").appendChild(tag);}// 页面上客户端点击向服务端"发送消息"时触发function sendMessage() {var info = document.getElementById("txt");wbsocket.send(info.value);   // 客户端给服务端发数据}</script></body>
</html>

websocket路由文件 routings.py:

from django.urls import re_path
from app01 import consumers as consm1websocket_urlpatterns = [re_path(r'room/', consm1.ChatConsumer.as_asgi())
]

处理websocket业务文件 app01/consumers.py:

from channels.exceptions import StopConsumer
from channels.generic.websocket import WebsocketConsumerclass ChatConsumer(WebsocketConsumer):def websocket_connect(self, message):"""客户端向服务端发送websocket连接的请求时自动触发。"""print("1 > 客户端和服务端开始建立连接")self.accept()def websocket_receive(self, message):"""客户端基于websocket向服务端发送数据时，自动触发接收消息。"""print(f"2 > 服务端接收客户端的消息, message is {message}")recv_data = message["text"]if recv_data == "exit":     # 服务端主动关闭websocket连接时，前端会执行对应的 oncloseself.close()# raise StopConsumer()    # raise主动抛异常后，websocket_disconnect 就不在执行了，多用于`只处理服务端向客户端断开`的场景returnsend_data = f"服务端主动推送消息：{recv_data}"self.send(text_data=send_data)def websocket_disconnect(self, message):"""客户端与服务端断开websocket连接时自动触发(不管是客户端向服务端断开还是服务端向客户端断开都会执行)"""print("3 > 客户端和服务端断开连接")self.close()raise StopConsumer()

3. channel_layer 群组聊天

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

channel_layer 是一种通信系统。它允许多个消费者实例相互交谈，借助 channel_layer 可以很方便的实现群聊功能，我们无需手动管理 websocket 连接。channel 官方推荐的是配置channel_redis，它是一个使用Redis作为传输的Django维护层。安装：pip install channels_redis。

channel_layer 属于纯粹的异步接口，如果想要改成同步代码调用，需要使用async_to_sync做转换：
from asgiref.sync import async_to_sync。

配置文件 settings.py:

ASGI_APPLICATION = 'djangoProject.asgi.application'# 开发环境使用
CHANNEL_LAYERS = {"default": {"BACKEND": "channels.layers.InMemoryChannelLayer"}
}# 真实生产环境上使用
CHANNEL_LAYERS = {"default": {"BACKEND": "channels_redis.core.RedisChannelLayer","CONFIG": {"hosts": ["redis://127.0.0.1:6379/1", ],        # 无密码连接redis# "hosts": ["redis://:password@127.0.0.1:6379/1", ],      # 有密码连接redis# "symmetric_encryption_keys": [SECRET_KEY]}}
}

主路由文件 urls.py：

from django.contrib import admin
from django.urls import path
from app01 import views as vw1
from app02 import views as vw2urlpatterns = [path('admin/', admin.site.urls),path("chatone", vw1.chat),path("chatgroup", vw2.groupchat)	# 群聊
]

主业务视图 app02/views.py：

from django.shortcuts import renderdef groupchat(request):groupid = request.GET.get("groupID")	# 获取群组IDreturn render(request, "groupchatting.html", {"group_num": groupid})

主业务html文件 chatting.html: js在实例化websocket对象时需要改动。

<!DOCTYPE html>
<html lang="en">
<head><meta charset="UTF-8"><title>Title</title><style>.message {height: 300px;border: 1px solid #dddddd;width: 100%;}</style>
</head>
<body><div> 群组内聊天[ 群ID: {{ group_num }} ] </div><div class="message" id="message"></div><div><input type="text" placeholder="请输入群聊内容：" id="txt"><input type="button" value="点击发送" onclick="sendMessage()"><input type="button" value="关闭连接" onclick="closeConn()"></div><script>// 实例化websocket对象，并客户端主动以websocket方式连接服务端wbsocket = new WebSocket("ws://127.0.0.1:8080/group/{{ group_num }}/");// 创建好websocket连接成功后自动触发（服务端执行self.accept()后）wbsocket.onopen = function (event) {var tag = document.createElement("div");tag.innerText = '[连接成功！]';document.getElementById("message").appendChild(tag);};// 创建连接失败后自动触发wbsocket.onerror = function (event) {var tag = document.createElement("div");tag.innerText = '[连接失败！]';document.getElementById("message").appendChild(tag);};// 当websocket接收到服务器发来的消息时会自动触发wbsocket.onmessage = function (event) {var tag = document.createElement("div");tag.innerText = event.data;document.getElementById("message").appendChild(tag);};// 页面上客户端点击向服务端"关闭连接"时触发function closeConn() {wbsocket.close();       // 客户端主动断开连接，服务端会执行 websocket_disconnect()var tag = document.createElement("div");tag.innerText = '[连接已断开！]';document.getElementById("message").appendChild(tag);}// 页面上客户端点击向服务端"发送消息"时触发function sendMessage() {var info = document.getElementById("txt");wbsocket.send(info.value);   // 客户端给服务端发数据}</script></body>
</html>

websocket 路由文件 routings.py：

from django.urls import re_path
from app01 import consumers as consm1
from app02 import consumers as consm2websocket_urlpatterns = [re_path(r'room/', consm1.ChatConsumer.as_asgi()),re_path(r"group/(?P<groupID>\w+)/$", consm2.GroupChatConsumer.as_asgi())	# 群聊
]

websocket 群聊业务文件 consumers.py：
注意：从路由url中获取参数时，要使用 self.scope["url_route"]["kwargs"].get("groupID")，这里的 groupID 必须和routings中的路由分组名 re_path(r"group/(?P<groupID>\w+)/$" 保持一致！！！

from asgiref.sync import async_to_sync
from channels.exceptions import StopConsumer
from channels.generic.websocket import WebsocketConsumerclass GroupChatConsumer(WebsocketConsumer):group_id = Nonedef websocket_connect(self, message):# 接受客户端连接self.accept()print(">>> 客户端和服务端已成功建立连接 <<<")# 从url获取群组id，这个groupID必须和routings里的路由分组名保持一致self.group_id = self.scope["url_route"]["kwargs"].get("groupID")# 将当前的连接加入到名为self.group_id的组中async_to_sync(self.channel_layer.group_add)(self.group_id, self.channel_name)def websocket_receive(self, message):print(f"current self is {self}, id is {id(self)}, groupID is {self.group_id}")# 组内所有的客户端，执行type对应的函数，可以在此函数中自定义任意功能async_to_sync(self.channel_layer.group_send)(self.group_id, {"type": "send_msg", "message": message})def send_msg(self, event):input_msg = event["message"].get("text")send_msg = f"组内主动推送消息：{input_msg}"self.send(text_data=send_msg)def websocket_disconnect(self, message):# self.channel_name从组self.group_id中删除并断开连接async_to_sync(self.channel_layer.group_discard)(self.group_id, self.channel_name)print(">>> 客户端和服务端已断开连接 <<<")raise StopConsumer()
http://www.lryc.cn/news/107554.html

相关文章：

  • HTTP——五、与HTTP协作的Web服务器
  • pyspark笔记 Timestamp 类型的比较
  • SpringBoot 集成 Redis
  • 黑客学习笔记（网络安全）
  • [openCV]基于拟合中线的智能车巡线方案V1
  • MyBatis-Plus 和达梦数据库实现高效数据持久化
  • 已注销【888】
  • Ceph错误汇总
  • DataTable过滤某些数据
  • JAVASE---继承和多态
  • Centos7升级gcc、g++版本（转载）
  • 第一章：继承
  • git面试题
  • Github Copilot在JetBrains软件中登录Github失败的解决方案
  • 使用 github 同步谷歌浏览器书签
  • Eclipse进行debug
  • 13-5_Qt 5.9 C++开发指南_基于信号量的线程同步_Semaphore
  • golang使用泛型实现mapreduce操作
  • 2023华数杯数学建模C题思路分析 - 母亲身心健康对婴儿成长的影响
  • 【汇总】解决Ajax请求后端接口，返回ModelAndView页面不跳转
  • 网络安全进阶学习第九课——SQL注入介绍
  • 一个计算机专业的学生数据结构这门课学到什么程度才能算学的还不错？
  • [语义分割] ASPP不同版本对比（DeepLab、DeepLab v1、DeepLab v2、DeepLab v3、DeepLab v3+、LR-ASPP）
  • anaconda创建虚拟环境在D盘
  • Java设计模式之工厂设计模式
  • uniapp使用阿里图标
  • 20230803激活手机realme GT Neo3
  • Spring Cloud Feign+Ribbon的超时机制
  • 使用docker 搭建nginx + tomcat 集群
  • 从Spring的角度看Memcached和Redis及操作