Django channel 使用websocket实时聊天通信

转载 于 2024-11-28 10:16:48 发布 · 157 阅读 · 0 ·
CC 4.0 BY-SA版权
原文链接：https://www.cnblogs.com/Sunzz/p/12788608.html
文章标签：

#django #websocket #okhttp #channel

0. 准备工作：安装channel依赖

pip3 install channels 
pip3 install channels_redis

1. 新建Django项目

1.1 新建项目

django-admin startproject mysite

1.2 新建应用

python3 manage.py startapp chat

1.3 编辑 mysite/settings.py文件

#注册应用
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)],
        },
    },
}

2. 详细代码与配置

2.1 添加索引视图的模板

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

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

<!-- chat/templates/chat/index.html -->
<!DOCTYPE html>
<html>
<head>
    <meta charset="utf-8"/>
    <title>Chat Rooms</title>
</head>
<body>
    What chat room would you like to enter?<br>
    <input id="room-name-input" type="text" size="100"><br>
    <input id="room-name-submit" type="button" value="Enter">

    <script>
        document.querySelector('#room-name-input').focus();
        document.querySelector('#room-name-input').onkeyup = function(e) {
            if (e.keyCode === 13) {  // enter, return
                document.querySelector('#room-name-submit').click();
            }
        };

        document.querySelector('#room-name-submit').onclick = function(e) {
            var roomName = document.querySelector('#room-name-input').value;
            window.location.pathname = '/chat/' + roomName + '/';
        };
    </script>
</body>
</html>

2.2 创建聊天与消息推送模板

chat/templates/chat/room.html

<!DOCTYPE html>
<html>
<head>
    <script src="https://cdn.bootcdn.net/ajax/libs/jquery/3.5.0/jquery.min.js" type="text/javascript"></script>
    <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/bootstrap@3.3.7/dist/css/bootstrap.min.css">
    <script src="https://cdn.jsdelivr.net/npm/bootstrap@3.3.7/dist/js/bootstrap.min.js"></script>
    <meta charset="utf-8"/>
    <title>Chat Room</title>
</head>
<body>
<textarea id="chat-log" cols="150" rows="30" class="text"></textarea><br>
<input id="chat-message-input" type="text" size="150"><br>
<input id="chat-message-submit" type="button" value="发送消息" class="input-sm">
<button id="get_data" class="btn btn-success">获取后端数据</button>
{{ room_name|json_script:"room-name" }}

<script>

    $("#get_data").click(function () {
        $.ajax({
            url: "{% url 'push' %}",
            type: "GET",
            data: {
                "room": "{{ room_name }}",
                "csrfmiddlewaretoken": "{{ csrf_token }}"
            },
        })
    });

    const roomName = JSON.parse(document.getElementById('room-name').textContent);
    const chatSocket = new WebSocket(
        'ws://' + window.location.host
        + '/ws/chat/'
        + roomName + '/'
    );
    let chatSocketa = new WebSocket(
        "ws://" + window.location.host + "/ws/push/" + roomName
    );
    chatSocket.onmessage = function (e) {
        const data = JSON.parse(e.data);
        // data 为收到后端发来的数据
        //console.log(data);
        document.querySelector('#chat-log').value += (data.message + '\n');
    };
    chatSocketa.onmessage = function (e) {
        let data = JSON.parse(e.data);
        //let message = data["message"];
        document.querySelector("#chat-log").value += (data.message + "\n");
    };


    chatSocket.onclose = function (e) {
        console.error('Chat socket closed unexpectedly');
    };
    chatSocketa.onclose = function (e) {
        console.error("Chat socket closed unexpectedly");
    };
    document.querySelector('#chat-message-input').focus();
    document.querySelector('#chat-message-input').onkeyup = function (e) {
        if (e.keyCode === 13) {  // enter, return
            document.querySelector('#chat-message-submit').click();
        }
    };

    document.querySelector('#chat-message-submit').onclick = function (e) {
        const messageInputDom = document.querySelector('#chat-message-input');
        const message = messageInputDom.value;
        chatSocket.send(JSON.stringify({
            'message': message
        }));
        messageInputDom.value = '';
    };
</script>
</body>
</html>

2.3 创建房间的视图

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

# chat/views.py
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})

2.4 创建项目二级路由

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

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

urlpatterns = [
    path('', views.index, name='index'),　　 path('<str:room_name>/', views.room, name='room'),
]

2.5 修改根路由

# mysite/urls.pyfrom 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"),
]

2.6 创建一个消费者

文件chat/consumers.py

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

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

2.7 为项目添加websocket的路由配置

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

# mysite/chat/routing.py

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

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

2.8 配置websocket根路由

from channels.routing import ProtocolTypeRouter, URLRouter
from channels.auth import AuthMiddlewareStack
import chat.routing

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

2.9 最终的文件关系如下图

在这里插入图片描述

2.10 启动服务（结束）

python3 manage.py runserver 10.0.6.2:80

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

在这里插入图片描述

2.11 还有另一种更稳健的启动方式(备注)

和setting同级新增文件 asgi.py

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()

启动方式为：

daphne -b 10.0.6.2 -p 80 mysite.asgi:application

在这里插入图片描述

备注：daphne 在安装channel时已经自动安装好了

高压锅_1220
关注
Django Channels WebSocket实时通信实战：从聊天功能到消息推送
高压锅博客
07-04 984
本文介绍了使用Django Channels构建WebSocket实时应用的方法。通过对比传统HTTP与WebSocket协议，分析了WebSocket在实时通信中的优势。详细讲解了Django Channels的技术架构，包括ASGI协议服务器、频道层和消费者三个核心组件。文章提供了完整的环境配置指南，从Python版本、Django安装到Redis消息队列的设置。在实现部分，展示了前后端WebSocket通信的关键代码：前端通过JavaScript建立WebSocket连接并处理消息推送；后端配置路由和
构建实时Web应用：使用Django Channels实现WebSocket通信的完整指南
最新发布
理论都是虚的，代码才是王道。
09-04 1768
在项目根目录下创建一个routing.py]),})这里我们定义了一个WebSocket路由，指向chat应用中的类。
django+websocket实时通讯
04-08
使用python语言 django框架，websocket实现的网页即时通信demo
使用Python的Django和layim实现即时通讯的方法
09-20
主要介绍了使用Python的Django和layim实现即时通讯的方法，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧
使用Python的Django和layim实现即时通讯
weixin_30849591的博客
05-24 318
看到Django和layim实现websocketde资料很少，自己就琢磨了下，顺便搭建出来了。自己要去找闲心大神授权呀。先来看图 这是初次搭建的，今天一天就搞定。我自己接入了图灵机器人。Python这需要安装Django和dwebsocket，安装之后现在Django的settings里面将WEBSOCKET_ACCEPT_ALL=True写进去 @require_websock...
python加django加websocket实现即时通讯
10-25
用django加websocket实现简单网页聊天
使用Django Channel构建WebSocket实时聊天室教程
在示例中，前端通过HTML元素和JavaScript与WebSocket服务器进行交互，用户输入的内容通过WebSocket发送到服务器，服务器接收到消息后广播给所有连接的客户端，从而实现实时聊天功能。 为了实现基于Django Channels...
基于django channel实现websocket的聊天室的方法示例
09-19
本篇将详细介绍如何基于Django Channel库来构建一个WebSocket聊天室，以及WebSocket的工作原理和优势。 首先，Django Channel是Django框架的一个扩展，它允许开发者处理异步请求，如WebSocket连接，从而实现长连接...
Django+Vue实现WebSocket连接的示例代码
10-16
在本文中，我们将探讨如何使用Django和Vue.js框架实现WebSocket连接，以便实现实时通信。WebSocket协议允许双向通信，即服务器和客户端可以同时发送数据，非常适合用于实时更新的场景，如在线聊天、股票报价、游戏等...
使用WebSocket实现即时通讯(一个群聊的聊天室)
08-27
主要为大家详细介绍了使用WebSocket实现即使通讯，实现一个群聊的聊天室，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
使用Django构建即时通讯应用的最简单方法
一只大鸽子的博客
01-03 1410
使用Django构建即时通讯应用的最简单方法 原文:《The simplest way to build an instant messaging app with Django》 https://www.photondesigner.com/articles/instant-messenger 利用 Server-Sent Events（见参考1）实现通信。 效果如下： 0. 设置Django和Daphne 创建项目和应用： pip install django daphne django-admi
javascript与python即时通讯,使用Python的Django和layim实现即时通讯的方法
weixin_39701768的博客
03-21 133
看到Django和layim实现websocketde资料很少，自己就琢磨了下，顺便搭建出来了。自己要去找闲心大神授权呀。先来看图这是初次搭建的，今天一天就搞定。我自己接入了图灵机器人。Python这需要安装Django和dwebsocket，安装之后现在Django的settings里面将WEBSOCKET_ACCEPT_ALL=True写进去@require_websocketdef send...
在Django5中使用Websocket进行通信
源滚滚编程
12-30 1737
使用Django5和Websoket，开发一个简单的聊天室应用
基于Django websocket实现视频画面的实时传输案例
qq_55520324的博客
06-08 3106
📌本案例是基于B/S架构的视频监控画面的实时传输，使用django作为服务端的开发框架。Django Channels 是一个用于在 Django 框架中实现实时、异步通信的扩展库。传统的 Django 是基于请求-响应模式的，每个请求都会经过 Django 的视图函数进行处理并返回响应。而 Channels 提供了基于事件驱动的编程模型，使得开发者可以处理实时的事件，如 WebSocket 连接、消息队列、定时任务等。
Django使用channels实现通信
热门推荐
LYSHARK
02-02 1万+
Channels 是 Django 的一个扩展，用于支持实时、异步的 Web 应用程序。传统的 Django 主要是同步的，即每个请求都在一个线程中处理，但是对于实时性要求高的应用，例如聊天应用、通知系统、实时协作工具等，需要支持异步操作和长连接。
django channels(websocket)的使用，实现网页间实时聊天
分享一点有用的知识
04-18 2305
django channels(websocket)的使用，实现网页间实时聊天
Django中使用WebSocket（channels）
qq_46042132的博客
06-01 1146
下载channels库和daphne库。
vue+django实现websocket连接
shykevin的博客
02-05 1671
一、概述 在项目中，需要使用websocket，来展示一些实时信息。 这里使用django 3.1.5 二、django项目 安装模块 pip3 install django-cors-headers channels 新建项目websocket_demo 修改websocket_demo/asgi.py import os from channels.auth import A...
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
红包 添加红包
表情包 插入表情
表情包 代码片
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值