百度360必应搜狗淘宝本站头条
当前位置:网站首页 > 技术文章 > 正文

Django实战21:Channels实现WebSocket

ccwgpt 2024-10-27 08:48 128 浏览 0 评论

在Django中实现WebSocket通信常见的两种方法分别一种是通过dwebsocket和Channels,dwebsocket模块基于django-websocket开发(dwebsocket使用可以参考文章:Django实战018:dwebsocket成功实现WebSocket),但是由于django-websocket已经停止开发所以dwebsocket的更新也基本停滞了。Channels为提升Django的 ASGI 能力开发的插件,可以同时处理 HTTP、HTTP2、WebSocket 协议。channels在保留了原生django的同步和易用的特性上还带来了异步处理方式,并且将django自带的认证系统以及session集成到模块中,扩展性非常强(官方推荐的插件)。

安装Channels

Python安装模块很简单,直接用pip来在线安装:pip install -U channels。channels安装需要下载很多依赖包,这些包用官方源容易下载超时(建议换源再装,pip换源可以参考文章:Django实战012:PIP配置国内镜像源及使用)。这里-U指--upgrade,如果已安装就升级到最新版。

# 官方源安装很多依赖包下载的容易超时,建议换源再安装
pip install -U channels
# 也可以临时指定安装源,-U指--upgrade,如果已安装就升级到最新版
python -m pip install -U channels -i  https://pypi.tuna.tsinghua.edu.cn/simple/
------------------------------------------
Successfully installed Automat-20.2.0 PyHamcrest-2.0.2 attrs-20.3.0 
autobahn-20.12.3 cffi-1.14.4 channels-3.0.3 constantly-15.1.0 cryptography-3.3.1 
daphne-3.0.1 hyperlink-21.0.0 idna-3.1 incremental-17.5.0 pyasn1-0.4.8 
pyasn1-modules-0.2.8 pycparser-2.20 pyopenssl-20.0.1 service-identity-18.1.0 
twisted-20.3.0 txaio-20.12.1 zope.interface-5.2.0

集成Channels框架

Django2.x 不支持ASGI,所以实现WebSocket需要集成Channels框架(貌似Django3.x无依赖就支持WebSocket)。我们需要创建consumers.py和routing.py文件,routing.py相当于Django中的url用来映射路由和执行函数之间的关系。当监听到websocket的请求时,Django会根据routing.py来触发相应的执行函数。consumers.py则相当于Django中的views视图,在这里定义执行函数及相应的业务逻辑处理。在 wsgi.py 同级目录新增文件 asgi.py(如果你安装了channels在创建项目会自动生成该文件,但是还是需要修改),将Django运行切换到ASGI而不是WSGI服务。

import os, django
from channels.routing import get_default_application
os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'channel_server.settings')
django.setup()
application = get_default_application()

配置Channels

要在Django项目中使用Channels就需要将Channels库添加到已安装的应用程序列表中,编辑 settings.py 件将channels添加到INSTALLED_APPS设置中。Channels走的是通道模式,所以我们需要设置Django以“通道模式”运行。通过ASGI_APPLICATION 来指定Django开启通道。如果有多个通道的话可以使用Redis作为我们的通道层,这时候就需要安装asgi_redis配合了(需安装redis)。

INSTALLED_APPS = [
    'django.contrib.admin',
    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    'django.contrib.messages',
    'django.contrib.staticfiles',
    'corsheaders',  # 跨域处理
    'channels',     # 注册Channels
]
# 启用 ASGI
ASGI_APPLICATION = "channel_server.routing.application"

定义routing.py

在项目settings文件同级目录中新增routing.py,利用Channels的routring模块中的方法来实现路由分发。如果你需要认证可以添加中间件AuthMiddlewareStack或者SessionMiddlewareStack,不需要则直接在URLRouter中定义路由指向。

from channels.auth import AuthMiddlewareStack
from channels.sessions import SessionMiddlewareStack
from channels.routing import ProtocolTypeRouter,URLRouter
from django.urls import path, re_path
from channel_server.consumers import consumers
application = ProtocolTypeRouter({
    'websocket':AuthMiddlewareStack(       # 'websocket':SessionMiddlewareStack(
        URLRouter ([
            # Empty for now (http->django views is added by default)
            # path('ws/parameter/<str:room_name>/', consumers),
            path('ncdev/',test()),
        ])
    )
})

定义consumers.py

这个是核心的功能模块,需要单独拿出来说明。这里我们就简单的测试下整个项目是否可以正常地运行和被访问,这里我们定义一个简单的test类来测试下Channels。当链接进来的时候我们打印“链接上了,当我们接收到客户端消息的时候打印“已发送数据”,当客户端断开链接的时候我们打印“链接断开啦”。

class test(WebsocketConsumer):
    # 当Websocket创建连接时
    def connect(self):
        self.accept()  # 保持连接!必须写这步
        print('连接上啦')
    # 当Websocket接收到消息时
    def receive(self, text_data=None, bytes_data=None):
        self.send(text_data)
        print('已发送数据')
    # 当Websocket发生断开连接时
    def disconnect(self, code):
        print('断开连接啦')

运行项目

当前项目运行环境为:python3.7.9 +Django2.2+Channels3.0.3,项目运行直接通过命令:python manage runserver来启动。然后通过Vue前端向Django发送一个websocket请求,我们可以看到后台已经打印了字符符:webscoket request!!!(说明请求已经进来了)。

Channels测试

这里我们用个WebScoket客户端测试工具来测试下请求结果,分别点击链接、发送数据、断开来测试刚才的几个接口是否能正常响应。在右侧我们可以看到服务端给我们返回了我们发送的数据,说明我们的WebScoket链接已经成功建立并可以发送数据。

以上内容是小编给大家分享的【Django实战021:Channels实现WebSocket】。希望对大家有所帮助,如果大家有任何疑问请给我留言,小编会及时回复大家的。

相关推荐

RACI矩阵:项目管理中的角色与责任分配利器

作者:赵小燕RACI矩阵RACI矩阵是项目管理中的一种重要工具,旨在明确团队在各个任务中的角色和职责。通过将每个角色划分为负责人、最终责任人、咨询人和知情人四种类型,RACI矩阵确保每个人都清楚自己...

在弱矩阵组织中,如何做好项目管理工作?「慕哲制图」

慕哲出品必属精品系列在弱矩阵组织中,如何做好项目管理工作?【慕哲制图】-------------------------------慕哲制图系列0:一图掌握项目、项目集、项目组合、P2、商业分析和NP...

Scrum模式:每日站会(Daily Scrum)

定义每日站会(DailyScrum)是一个Scrum团队在进行Sprint期间的日常会议。这个会议的主要目的是为了应对Sprint计划中的不断变化,确保团队能够有效应对挑战并达成Sprint目标。为...

大家都在谈论的敏捷开发&amp;Scrum,到底是什么?

敏捷开发作为一种开发模式,近年来深受研发团队欢迎,与瀑布式开发相比,敏捷开发更轻量,灵活性更高,在当下多变环境下,越来越多团队选择敏捷开发。什么是敏捷?敏捷是一种在不确定和变化的环境中,通过创造和响应...

敏捷与Scrum是什么?(scrum敏捷开发是什么)

敏捷是一种思维模式和哲学,它描述了敏捷宣言中的一系列原则。另一方面,Scrum是一个框架,规定了实现这种思维方式的角色,事件,工件和规则/指南。换句话说,敏捷是思维方式,Scrum是规定实施敏捷哲学的...

敏捷项目管理与敏捷:Scrum流程图一览

敏捷开发中的Scrum流程通常可以用一个简单的流程图来表示,以便更清晰地展示Scrum框架的各个阶段和活动。以下是一个常见的Scrum流程图示例:这个流程图涵盖了Scrum框架的主要阶段和活动,其中包...

一张图掌握项目生命周期模型及Scrum框架

Mockito 的最佳实践(mock方法)

记得以前面试的时候,面试官问我,平常开发过程中自己会不会测试?我回答当然会呀,自己写的代码怎么不测呢。现在想想我好像误会他的意思了,他应该是想问我关于单元测试,集成测试以及背后相关的知识,然而当时说到...

EffectiveJava-5-枚举和注解(java枚举的作用与好处)

用enum代替int常量1.int枚举:引入枚举前,一般是声明一组具名的int常量,每个常量代表一个类型成员,这种方法叫做int枚举模式。int枚举模式是类型不安全的,例如下面两组常量:性别和动物种...

Maven 干货 全篇共:28232 字。预计阅读时间:110 分钟。建议收藏!

Maven简介Maven这个词可以翻译为“知识的积累”,也可以翻译为“专家”或“内行”。Maven是一个跨平台的项目管理工具。主要服务于基于Java平台的项目构建、依赖管理和项目信息管理。仔...

Java单元测试框架PowerMock学习(java单元测试是什么意思)

前言高德的技术大佬在谈论方法论时说到:“复杂的问题要简单化,简单的问题要深入化。”这句话让我感触颇深,这何尝不是一套编写代码的方法——把一个复杂逻辑拆分为许多简单逻辑,然后把每一个简单逻辑进行深入实现...

Spring框架基础知识-第六节内容(Spring高级话题)

Spring高级话题SpringAware基本概念Spring的依赖注入的最大亮点是你所有的Bean对Spring容器的存在是没有意识的。但是在实际的项目中,你的Bean必须要意识到Spring容器...

Java单元测试浅析(JUnit+Mockito)

作者:京东物流秦彪1.什么是单元测试(1)单元测试环节:测试过程按照阶段划分分为:单元测试、集成测试、系统测试、验收测试等。相关含义如下:1)单元测试:针对计算机程序模块进行输出正确性检验工作...

揭秘Java代码背后的质检双侠:JUnit与Mockito!

你有没有发现,现在我们用的手机App、逛的网站,甚至各种智能设备,功能越来越复杂,但用起来却越来越顺畅,很少遇到那种崩溃、卡顿的闹心事儿?这背后可不是程序员一拍脑袋写完代码就完事儿了!他们需要一套严谨...

单元测试框架哪家强?Junit来帮忙!

大家好,在前面的文章中,给大家介绍了以注解和XML的方式分别实现IOC和依赖注入。并且我们定义了一个测试类,通过测试类来获取到了容器中的Bean,具体的测试类定义如下:@Testpublicvoid...

取消回复欢迎 发表评论: