使用Django Channels和WebSocket构建聊天应用

2024-06-07 08:52
文章标签 channels 使用 构建 应用 django websocket 聊天

本文主要是介绍使用Django Channels和WebSocket构建聊天应用，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

在这里插入图片描述

一、引言

WebSocket提供了一种在客户端和服务器之间进行实时双向通信的方式。结合Django Channels，我们可以轻松地在Django项目中实现WebSocket功能。本文将通过一个简单的聊天应用示例，展示如何使用Django Channels和WebSocket。

二、环境搭建

项目的目录结构大致如下：

my_project/
├── application/
│   ├── __init__.py
│   ├── asgi.py
│   ├── routings.py
│   ├── settings.py
│   ├── urls.py
│   ├── wsgi.py
├── apps/
│   ├── app03/
│   │   ├── __init__.py
│   │   ├── consumers.py
│   │   ├── models.py
│   │   ├── tests.py
│   │   ├── views.py
│   │   └── routings.py
│   └── __init__.py
├── templates/
│   ├── chat.html
│   ├── A.html
│   └── B.html
└── manage.py
1.首先，确保你的系统中已安装Python和Django。然后，通过pip安装Channels：
pip install channels
2.配置settings.py

在application/settings.py中，需要添加Channels相关的配置：

  1. 安装Channels
INSTALLED_APPS = [# ...'channels',
]
  1. 配置ASGI应用
ASGI_APPLICATION = 'application.asgi.application'
  1. Channels的Redis配置
CHANNEL_LAYERS = {'default': {'BACKEND': 'channels_redis.core.RedisChannelLayer','CONFIG': {"hosts": [('127.0.0.1', 6379)],},},
}
3.确保您已安装channels_redis：
pip install channels_redis

并且有一个运行的Redis实例：（启动本地的redis）
在这里插入图片描述

在Django项目中，创建一个新的ASGI应用配置文件asgi.py：

import osimport django
from django.core.asgi import get_asgi_application
from channels.routing import ProtocolTypeRouter, URLRouter
from channels.auth import AuthMiddlewareStackfrom application.routings import websocket_urlpatternsos.environ.setdefault('DJANGO_SETTINGS_MODULE', 'application.settings')
django.setup()
application = ProtocolTypeRouter({'http': get_asgi_application(),"websocket": AuthMiddlewareStack(URLRouter(websocket_urlpatterns)),
})

在application/routings.py中，导入你的WebSocket路由模式：

from apps.app03.routings import ws_urlpatterns
websocket_urlpatterns = []
websocket_urlpatterns += ws_urlpatterns

三、创建WebSocket Consumer

在application/views.py中，创建一个ChatConsumer类来处理WebSocket连接：

import json
from channels.generic.websocket import AsyncWebsocketConsumerclass 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# Join room groupawait self.channel_layer.group_add(self.room_group_name,self.channel_name)await self.accept()async def disconnect(self, close_code):# Leave room groupawait self.channel_layer.group_discard(self.room_group_name,self.channel_name)# Receive message from WebSocketasync def receive(self, text_data):text_data_json = json.loads(text_data)message = text_data_json['message']# Send message to room groupawait self.channel_layer.group_send(self.room_group_name,{'type': 'chat_message','message': message})# 控制台输出print(message)# Receive message from room groupasync def chat_message(self, event):message = event['message']# Send message to WebSocketawait self.send(text_data=json.dumps({'message': message}))

在app03/routings.py中：

# -*- coding: utf-8 -*-
from django.urls import path
from apps.app03.views import ChatConsumer# 定义WebSocket路由模式
ws_urlpatterns = [path('ws/chat/<room_name>/', ChatConsumer.as_asgi()),
]

四、前端实现

创建一个HTML文件（例如chat.html）来作为聊天室的界面：

<!DOCTYPE html>
<html>
<head><title>Chat Example</title>
</head>
<body><h1>Chat Room</h1><div id="chat-messages"></div><!-- 添加输入框和发送按钮 --><input type="text" id="chat-message-input" placeholder="Type your message..."><button id="chat-message-send">Send</button><script>const chatSocket = new WebSocket('ws://127.0.0.1:8000/ws/chat/room_name/');chatSocket.onmessage = function(e) {const data = JSON.parse(e.data);console.log(data.message);const messageElement = document.createElement('p');messageElement.textContent = data.message;document.getElementById('chat-messages').appendChild(messageElement);};chatSocket.onclose = function(e) {console.error('Chat socket closed unexpectedly');};// 绑定发送按钮的点击事件document.getElementById('chat-message-send').onclick = function(e) {const messageInputDom = document.getElementById('chat-message-input');const message = messageInputDom.value;chatSocket.send(JSON.stringify({'message': message}));messageInputDom.value = '';};</script>
</body>
</html>

四、测试和运行

在完成所有必要的配置和编码之后，您需要测试您的聊天应用以确保其正常工作。以下是测试和运行聊天应用的详细步骤：

1. 启动Django开发服务器

在命令行中，运行以下命令以启动Django开发服务器：

python manage.py runserver 0.0.0.0:8001  # 这里使用8001端口
2. 启动Asgi服务器

要启动使用Django Channels的WebSocket服务，您可以使用daphne命令。daphne是一个ASGI服务器，专门用于运行Channels应用程序。以下是使用daphne启动WebSocket服务的步骤：

  1. 安装Daphne（如果尚未安装）：
    在命令行中运行以下命令：

    pip install daphne

  2. 启动Daphne服务器：

    • 导航到您的项目目录（例如my_project/）。

    • 运行以下命令：

      daphne application.asgi:application

      这个命令告诉daphne使用application.asgi模块中的application对象作为ASGI应用。这通常是您在application/asgi.py文件中定义的内容。

    • 启动成功效果：

      (lyadmin) D:\ProjectPython\Test\drf_test>daphne application.asgi:application
D:\ProjectPython\Test\drf_test
2024-06-06 11:23:21,620 INFO     Starting server at tcp:port=8000:interface=127.0.0.1
2024-06-06 11:23:21,620 INFO     HTTP/2 support enabled
2024-06-06 11:23:21,620 INFO     Configuring endpoint tcp:port=8000:interface=127.0.0.1
2024-06-06 11:23:21,620 INFO     Listening on TCP address 127.0.0.1:8000

  3. 确保Redis正在运行（如果使用Redis作为通道层）

2. 打开聊天室界面

在您的网络浏览器中，打开聊天室的界面。这通常是您的chat.html模板对应的URL。
在这里插入图片描述
在这里插入图片描述

3. 连接WebSocket

在浏览器中打开聊天室界面时，打开浏览器的开发者工具（通常是F12打开），使用Postman测试：

  1. 建立连接
    在这里插入图片描述
    在这里插入图片描述

  2. 发送简单消息
    在这里插入图片描述

  3. 聊天消息事件，用于在聊天应用中发送和接收消息
    在这里插入图片描述

  4. 断开连接
    在这里插入图片描述

示例二：测试聊天应用

1. 修改WebSocket Consumer
在application/views.py中，创建一个ChatConsumer类来处理WebSocket连接：

# ChatConsumer.py
# 实现聊天功能
import json
from channels.generic.websocket import AsyncWebsocketConsumerclass 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# Join room groupawait self.channel_layer.group_add(self.room_group_name,self.channel_name)await self.accept()async def disconnect(self, close_code):# Leave room groupawait self.channel_layer.group_discard(self.room_group_name,self.channel_name)# Receive message from WebSocketasync def receive(self, text_data):text_data_json = json.loads(text_data)message = text_data_json['message']# Send message to both room groups with origin informationawait self.channel_layer.group_send(self.room_group_name,  # Send to the same room group{'type': 'chat_message','message': message,'room_origin': self.room_group_name})await self.channel_layer.group_send('chat_room_b' if self.room_group_name == 'chat_room_a' else 'chat_room_a',# Send to the opposite room group{'type': 'chat_message','message': message,'room_origin': self.room_group_name})# Console outputprint(message)# Receive message from room groupasync def chat_message(self, event):message = event['message']room_origin = event['room_origin']# Send message to WebSocket with origin informationawait self.send(text_data=json.dumps({'message': message,'room_origin': room_origin}))

2. 前端实现
创建两个HTML文件（例如A.html\B.html）来作为聊天室的界面：

  • 聊天室A页面：
<!-- 聊天室A的HTML页面 -->
<!DOCTYPE html>
<html>
<head><title>Chat Room A</title>
</head>
<body>
<h1>Chat Room A</h1>
<div id="chat-messages"></div>
<input type="text" id="chat-message-input" placeholder="Type your message...">
<button id="chat-message-send">Send</button><script>const chatSocket = new WebSocket('ws://127.0.0.1:8000/ws/chat/room_a/');chatSocket.onmessage = function (e) {const data = JSON.parse(e.data);const messageElement = document.createElement('p');// 根据消息来源格式化消息if (data.room_origin === 'chat_room_a') {messageElement.textContent = `[chat_room_a] ${data.message}`;} else {messageElement.textContent = `[chat_room_b] ${data.message}`;}document.getElementById('chat-messages').appendChild(messageElement);};chatSocket.onclose = function (e) {console.error('Chat socket closed unexpectedly');};document.getElementById('chat-message-send').onclick = function (e) {const messageInputDom = document.getElementById('chat-message-input');const message = messageInputDom.value;chatSocket.send(JSON.stringify({'message': message}));messageInputDom.value = '';};
</script>
</body>
</html>
  • 聊天室B页面：
<!-- 聊天室B的HTML页面 -->
<!DOCTYPE html>
<html>
<head><title>Chat Room B</title>
</head>
<body>
<h1>Chat Room B</h1>
<div id="chat-messages"></div>
<input type="text" id="chat-message-input" placeholder="Type your message...">
<button id="chat-message-send">Send</button><script>const chatSocket = new WebSocket('ws://127.0.0.1:8000/ws/chat/room_b/');chatSocket.onmessage = function (e) {const data = JSON.parse(e.data);const messageElement = document.createElement('p');// 根据消息来源格式化消息if (data.room_origin === 'chat_room_a') {messageElement.textContent = `[chat_room_a] ${data.message}`;} else {messageElement.textContent = `[chat_room_b] ${data.message}`;}document.getElementById('chat-messages').appendChild(messageElement);};chatSocket.onclose = function (e) {console.error('Chat socket closed unexpectedly');};document.getElementById('chat-message-send').onclick = function (e) {const messageInputDom = document.getElementById('chat-message-input');const message = messageInputDom.value;chatSocket.send(JSON.stringify({'message': message}));messageInputDom.value = '';};
</script>
</body>
</html>

3. 功能测试：重启ASGI服务器，分别打开A.html、B.html测试

启动ASGI服务器命令：

 daphne application.asgi:application

在这里插入图片描述

结论

通过本文，你现在应该能够使用Django Channels和WebSocket创建一个基本的聊天应用。你可以在此基础上添加更多功能，如用户认证、消息存储等，来丰富你的应用。

这篇关于使用Django Channels和WebSocket构建聊天应用的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


http://www.chinasem.cn/article/1038714。

相关文章

中文分词jieba库的使用与实景应用（一）

中文分词jieba库的使用与实景应用（一）

知识星球：https://articles.zsxq.com/id_fxvgc803qmr2.html 目录 一.定义： 精确模式（默认模式）： 全模式： 搜索引擎模式： paddle 模式（基于深度学习的分词模式）： 二 自定义词典 三.文本解析   调整词出现的频率 四. 关键词提取 A. 基于TF-IDF算法的关键词提取 B. 基于TextRank算法的关键词提取
阅读更多...
水位雨量在线监测系统概述及应用介绍

水位雨量在线监测系统概述及应用介绍

在当今社会，随着科技的飞速发展，各种智能监测系统已成为保障公共安全、促进资源管理和环境保护的重要工具。其中，水位雨量在线监测系统作为自然灾害预警、水资源管理及水利工程运行的关键技术，其重要性不言而喻。 一、水位雨量在线监测系统的基本原理 水位雨量在线监测系统主要由数据采集单元、数据传输网络、数据处理中心及用户终端四大部分构成，形成了一个完整的闭环系统。 数据采集单元：这是系统的“眼睛”，
阅读更多...
使用SecondaryNameNode恢复NameNode的数据

使用SecondaryNameNode恢复NameNode的数据

1）需求： NameNode进程挂了并且存储的数据也丢失了，如何恢复NameNode 此种方式恢复的数据可能存在小部分数据的丢失。 2）故障模拟 （1）kill -9 NameNode进程 [lytfly@hadoop102 current]$ kill -9 19886 （2）删除NameNode存储的数据（/opt/module/hadoop-3.1.4/data/tmp/dfs/na
阅读更多...
Hadoop数据压缩使用介绍

Hadoop数据压缩使用介绍

一、压缩原则 （1）运算密集型的Job，少用压缩 （2）IO密集型的Job，多用压缩 二、压缩算法比较 三、压缩位置选择 四、压缩参数配置 1）为了支持多种压缩/解压缩算法，Hadoop引入了编码/解码器 2）要在Hadoop中启用压缩，可以配置如下参数
阅读更多...
Makefile简明使用教程

Makefile简明使用教程

文章目录 规则makefile文件的基本语法：加在命令前的特殊符号：.PHONY伪目标: Makefilev1 直观写法v2 加上中间过程v3 伪目标v4 变量 make 选项-f-n-C Make 是一种流行的构建工具，常用于将源代码转换成可执行文件或者其他形式的输出文件(如库文件、文档等)。Make 可以自动化地执行编译、链接等一系列操作。 规则 makefile文件
阅读更多...
如何用Docker运行Django项目

如何用Docker运行Django项目

本章教程，介绍如何用Docker创建一个Django，并运行能够访问。 一、拉取镜像 这里我们使用python3.11版本的docker镜像 docker pull python:3.11 二、运行容器 这里我们将容器内部的8080端口，映射到宿主机的80端口上。 docker run -itd --name python311 -p
阅读更多...
使用opencv优化图片（画面变清晰）

使用opencv优化图片（画面变清晰）

文章目录 需求影响照片清晰度的因素 实现降噪测试代码 锐化空间锐化Unsharp Masking频率域锐化对比测试 对比度增强常用算法对比测试 需求 对图像进行优化，使其看起来更清晰，同时保持尺寸不变，通常涉及到图像处理技术如锐化、降噪、对比度增强等 影响照片清晰度的因素 影响照片清晰度的因素有很多，主要可以从以下几个方面来分析 1. 拍摄设备 相机传感器：相机传
阅读更多...
csu 1446 Problem J Modified LCS （扩展欧几里得算法的简单应用）

csu 1446 Problem J Modified LCS （扩展欧几里得算法的简单应用）

这是一道扩展欧几里得算法的简单应用题，这题是在湖南多校训练赛中队友ac的一道题，在比赛之后请教了队友，然后自己把它a掉 这也是自己独自做扩展欧几里得算法的题目 题意：把题意转变下就变成了：求d1*x - d2*y = f2 - f1的解,很明显用exgcd来解 下面介绍一下exgcd的一些知识点：求ax + by = c的解 一、首先求ax + by = gcd(a,b)的解 这个
阅读更多...
hdu1394(线段树点更新的应用)

hdu1394(线段树点更新的应用)

题意：求一个序列经过一定的操作得到的序列的最小逆序数 这题会用到逆序数的一个性质，在0到n-1这些数字组成的乱序排列，将第一个数字A移到最后一位，得到的逆序数为res-a+(n-a-1) 知道上面的知识点后，可以用暴力来解 代码如下： #include<iostream>#include<algorithm>#include<cstring>#include<stack>#in
阅读更多...
嵌入式QT开发：构建高效智能的嵌入式系统

嵌入式QT开发：构建高效智能的嵌入式系统

摘要： 本文深入探讨了嵌入式 QT 相关的各个方面。从 QT 框架的基础架构和核心概念出发，详细阐述了其在嵌入式环境中的优势与特点。文中分析了嵌入式 QT 的开发环境搭建过程，包括交叉编译工具链的配置等关键步骤。进一步探讨了嵌入式 QT 的界面设计与开发，涵盖了从基本控件的使用到复杂界面布局的构建。同时也深入研究了信号与槽机制在嵌入式系统中的应用，以及嵌入式 QT 与硬件设备的交互，包括输入输出设
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2