Django Channel实现实时推送与聊天

先来看一下最终的效果吧

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

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

先来简单了解一下 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（消费者）。

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

一、安装channel

<code>pip3 install channels 
pip3 install channels_redis/<code>

二、新建Django项目

1.新建项目

<code>django-admin startproject mysite/<code>

2.新建应用

<code>python3 manage.py startapp chat/<code>

3.编辑 mysite/settings.py文件

<code>#注册应用
INSTALLED_APPS = [
    ....
    'chat.apps.ChatConfig',
    "channels",
]

# 在文件尾部新增如下配置

#将ASGI_APPLICATION设置设置为指向该路由对象作为您的根应用程序：
ASGI_APPLICATION = 'mysite.routing.application'

#配置Redis
CHANNEL_LAYERS = {
    'default': {
        'BACKEND': 'channels_redis.core.RedisChannelLayer',
        'CONFIG': {
            "hosts": [('10.0.6.29', 6379)],
        },
    },
}/<code> 

三、详细代码与配置

1. 添加索引视图的模板

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

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

<code> 



    
    Chat Rooms


    What chat room would you like to enter?

    

    

     

/<code>

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

chat/templates/chat/room.html

<code>


     
    
     
    
    Chat Room








{{ room_name|json_script:"room-name" }}

 

/<code>

3.创建房间的视图

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

<code># chat/views.py/<code>

<code>from django.shortcuts import render
from django.http import JsonResponse
from channels.layers import get_channel_layer
from asgiref.sync import async_to_sync


def index(request):
    return render(request, "chat/index.html")


def room(request, room_name):
    return render(request, "chat/room.html", {"room_name": room_name})


def pushRedis(request):
    room = request.GET.get("room")
    print(room)

    def push(msg):
        channel_layer = get_channel_layer()
        async_to_sync(channel_layer.group_send)(
            room,
            {"type": "push.message", "message": msg, "room_name": room}
        )

    push("推送测试", )
    return JsonResponse({"1": 1})/<code>

4. 创建项目二级路由

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

<code># mysite/chat/urls.py
from django.urls import path
from . import views

urlpatterns = [
    path('', views.index, name='index'),　　 path('/', views.room, name='room'),/<code>

<code>]/<code>

5. 修改根路由

<code># mysite/urls.py

from django.contrib import admin
from django.urls import path, include
from chat.views import pushRedis

urlpatterns = [
    path('admin/', admin.site.urls),
    path("chat/", include("chat.urls")),
    path("push", pushRedis, name="push"),
]/<code>

6.创建一个消费者

文件chat/consumers.py

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

<code>import time
import json
from channels.generic.websocket import WebsocketConsumer, AsyncWebsocketConsumer
from asgiref.sync import async_to_sync
import redis

pool = redis.ConnectionPool(
    host="10.0.6.29",
    port=6379,
    max_connections=10,
    decode_response=True,
)
conn = redis.Redis(connection_pool=pool, decode_responses=True)


class ChatConsumer(AsyncWebsocketConsumer):
    async def connect(self, ):
        self.room_name = self.scope["url_route"]["kwargs"]["room_name"]
        self.room_group_name = "chat_%s" % self.room_name

        await self.channel_layer.group_add(
            self.room_group_name,
            self.channel_name,
        )
        await self.accept()

    async def disconnect(self, close_code):
        print("close_code: ", close_code)
        await self.channel_layer.group_discard(
            self.room_group_name,
            self.channel_name
        )

    async def receive(self, text_data=None, bytes_data=None):
        text_data_json = json.loads(text_data)
        message = text_data_json["message"]
        print("receive_message：", message)
        await self.channel_layer.group_send(
            self.room_group_name,
            {
                "type": "chat_message",
                "message": message
            }
        )

    async def chat_message(self, event):
        receive_message = event["message"]
        response_message = "You message is :" + receive_message
        await self.send(text_data=json.dumps({
            "message": response_message
        }))


class PushMessage(WebsocketConsumer):

    def connect(self):
        self.room_group_name = self.scope["url_route"]["kwargs"]["room_name"]
        async_to_sync(self.channel_layer.group_add)(
            self.room_group_name,
            self.channel_name
        )
        self.accept()

    def disconnect(self, code):
        async_to_sync(self.channel_layer.group_discard)(
            self.room_group_name,
            self.channel_name
        )

    def push_message(self, event):
        """
        主动推送
        :param event:
        :return:
        """
        print(event, type(event))
        while True:
            time.sleep(2)
            msg = time.strftime("%Y-%m-%d %H:%M:%S") + "---  room_name: %s" % event["room_name"]
            self.send(text_data=json.dumps(
                {"message": msg}
            ))/<code>

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

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

<code># mysite/chat/routing.py

from django.urls import re_path, path
from . import consumers

websocket_urlpatterns = [
    re_path(r"ws/chat/(?P\w+)/$", consumers.ChatConsumer),
    path("ws/push/", consumers.PushMessage),
]/<code>

8.配置websocket根路由

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

<code>from channels.routing import ProtocolTypeRouter, URLRouter
from channels.auth import AuthMiddlewareStack
import chat.routing

application = ProtocolTypeRouter({
    "websocket": AuthMiddlewareStack(
        URLRouter(
            chat.routing.websocket_urlpatterns
        )
    ),
})/<code>

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

10.启动服务

<code>python3 manage.py runserver 10.0.6.2:80/<code>

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

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

和setting同级新增文件 asgi.py

<code>import os
import django
from channels.routing import get_default_application

os.environ.setdefault("DJANGO_SETTINGS_MODULE", "mysite.settings")
django.setup()
application = get_default_application()/<code>

启动方式为：

<code>daphne -b 10.0.6.2 -p 80 mysite.asgi:application/<code>

<code>daphne 在安装channel时已经自动安装好了/<code>

最后

小编是一名python开发工程师，这里有我自己整理了一套最新的python系统学习教程，包括从基础的python脚本到web开发、爬虫、数据分析、数据可视化、机器学习等。想要这些资料的可以关注小编，并在后台私信小编：“01”即可领取