详解Django3中直接添加Websockets方式

作者:mindg.cn 时间:2021-01-05 01:43:22 

现在Django 3.0附带了对ASGI的支持,将Websockets添加到Django应用中不需要任何额外的依赖关系。 在本文中,您将学习如何通过扩展默认的ASGI应用程序来使用Django处理Websocket。 我们将介绍如何在示例ASGI应用程序中处理Websocket连接,发送和接收数据以及实现业务逻辑。

入门

首先,您需要在计算机上安装Python> = 3.6。 Django 3.0仅与Python 3.6及更高版本兼容,因为它使用了async和await关键字。 完成Python版本设置后,创建一个项目目录并CD进入。 然后,将Django安装在virtualenv内,并在您的项目目录中创建一个新的Django应用:


$ mkdir django_websockets && cd django_websockets
$ python -m venv venv
$ source venv/bin/activate
$ pip install django
$ django-admin startproject websocket_app .

看一下Django应用程序的websocket_app目录。 您应该看到一个名为asgi.py的文件。 其内容如下所示:


import os

from django.core.asgi import get_asgi_application

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

application = get_asgi_application()

该文件提供了默认的Django ASGI设置,并公开了一个名为application的ASGI应用程序,可以使用uvicorn或daphne等ASGI服务器运行该应用程序。 在进一步介绍之前,让我们看一下ASGI应用程序的结构。

ASGI应用程序结构

ASGI或“异步服务器网关接口”是用于使用Python构建异步Web服务的规范。它是WSGI的精神继承者,WSGI已被Django和Flask等框架使用了很长时间。 ASGI使您可以使用Python的本机异步/等待功能来构建支持长期连接的Web服务,例如Websockets和Server Sent Events。

ASGI应用程序是一个异步函数,它带有3个参数:作用域(当前请求的上下文),接收(一个异步函数,可让您侦听传入的事件)和发送(一个异步函数,可将事件发送至客户端)。

在ASGI应用程序内部,您可以根据范围字典中的值路由请求。例如,您可以通过检查scope [‘type']的值来检查该请求是HTTP请求还是Websocket请求。要侦听来自客户端的数据,您可以等待接收功能。准备好将数据发送到客户端时,可以等待发送功能,然后将要发送给客户端的任何数据传递给客户端。让我们看一下这在示例应用程序中是如何工作的。

创建一个ASGI应用

在我们的asgi.py文件中,我们将使用我们自己的ASGI应用程序包装Django的默认ASGI应用程序功能,以便自己处理Websocket连接。为此,我们需要定义一个名为application的异步函数,该函数需要3个ASGI参数:scope,receive和send。将get_asgi_application调用的结果重命名为django_application,因为我们需要它处理HTTP请求。在我们的应用程序函数内部,我们将检查scope [‘type']的值以确定请求类型。如果请求类型为“ http”,则该请求为普通的HTTP请求,我们应该让Django处理它。如果请求类型为“ websocket”,那么我们将自己处理逻辑。生成的asgi.py文件应如下所示:


import os

from django.core.asgi import get_asgi_application

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

django_application = get_asgi_application()

async def application(scope, receive, send):
 if scope['type'] == 'http':
   # Let Django handle HTTP requests
   await django_application(scope, receive, send)
 elif scope['type'] == 'websocket':
   # We'll handle Websocket connections here
   pass
 else:
   raise NotImplementedError(f"Unknown scope type {scope['type']}")

现在,我们需要创建一个函数来处理Websocket连接。 在与asgi.py文件相同的文件夹中创建一个名为websocket.py的文件,并定义一个名为websocket_application的ASGI应用程序函数,该函数接受3个ASGI参数。 接下来,我们将在我们的asgi.py文件中导入websocket_application,并在我们的应用程序函数内部调用它来处理Websocket请求,传入范围,接收和发送参数。 它看起来应该像这样:


# asgi.py
import os

from django.core.asgi import get_asgi_application
from websocket_app.websocket import websocket_application

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

django_application = get_asgi_application()

async def application(scope, receive, send):
 if scope['type'] == 'http':
   await django_application(scope, receive, send)
 elif scope['type'] == 'websocket':
   await websocket_application(scope, receive, send)
 else:
   raise NotImplementedError(f"Unknown scope type {scope['type']}")

# websocket.py
async def websocket_application(scope, receive, send):
 pass

接下来,让我们为Websocket应用程序实现一些逻辑。我们将监听所有Websocket连接,当客户端发送字符串“ ping”时,我们将以字符串“ pong!”进行响应。

在websocket_application函数内部,我们将定义一个不确定的循环,该循环将处理Websocket请求,直到关闭连接。在该循环内,我们将等待服务器从客户端收到的任何新事件。然后,我们将根据事件的内容采取行动,并将响应发送给客户端。

首先,让我们处理连接。当新的Websocket客户端连接到服务器时,我们将收到“ websocket.connect”事件。为了允许这种连接,我们将发送一个“ websocket.accept”事件作为响应。这将完成Websocket握手并与客户端建立持久连接。

当客户端终止其与服务器的连接时,我们还需要处理断开连接事件。为此,我们将监听“ websocket.disconnect”事件。当客户端断开连接时,我们将摆脱不确定的循环。

最后,我们需要处理来自客户端的请求。为此,我们将监听“ websocket.receive”事件。当我们从客户端收到“ websocket.receive”事件时,我们将检查event [‘text']的值是否为“ ping”。如果是,我们将发送一个'websocket.send'事件,其文本值为'pong!'。

设置Websocket逻辑后,我们的websocket.py文件应如下所示:


# websocket.py
async def websocket_application(scope, receive, send):
 while True:
   event = await receive()

if event['type'] == 'websocket.connect':
     await send({
       'type': 'websocket.accept'
     })

if event['type'] == 'websocket.disconnect':
     break

if event['type'] == 'websocket.receive':
     if event['text'] == 'ping':
       await send({
         'type': 'websocket.send',
         'text': 'pong!'
       })

测试

现在,我们的ASGI应用程序已设置为处理Websocket连接,并且我们已经实现了Websocket服务器逻辑,让我们对其进行测试。 目前,Django开发服务器不使用asgi.py文件,因此您将无法使用./manage.py runserver测试连接。 相反,您需要使用ASGI服务器(例如uvicorn)运行该应用程序。 让我们安装它:


$ pip install uvicorn

安装uvicorn后,我们可以使用以下命令运行ASGI应用程序:


$ uvicorn websocket_app.asgi:application
INFO:   Started server process [25557]
INFO:   Waiting for application startup.
INFO:   ASGI 'lifespan' protocol appears unsupported.
INFO:   Application startup complete.
INFO:   Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)

要测试Websocket连接,请在新选项卡中打开浏览器的开发工具。 在控制台中,创建一个名为ws的新Websocket实例,该实例指向ws:// localhost:8000 /。 然后将onmessage处理程序附加到将event.data记录到控制台的ws。 最后,调用ws.send('ping')将消息发送到服务器。 您应该看到值“ pong!”。 登录到控制台。


> ws = new WebSocket('ws://localhost:8000/')
WebSocket {url: "ws://localhost:8000/", readyState: 0, bufferedAmount: 0, onopen: null, onerror: null, …}
> ws.onmessage = event => console.log(event.data)
event => console.log(event.data)
> ws.send("ping")
undefined
pong!

恭喜! 现在,您知道了如何使用ASGI将Websocket支持添加到Django应用程序中。 去用它来制作很棒的东西。

来源:https://www.mindg.cn/

标签:Django3,添加,Websockets
0
投稿

猜你喜欢

  • jfinal与bootstrap的登录跳转实战演习

    2023-07-02 05:20:01
  • JavaScript简单实现弹出拖拽窗口(一)

    2024-04-28 09:42:56
  • 简单谈谈MySQL5.7 JSON格式检索

    2024-01-22 09:07:03
  • Python版中国省市经纬度

    2021-05-10 20:25:12
  • python爬虫实战之最简单的网页爬虫教程

    2022-02-06 17:03:36
  • VS CODE 使用SVN插件的方法步骤

    2023-05-22 10:39:33
  • ASP分页类(支持多风格变换)

    2011-04-08 10:39:00
  • Pandas数据处理加速技巧汇总

    2023-08-12 19:02:36
  • Python中一些自然语言工具的使用的入门教程

    2023-08-31 06:17:01
  • css可以给img元素设置背景图

    2008-09-29 15:35:00
  • Python设计模式之享元模式原理与用法实例分析

    2021-08-20 20:01:57
  • python模拟登录百度贴吧(百度贴吧登录)实例

    2023-11-20 14:30:56
  • 小议sqlserver数据库主键选取策略

    2024-01-25 15:03:52
  • python3.6、opencv安装环境搭建过程(图文教程)

    2022-03-11 16:04:44
  • 带农历及节日的js日历源码

    2010-08-01 17:38:00
  • 给大家整理了19个pythonic的编程习惯(小结)

    2024-01-02 08:00:05
  • C#调用Python的URL接口的示例

    2022-08-22 21:49:27
  • Java连接Sql数据库经常用到的操作

    2024-01-17 09:26:28
  • Python简单实现安全开关文件的两种方式

    2022-09-15 01:54:38
  • ChatGPT 中文调教指南总结

    2022-12-23 03:44:10
  • asp之家 网络编程 m.aspxhome.com