先来看一下最终的效果吧

开始聊天，输入消息并点击发送消息就可以开始聊天了

点击 “获取后端数据”开启实时推送

先来简单了解一下 Django Channel

Channels是一个采用Django并将其功能扩展到HTTP以外的项目，以处理WebSocket，聊天协议，IoT协议等。它基于称为ASGI的Python规范构建。

它以Django的核心为基础，并在其下面分层了一个完全异步的层，以同步模式运行Django本身，但异步处理了连接和套接字，并提供了以两种方式编写的选择，从而实现了这一点。

　　详情请参考官方文档：https://channels.readthedocs.io/en/latest/introduction.html

再简单说下ASGI是什么东东吧

ASGI 由 Django 团队提出，为了解决在一个网络框架里（如 Django）同时处理 HTTP、HTTP2、WebSocket 协议。为此，Django 团队开发了 Django Channels 插件，为 Django 带来了 ASGI 能力。
 在 ASGI 中，将一个网络请求划分成三个处理层面，最前面的一层，interface server（协议处理服务器），负责对请求协议进行解析，并将不同的协议分发到不同的 Channel（频道）；频道属于第二层，通常可以是一个队列系统。频道绑定了第三层的 Consumer（消费者）。

　　详情请参考官方文档： https://channels.readthedocs.io/en/latest/asgi.html

下边来说一下具体的实现步骤

转载请注明原文链接： https://www.cnblogs.com/Sunzz/p/12788608.html

一、安装channel

  1. pip3 install channels
  2. pip3 install channels_redis

二、新建Django项目

1.新建项目

  1. django-admin startproject mysite

2.新建应用

  1. python3 manage.py startapp chat

3.编辑 mysite/settings.py文件

  1. #注册应用
  2. INSTALLED_APPS = [
  3.     ....
  4.     'chat.apps.ChatConfig',
  5.     "channels",
  6. ]

  7. # 在文件尾部新增如下配置
  8. #将ASGI_APPLICATION设置设置为指向该路由对象作为您的根应用程序：
  9. ASGI_APPLICATION = 'mysite.routing.application'
  10.  
  11. #配置Redis
  12. CHANNEL_LAYERS = {
  13.     'default': {
  14.         'BACKEND': 'channels_redis.core.RedisChannelLayer',
  15.         'CONFIG': {
  16.             "hosts": [('10.0.6.29', 6379)],
  17.         },
  18.     },
  19. }

三、详细代码与配置

1. 添加索引视图的模板

在chat目录中创建一个templates目录。在您刚刚创建的templates 目录中，创建另一个名为的目录 chat，并在其中创建一个名为的文件index.html以保存索引视图的模板

将以下代码放入chat/templates/chat/index.html

  1. <!-- chat/templates/chat/index.html -->
  2. <!DOCTYPE html>
  3. <html>
  4. <head>
  5.     <meta charset="utf-8"/>
  6.     <title>Chat Rooms</title>
  7. </head>
  8. <body>
  9.     What chat room would you like to enter?<br>
  10.     <input id="room-name-input" type="text" size="100"><br>
  11.     <input id="room-name-submit" type="button" value="Enter">
  12.  
  13.     <script>
  14.         document.querySelector('#room-name-input').focus();
  15.         document.querySelector('#room-name-input').onkeyup = function(e) {
  16.             if (e.keyCode === 13) {  // enter, return
  17.                 document.querySelector('#room-name-submit').click();
  18.             }
  19.         };
  20.  
  21.         document.querySelector('#room-name-submit').onclick = function(e) {
  22.             var roomName = document.querySelector('#room-name-input').value;
  23.             window.location.pathname = '/chat/' + roomName + '/';
  24.         };
  25.     </script>
  26. </body>
  27. </html>

2.创建聊天与消息推送模板

chat/templates/chat/room.html

  1. <!DOCTYPE html>
  2. <html>
  3. <head>
  4.     <script src="https://cdn.bootcdn.net/ajax/libs/jquery/3.5.0/jquery.min.js" type="text/javascript"></script>
  5.     <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/bootstrap@3.3.7/dist/css/bootstrap.min.css">
  6.     <script src="https://cdn.jsdelivr.net/npm/bootstrap@3.3.7/dist/js/bootstrap.min.js"></script>
  7.     <meta charset="utf-8"/>
  8.     <title>Chat Room</title>
  9. </head>
  10. <body>
  11. <textarea id="chat-log" cols="150" rows="30" class="text"></textarea><br>
  12. <input id="chat-message-input" type="text" size="150"><br>
  13. <input id="chat-message-submit" type="button" value="发送消息" class="input-sm">
  14. <button id="get_data" class="btn btn-success">获取后端数据</button>
  15. {{ room_name|json_script:"room-name" }}
  16.  
  17. <script>
  18.  
  19.     $("#get_data").click(function () {
  20.         $.ajax({
  21.             url: "{% url 'push' %}",
  22.             type: "GET",
  23.             data: {
  24.                 "room": "{{ room_name }}",
  25.                 "csrfmiddlewaretoken": "{{ csrf_token }}"
  26.             },
  27.         })
  28.     });
  29.  
  30.     const roomName = JSON.parse(document.getElementById('room-name').textContent);
  31.     const chatSocket = new WebSocket(
  32.         'ws://' + window.location.host
  33.         + '/ws/chat/'
  34.         + roomName + '/'
  35.     );
  36.     let chatSocketa = new WebSocket(
  37.         "ws://" + window.location.host + "/ws/push/" + roomName
  38.     );
  39.     chatSocket.onmessage = function (e) {
  40.         const data = JSON.parse(e.data);
  41.         // data 为收到后端发来的数据
  42.         //console.log(data);
  43.         document.querySelector('#chat-log').value += (data.message + '\n');
  44.     };
  45.     chatSocketa.onmessage = function (e) {
  46.         let data = JSON.parse(e.data);
  47.         //let message = data["message"];
  48.         document.querySelector("#chat-log").value += (data.message + "\n");
  49.     };
  50.  
  51.     chatSocket.onclose = function (e) {
  52.         console.error('Chat socket closed unexpectedly');
  53.     };
  54.     chatSocketa.onclose = function (e) {
  55.         console.error("Chat socket closed unexpectedly");
  56.     };
  57.     document.querySelector('#chat-message-input').focus();
  58.     document.querySelector('#chat-message-input').onkeyup = function (e) {
  59.         if (e.keyCode === 13) {  // enter, return
  60.             document.querySelector('#chat-message-submit').click();
  61.         }
  62.     };
  63.  
  64.     document.querySelector('#chat-message-submit').onclick = function (e) {
  65.         const messageInputDom = document.querySelector('#chat-message-input');
  66.         const message = messageInputDom.value;
  67.         chatSocket.send(JSON.stringify({
  68.             'message': message
  69.         }));
  70.         messageInputDom.value = '';
  71.     };
  72. </script>
  73. </body>
  74. </html>

3.创建房间的视图

将以下代码放入chat/views.py

  1. # chat/views.py
  1. from django.shortcuts import render
  2. from django.http import JsonResponse
  3. from channels.layers import get_channel_layer
  4. from asgiref.sync import async_to_sync
  5.  
  6. def index(request):
  7.     return render(request, "chat/index.html")
  8.  
  9. def room(request, room_name):
  10.     return render(request, "chat/room.html", {"room_name": room_name})
  11.  
  12. def pushRedis(request):
  13.     room = request.GET.get("room")
  14.     print(room)
  15.  
  16.     def push(msg):
  17.         channel_layer = get_channel_layer()
  18.         async_to_sync(channel_layer.group_send)(
  19.             room,
  20.             {"type": "push.message", "message": msg, "room_name": room}
  21.         )
  22.  
  23.     push("推送测试", )
  24.     return JsonResponse({"": 1})

4. 创建项目二级路由

在chat目录下创建一个名为的文件urls.py

  1. # mysite/chat/urls.py
  2. from django.urls import path
  3. from . import views
  4.  
  5. urlpatterns = [
  6.     path('', views.index, name='index'),
    　　 path('<str:room_name>/', views.room, name='room'),
  1. ]

5. 修改根路由

  1. # mysite/urls.py
  2.  
  3. from django.contrib import admin
  4. from django.urls import path, include
  5. from chat.views import pushRedis
  6.  
  7. urlpatterns = [
  8.     path('admin/', admin.site.urls),
  9.     path("chat/", include("chat.urls")),
  10.     path("push", pushRedis, name="push"),
  11. ]

6.创建一个消费者

文件chat/consumers.py

当Django接受HTTP请求时，它会查询根URLconf来查找视图函数，然后调用该视图函数来处理该请求。同样，当Channels接受WebSocket连接时，它会查询根路由配置以查找使用者，然后在使用者上调用各种功能来处理来自连接的事件。

  1. import time
  2. import json
  3. from channels.generic.websocket import WebsocketConsumer, AsyncWebsocketConsumer
  4. from asgiref.sync import async_to_sync
  5. import redis
  6.  
  7. pool = redis.ConnectionPool(
  8.     host="10.0.6.29",
  9.     port=6379,
  10.     max_connections=10,
  11.     decode_response=True,
  12. )
  13. conn = redis.Redis(connection_pool=pool, decode_responses=True)
  14.  
  15. class ChatConsumer(AsyncWebsocketConsumer):
  16.     async def connect(self, ):
  17.         self.room_name = self.scope["url_route"]["kwargs"]["room_name"]
  18.         self.room_group_name = "chat_%s" % self.room_name
  19.  
  20.         await self.channel_layer.group_add(
  21.             self.room_group_name,
  22.             self.channel_name,
  23.         )
  24.         await self.accept()
  25.  
  26.     async def disconnect(self, close_code):
  27.         print("close_code: ", close_code)
  28.         await self.channel_layer.group_discard(
  29.             self.room_group_name,
  30.             self.channel_name
  31.         )
  32.  
  33.     async def receive(self, text_data=None, bytes_data=None):
  34.         text_data_json = json.loads(text_data)
  35.         message = text_data_json["message"]
  36.         print("receive_message：", message)
  37.         await self.channel_layer.group_send(
  38.             self.room_group_name,
  39.             {
  40.                 "type": "chat_message",
  41.                 "message": message
  42.             }
  43.         )
  44.  
  45.     async def chat_message(self, event):
  46.         receive_message = event["message"]
  47.         response_message = "You message is :" + receive_message
  48.         await self.send(text_data=json.dumps({
  49.             "message": response_message
  50.         }))
  51.  
  52. class PushMessage(WebsocketConsumer):
  53.  
  54.     def connect(self):
  55.         self.room_group_name = self.scope["url_route"]["kwargs"]["room_name"]
  56.         async_to_sync(self.channel_layer.group_add)(
  57.             self.room_group_name,
  58.             self.channel_name
  59.         )
  60.         self.accept()
  61.  
  62.     def disconnect(self, code):
  63.         async_to_sync(self.channel_layer.group_discard)(
  64.             self.room_group_name,
  65.             self.channel_name
  66.         )
  67.  
  68.     def push_message(self, event):
  69.         """
  70.         主动推送
  71.         :param event:
  72.         :return:
  73.         """
  74.         print(event, type(event))
  75.         while True:
  76.             time.sleep(2)
  77.             msg = time.strftime("%Y-%m-%d %H:%M:%S") + "---  room_name: %s" % event["room_name"]
  78.             self.send(text_data=json.dumps(
  79.                 {"message": msg}
  80.             ))

7.为项目添加websocket的路由配置

在chat目录下创建一个名为的文件routing.py

  1. # mysite/chat/routing.py
  2.  
  3. from django.urls import re_path, path
  4. from . import consumers
  5.  
  6. websocket_urlpatterns = [
  7.     re_path(r"ws/chat/(?P<room_name>\w+)/$", consumers.ChatConsumer),
  8.     path("ws/push/<room_name>", consumers.PushMessage),
  9. ]

8.配置websocket根路由

与setting同级目录新建ws根路由文件 routing.py

  1. from channels.routing import ProtocolTypeRouter, URLRouter
  2. from channels.auth import AuthMiddlewareStack
  3. import chat.routing
  4.  
  5. application = ProtocolTypeRouter({
  6.     "websocket": AuthMiddlewareStack(
  7.         URLRouter(
  8.             chat.routing.websocket_urlpatterns
  9.         )
  10.     ),
  11. })

9.最终的文件关系如下图

10.启动服务

  1. python3 manage.py runserver 10.0.6.2:

注意看，这和django是不一样的

还有另一种更稳健的启动方式

和setting同级新增文件 asgi.py

  1. import os
  2. import django
  3. from channels.routing import get_default_application
  4.  
  5. os.environ.setdefault("DJANGO_SETTINGS_MODULE", "mysite.settings")
  6. django.setup()
  7. application = get_default_application()

启动方式为：

  1. daphne -b 10.0.6.2 -p  mysite.asgi:application
  1. daphne 在安装channel时已经自动安装好了

参考：

　　https://channels.readthedocs.io/en/latest/tutorial/index.html

　　https://blog.ernest.me/post/asgi-demonstration-realtime-blogging

Django Channel实时推送与聊天的更多相关文章

  1. Channels集成到Django消息实时推送

    channel架构图 InterFace Server:负责对协议进行解析,将不同的协议分发到不同的Channel Channel Layer:频道层,可以是一个FIFO队列,通常使用Redis Dj ...

  2. 【原创】node+express+socket搭建一个实时推送应用

    技术背景 Web领域的实时推送技术,也被称作Realtime技术.这种技术要达到的目的是让用户不需要刷新浏览器就可以获得实时更新. 应用场景: 监控系统:后台硬件热插拔.LED.温度.电压发生变化 即 ...

  3. 基于Node.js的实时推送 juggernaut

    基于Node.js的实时推送 juggernaut Juggernaut 基于 Node.js 构建.为浏览器和服务器端提供一个实时的连接,可在客户端和服务器端进行数据的实时推送,适合多角色游戏.聊天 ...

  4. 关于 实时推送技术--WebSocket的 知识分享

    今天学习了关于WebSocket的知识,觉得挺有用的,在这记录一下,也和大家分享一下!!有兴趣的可以看看哦 WebSocket简介 Web领域的实时推送技术,也被称作Realtime技术.这种技术要达 ...

  5. WEB 实时推送技术的总结

    前言 随着 Web 的发展,用户对于 Web 的实时推送要求也越来越高 ,比如,工业运行监控.Web 在线通讯.即时报价系统.在线游戏等,都需要将后台发生的变化主动地.实时地传送到浏览器端,而不需要用 ...

  6. 基于HTTP协议之WEB消息实时推送技术原理及实现

    很早就想写一些关于网页消息实时推送技术方面的文章,但是由于最近实在忙,没有时间去写文章.本文主要讲解基于 HTTP1.1 协议的 WEB 推送的技术原理及实现.本人曾经在工作的时候也有做过一些用到网页 ...

  7. 使用SignalR ASP.NET Core来简单实现一个后台实时推送数据给Echarts展示图表的功能

    什么是 SignalR ASP.NET Core ASP.NET Core SignalR 是一种开放源代码库,可简化将实时 web 功能添加到应用程序的功能. 实时 web 功能使服务器端代码可以立 ...

  8. SignalR实时推送

    SignalR 的实现机制与 .NET WCF 或 Remoting 是相似的,都是使用远程代理来实现.在具体使用上,有两种不同目的的接口:PersistentConnection 和 Hubs,其中 ...

  9. HTML5 WebSocket 实时推送信息测试demo

    测试一下HTML5的websocket功能,实现了客户端→服务器实时推送信息到客户端,包括推送图片: websocket实现MessageInbound类 onTextMessage()/onBina ...

随机推荐

  1. while与until

    一.格式: while  条件测试 :do 循环体 done 二.条件测试 条件测试是指满足条件则会一直执行下去. 比如: let i =0 while i < 100;do echo $i i ...

  2. 详谈XSS防御方法

      1.HttpOnly 严格的说,httponly并非为了对抗XSS,它解决的是XSS后的Cookie劫持攻击.Cookie设置了httponly之后,JavaScript读不到该cookie的值. ...

  3. JDK12不包含JAXB-API

    ##用JDK12环境下 做EUREKA的的时候 报错如下 java.lang.TypeNotPresentException: Type javax.xml.bind.JAXBContext not ...

  4. VUE一款适用于pc平台的简单toast

    新项目要求用typescript+vue+elementui的模式来搭建pc项目,最初踩了好多坑.产品说提示不想用element-ui的提示. 打算用toast的形式.所以就自己写了一个pc的toas ...

  5. IIS 组成

    HTTP.sys      http.sys 侦听来自网络的 HTTP 请求,将它们传递到 IIS 并返回响应. 它是一种可以从命令行停止和启动的服务.      "NET STOP HTT ...

  6. java 第六周课后作业

    1.定义长度位5的整型数组,输入他们的值,用冒泡排序后输出. Scanner sc = new Scanner(System.in); int[] arr = new int[5]; for (int ...

  7. 【Linux】Apache服务配置

    一. URL 统一资源定位符 http://www.sina.com.cn:80/admin/index.html 二. 环境安装 LAMP 源码包编译安装 版本可以自定义 生产环境 安全 稳定 开发 ...

  8. 《操作系统》课程笔记（Ch01-导论）

    Ch01 - 导论 操作系统的功能 用户视角:在乎使用方便,不在乎资源利用 系统视角:资源分配器.控制程序 计算机系统的运行 启动:利用固件(Firmware)中的引导程序(Bootstrap Pro ...

  9. 自动生成四则运算题目(C语言)

    Github项目地址:https://github.com/huihuigo/expgenerator 合作者:马文辉(3118005015).卢力衔(3118005013) 项目简介 1题目:实现一 ...

  10. Markdown语法详解-cnblog

    博客的重要性 博客,英文名为Blog,它的正式名称为网络日记. 为什么要写博客? 需要总结和思考.有时候我们一直在赶路,却忘了放慢脚步 提升文笔组织能力 提升学习总结能力 提升逻辑思维能力 帮助他人, ...