Django Web：搭建Websocket服务器（入门篇）

Django Web架构搭建Websocket服务器（1）

-
文章信息 -
Author: 李俊才 (jcLee95)
Visit me at CSDN: https://jclee95.blog.csdn.net
My WebSite：http://thispage.tech/
Email: 291148484@163.com.
Shenzhen China
Address of this article:https://blog.csdn.net/qq_28550263/article/details/139129624
HuaWei:https://bbs.huaweicloud.com/blogs/427830

【介绍】：本文介绍在Django中搭建Websocket服务器的最基本知识。

下一节：《 搭建Websocket服务器（进阶篇） 》

目 录

WebSocket是一种在单个TCP连接上进行全双工通信的协议。它最初由HTML5规范提出，旨在解决传统HTTP协议在实时通信方面的不足。与HTTP****不同，WebSocket在建立连接后可以保持长连接状态，允许服务器主动向客户端发送数据,而不需要客户端发起请求。

WebSocket通信过程如下:

1. 客户端发起一个HTTP请求，请求头中包含Upgrade: websocket，表示希望将连接升级为WebSocket连接。
2. 服务器响应请求,返回状态码101 Switching Protocols，表示同意升级协议。
3. 连接升级完成后，客户端和服务器就可以通过这个连接进行全双工通信。
4. 在通信过程中，客户端和服务器可以随时向对方发送数据,不受请求-响应模式的限制。
5. 当一方关闭连接时，WebSocket连接就会被终止。

WebSocket使用

ws://

（非加密）和

wss://

（加密）作为协议前缀,默认端口分别为

80

和

443

。

WebSocket特别适合需要实时交互、频繁通信的应用场景，例如：

1. 聊天应用：

用户可以实时发送和接收消息,无需刷新页面。
服务器可以将新消息实时推送给在线用户。
支持一对一聊天、群聊等多种聊天模式。

1. 实时协作工具：

多个用户可以同时编辑同一文档或画板,所有变更实时同步。
用户可以看到其他用户的鼠标位置、选择内容等实时状态。
常见的实时协作工具有在线文档、在线绘图等。

1. 在线游戏：

玩家之间可以实时交互,如移动、攻击、聊天等。
服务器可以将游戏状态实时同步给所有玩家。
支持多人在线对战、合作等游戏模式。

1. 实时数据更新：

股票行情、汇率、商品价格等实时数据可以通过WebSocket推送给客户端。
天气预报、新闻推送等实时信息也可以使用WebSocket及时送达。
客户端无需定时轮询，可以节省带宽和服务器资源。

1. 物联网（IoT）应用：

设备可以通过WebSocket与服务器保持长连接,实时上报数据。
服务器可以实时向设备发送控制指令，如开关灯、调节温度等。

WebSocket可以提供低延迟、高效的设备通信方式。

pip install channels

Channels是一个基于Django的库，用于处理WebSocket等协议。

在

settings.py

中添加以下配置：

INSTALLED_APPS =[...'channels',]

ASGI_APPLICATION ='myproject.asgi.application'

ASGI（Asynchronous Server Gateway Interface）用于作为服务器网关接口，它是Django Channels的一部分,用于处理异步请求，包括WebSocket请求。
在项目根目录下创建

asgi.py

文件:

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

from.import rontings

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

application = ProtocolTypeRouter({# 这里处理http路由"http": get_asgi_application(),# 这里处理WebSocket路由# rontings.py的websocket_urlpatterns"websocket": URLRouter(rontings.websocket_urlpatterns),})

在项目根目录下创建

routing.py

文件：

from django.urls import re_path
from my_app1 import consumers

websocket_urlpatterns =[
    re_path(r'ws/?p<group>\wt/$', consumers.ChatConsumer.as_asgi()),]

这里定义的 websocket_urlpatterns 就类似于实现 HTTP 服务器时定义的 urlpatterns ，是对应于WebSocket服务的路由规则。

正则表达式

r'ws/?p<group>\wt/$'

用于匹配WebSocket的URL。它匹配以

ws/

开头，后面跟着一个捕获组

group

，最后以

/

结尾的URL。捕获组

group

可以捕获URL中的一部分，并将其作为参数传递给消费者类。

消费者类

consumers.ChatConsumer

（下一个小节会介绍）是我们定义的处理WebSocket连接和消息的类。通过调用

as_asgi()

方法,我们将消费者类转换为ASGI应用，以便在路由中使用。

当一个WebSocket请求的URL匹配这个路由规则时，Django Channels会将请求交给

consumers.ChatConsumer

消费者类处理。消费者类可以处理连接的建立、接收消息、发送消息以及连接的关闭等事件。

WebSocket中的消费者，就类似于HTTP服务的View

在应用

my_app1

创建一个

consumers.py

文件，定义WebSocket消费者：

from channels.generic.websocket import WebsocketConsumer
from channels.exceptions import StopConsumer

classChatConsumer(WebsocketConsumer):defwebsocket_connect(self):
        self.accept()
        self.send('消息')defwebsocket_receive(self, message):# 客户端基于websocket向后端发送数据时，自动触发接收消息print(message)
        self.send(text_data="收到消息: "+ message)# self.close()defwebsocket_disconnect(self, message):# 客户端与服务器断开连接时，自动触发print("断开连接")raise StopConsumer()

创建WebSocket对象

在前端中，通过JavaScript WebSocket API与服务器建立WebSocket连接，需要先创建一个 WebSocket 对象：

const socket =newWebSocket('ws://localhost:8000/ws/chat/');

在上述示例中，

ws://localhost:8000/ws/chat/

是服务器的WebSocket地址。

ws://

表示使用WebSocket协议，

localhost:8000

是服务器的主机和端口，

/ws/chat/

是WebSocket的路径。

需要注意的是，WebSocket地址必须以

ws://

(非加密)或

wss://

(加密)开头，而不是

http://

或

https://

。并且需要再次强调，WebSocket 是一个独立的基于 TCP 的协议，本身并不是HTTP。它仅仅是初次握手时使用HTTP，一旦协议升级完成就没什么关系了。

连接建立事件

创建WebSocket对象后,当与服务器的连接成功建立时,会触发

onopen

事件。我们可以通过为

socket.onopen

属性指定一个函数来处理连接建立的逻辑:

socket.onopen=function(event){
    console.log('WebSocket连接已建立');// 连接建立后的其他逻辑};

接收消息事件

当服务器向客户端发送消息时,会触发

onmessage

事件。我们可以通过为

socket.onmessage

属性指定一个函数来处理接收到的消息：

socket.onmessage=function(event){
    console.log('收到服务器消息:', event.data);// 处理接收到的消息};

在

onmessage

事件处理函数中,我们可以通过

event.data

获取服务器发送的消息数据,并根据需要进行处理,如更新页面内容、触发特定操作等。

发送消息

要向服务器发送消息，可以使用WebSocket对象的

send

方法：

functionsendMessage(message){
    socket.send(message);}

在上述示例中,

sendMessage

函数接受一个

message

参数,表示要发送的消息内容。调用

socket.send(message)

即可将消息发送给服务器。

服务器接收到客户端发送的消息后,会在服务器端的相应消费者中触发

websocket_receive

方法进行处理。

连接关闭事件

当WebSocket连接被关闭时,会触发

onclose

事件。我们可以通过为

socket.onclose

属性指定一个函数来处理连接关闭的逻辑:

socket.onclose=function(event){
    console.log('WebSocket连接已关闭');// 连接关闭后的其他逻辑};

在

onclose

事件处理函数中,我们可以执行一些清理操作,如更新连接状态、重新连接等。