Django Web:搭建Websocket服务器(入门篇)

简介: Django Web:搭建Websocket服务器(入门篇)

1. 概述

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

WebSocket通信过程如下:

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

WebSocket使用ws://(非加密)和wss://(加密)作为协议前缀,默认端口分别为80443

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

  1. 聊天应用:

用户可以实时发送和接收消息,无需刷新页面。

服务器可以将新消息实时推送给在线用户。

支持一对一聊天、群聊等多种聊天模式。

  1. 实时协作工具:

多个用户可以同时编辑同一文档或画板,所有变更实时同步。

用户可以看到其他用户的鼠标位置、选择内容等实时状态。

常见的实时协作工具有在线文档、在线绘图等。

  1. 在线游戏:

玩家之间可以实时交互,如移动、攻击、聊天等。

服务器可以将游戏状态实时同步给所有玩家。

支持多人在线对战、合作等游戏模式。

  1. 实时数据更新:

股票行情、汇率、商品价格等实时数据可以通过WebSocket推送给客户端。

天气预报、新闻推送等实时信息也可以使用WebSocket及时送达。

客户端无需定时轮询,可以节省带宽和服务器资源。

  1. 物联网(IoT)应用:

设备可以通过WebSocket与服务器保持长连接,实时上报数据。

服务器可以实时向设备发送控制指令,如开关灯、调节温度等。

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

2. 模块的安装和配置

2.1 安装channels库

pip install channels

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

2.2 配置ASGI应用

settings.py中添加以下配置:

INSTALLED_APPS = [
    ...
    'channels',
]

ASGI_APPLICATION = 'myproject.asgi.application'

3. asgi.py路由

3.1 创建ASGI应用文件

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),
})

3.2 配置WebSocket路由

在项目根目录下创建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消费者类处理。消费者类可以处理连接的建立、接收消息、发送消息以及连接的关闭等事件。

4. 创建WebSocket消费者

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

在应用my_app1创建一个consumers.py文件,定义WebSocket消费者:

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

class ChatConsumer(WebsocketConsumer):
    def websocket_connect(self):
        self.accept()
        self.send('消息')
        
    def websocket_receive(self, message):
        # 客户端基于websocket向后端发送数据时,自动触发接收消息
        print(message)
        self.send(text_data="收到消息: " + message)
        # self.close()

    def websocket_disconnect(self, message):
        # 客户端与服务器断开连接时,自动触发
        print("断开连接")
        raise StopConsumer()


5. 在前端使用WebSocket与服务器通信

创建WebSocket对象

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

const socket = new WebSocket('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方法:

function sendMessage(message) {
    socket.send(message);
}


在上述示例中,sendMessage函数接受一个message参数,表示要发送的消息内容。调用socket.send(message)即可将消息发送给服务器。


服务器接收到客户端发送的消息后,会在服务器端的相应消费者中触发websocket_receive方法进行处理。


连接关闭事件

当WebSocket连接被关闭时,会触发onclose事件。我们可以通过为socket.onclose属性指定一个函数来处理连接关闭的逻辑:

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


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

目录
相关文章
|
移动开发 数据挖掘 开发者
服务器发送事件(SSE)在现代Web开发中的关键作用
服务器发送事件(SSE)是HTML5标准协议,用于服务器主动向客户端推送实时数据,适合单向通信场景。相比WebSocket,SSE更简洁高效,基于HTTP协议,具备自动重连、事件驱动等特性。常见应用场景包括实时通知、新闻推送、数据分析等。通过Apipost等工具可轻松调试SSE,助力开发者构建高效实时Web应用。示例中,电商平台利用SSE实现秒杀活动通知,显著减少延迟并简化架构。掌握SSE技术,能大幅提升用户体验与开发效率。
|
开发框架 搜索推荐 数据可视化
Django框架适合开发哪种类型的Web应用程序?
Django 框架凭借其强大的功能、稳定性和可扩展性,几乎可以适应各种类型的 Web 应用程序开发需求。无论是简单的网站还是复杂的企业级系统,Django 都能提供可靠的支持,帮助开发者快速构建高质量的应用。同时,其活跃的社区和丰富的资源也为开发者在项目实施过程中提供了有力的保障。
985 157
|
机器学习/深度学习 数据处理 数据库
基于Django的深度学习视频分类Web系统
基于Django的深度学习视频分类Web系统
264 4
基于Django的深度学习视频分类Web系统
|
XML 前端开发 JavaScript
PHP与Ajax在Web开发中的交互技术。PHP作为服务器端脚本语言,处理数据和业务逻辑
本文深入探讨了PHP与Ajax在Web开发中的交互技术。PHP作为服务器端脚本语言,处理数据和业务逻辑;Ajax则通过异步请求实现页面无刷新更新。文中详细介绍了两者的工作原理、数据传输格式选择、具体实现方法及实际应用案例,如实时数据更新、表单验证与提交、动态加载内容等。同时,针对跨域问题、数据安全与性能优化提出了建议。总结指出,PHP与Ajax的结合能显著提升Web应用的效率和用户体验。
358 3
|
Java API 数据库
Django:从入门到精通
【11月更文挑战第18天】Django是一个由Python编写的高级Web应用框架,以其简洁性、安全性和高效性而闻名。Django最初由Adrian Holovaty和Simon Willison于2003年开发,旨在简化Web应用的开发过程。作为一个开放源代码项目,Django迅速吸引了大量的开发者和用户,成为了Python Web开发领域的重要工具之一。
390 1
|
API 数据库 开发者
深度剖析Django/Flask:解锁Web开发新姿势,让创意无限延伸!
在Web开发领域,Django与Flask如同两颗璀璨的星辰,各具特色。Django提供全栈解决方案,适合快速开发复杂应用;Flask则轻量灵活,适合小型项目和API开发。本文通过问答形式,深入解析两大框架的使用方法和选择策略,助你解锁Web开发新技能。
232 2
|
网络协议 前端开发 JavaScript
WebSocket 教程汇总指南,从入门到熟练
本文将带你从零开始,逐步掌握 WebSocket 的基本概念、实现方法和应用场景,通过一系列详细的教程和实践案例,帮助你从入门到熟练地使用 WebSocket 技术。无论你是初学者还是有一定经验的开发者,本文都能为你提供有价值的信息和指导。
|
机器学习/深度学习 监控 数据挖掘
基于Django和百度飞桨模型的情感识别Web系统
基于Django和百度飞桨模型的情感识别Web系统
304 5
|
NoSQL 关系型数据库 MongoDB
Django与MongoDB搭建高效的Web应用
Django与MongoDB搭建高效的Web应用
438 1
|
Java PHP
PHP作为广受青睐的服务器端脚本语言,在Web开发中占据重要地位。理解其垃圾回收机制有助于开发高效稳定的PHP应用。
【10月更文挑战第1天】PHP作为广受青睐的服务器端脚本语言,在Web开发中占据重要地位。其垃圾回收机制包括引用计数与循环垃圾回收,对提升应用性能和稳定性至关重要。本文通过具体案例分析,详细探讨PHP垃圾回收机制的工作原理,特别是如何解决循环引用问题。在PHP 8中,垃圾回收机制得到进一步优化,提高了效率和准确性。理解这些机制有助于开发高效稳定的PHP应用。
214 3