在线聊天室是当今互联网上常见的产品,在各种电商的网络客户服务中,我们都能接触到在线聊天。
还有一个培训机构,你一打开他的网页,立马就弹出一个在线聊天框,防不胜防。这个教程分为上中下三篇,其中:
- 上篇使用 Django 传统的 MTV 模式进行开发,实现一个在线聊天室的功能。
- 中篇在上篇基础上加入数据存储,实现聊天记录的保存。
- 下篇则采用后端 Django + 前端 Vue 对传统的 Web 模开发式进行改造。
非常适合学了 Django 之后写项目无从下手的朋友们。
本篇为上篇,我们将使用 Django 的传统开发模式,借助视图和模板完成一个在线聊天室应用的开发。
最终效果如下所示:
直接开干吧!
创建虚拟环境
为了不与计算机上现有的 Python 模块冲突,我们新起一个 Python 虚拟环境:
python -m venv django3_env
进入虚拟环境,然后激活它。
安装依赖库
后端我们使用的是 Django3 框架(在本文编写时,Django 的最新版本为 3.2,所以我们不需要指定它的版本):
pip install django
还有一个重要的依赖库——Channels。
Channels 封装了 Django 的原生异步视图支持,让 Django 项目不仅可以处理 HTTP,还可以处理需要长时间连接的协议,比如:WebSockets、MQTT、聊天机器人、业余无线电等等。
简而言之,就是为 Django 提供了异步和非 HTTP 处理的能力。
pip install channels
因为 Channels 中的一个功能需要使用到 Redis 作为数据通道和缓存,所以我们得安装 Redis 以及其 Python 相关的包。
而 Redis 在 Windows 上没有官方的支持,所以在这里,使用一个 Redis 的替代品 Memurai 来当 Redis 使用:
安装完成后即会作为 Windows 的服务在后台启动。
然后安装 Channels 的 Redis 配套库:
pip install channels_redis
创建项目
安装好所有的依赖项之后,我们开始创建 Django 项目:
django-admin startproject chat_backend
然后进入 chat_backend 目录,创建一个应用:
python manage.py startapp chat
配置项目
接着我们进行必要的配置,下述操作在 文件中进行。
添加 channels、chat 应用到 Django 项目的应用列表:
INSTALLED_APPS = [ 'django.con;, 'django.con;, 'django.con;, 'django.con;, 'django.con;, 'django.con;, 'channels', 'chat', ]
在项目根目录下新建名为templates的文件夹,然后定义 HTML 模板路径:
TEMPLATES = [ { 'BACKEND': 'django.;, 'DIRS': [ BASE_DIR / 'templates' ], 'APP_DIRS': True, 'OPTIONS': { 'context_processors': [ 'django.;, 'django.;, 'django.con;, 'django.con;, ], }, }, ]
然后指定 asgi 应用:
ASGI_APPLICATION = "c;
最后,指定 Channels 使用的数据通道后端,在这里我们使用的是 Redis:
CHANNEL_LAYERS = { 'default': { 'BACKEND': 'c;, 'CONFIG': { "hosts": [('127.0.0.1', 6379)], }, }, }
其中主机地址和端口号填写 Redis 启动后显示的默认值。
创建视图
在这个「在线聊天室」里面,一共有两个页面。一个是首页,用于输入房间号和用户名;另一个则是聊天房间的页面,用于进行聊天。
我们在 chat 应用的 views.py 下新建两个视图函数:
# 首页 def index(request): return render(request,'index.html',locals()) # 聊天室 def room(request,room_name): room_name = room_name username = reque('username', '游客') return render(request,'room.html',locals())
其中,视图函数index()返回 index.html,视图函数room()返回 room.html,这两个 HTML 文件需要我们在templates文件夹中进行创建。
定义路由
视图函数创建好之后,我们为其绑定路由,在 chat 应用下新建一个名为urls.py的文件,在其中写入如下内容:
from django.urls import path from c import * # HTTP URL urlpatterns = [ path('',index,name="index"), path('<str:room_name>/',room,name="room") ]
然后在 chat_backend 文件夹下的 urls.py 文件内引入 chat 应用的 url 配置:
urlpatterns = [ path('admin/', admin.), path('', include('c;)), ]
至此,「在线聊天室」这个项目的 HTTP 部分已经完成了开发。
访问首页,会显示如下图所示的页面:
我们可以输入房间号和用户名进入房间,进入房间后的页面如下图所示:
但是现在我们还不能进行在线聊天,因为在线聊天最核心的部分——WebSocket后端,我们还没有编写。
编写 WebSocket 后端
WebSocket 是一个长连接的双向通信协议。通过 WebSocket 我们可以在客户端和服务器端之间建立实时的通信,而不是像 HTTP 那样,只有客户端发起,服务器端才会响应。
在这里,我们借助 Channels 在 Django 中实现 WebSocket。
首先,在 chat 应用下新建一个名为con的文件(意为消费者,是 Channels 中的一个重要概念),在其中,我们引入 WebSocket 类:
from c import AsyncWebsocketConsumer
然后继承这个类,新建一个名为ChatConsumer的类,并在其中重写 WebSocket 的连接、关闭连接、消息接收等方法,代码如下所示:
class ChatConsumer(AsyncWebsocketConsumer): # 连接 async def connect(self): = ['url_route']['kwargs']['room_name'] = 'chat_%s' % # 加入聊天室 await ( , ) await () # 关闭连接 async def disconnect(self, close_code): await ( , ) # async def receive(self, text_data=None, bytes_data=None): data = j(text_data) message = data['message'] username = data['username'] # Send message to room group await ( , { 'type': 'chat_message', 'message': message, 'username': username } ) # 接收消息 async def chat_message(self, event): message = event['message'] username = event['username'] # 发送消息到 Websocket await (text_data=j({ 'message': message, 'username': username }))
最后,我们在 asgi 中重新声明路由。打开 chat_backend 目录下的 a 文件,将内容修改为如下所示:
import os from django.core.asgi import get_asgi_application from django.urls import path from c import AuthMiddlewareStack from c import ProtocolTypeRouter, URLRouter from c import ChatConsumer os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'c;) application = ProtocolTypeRouter({ "http": get_asgi_application(), "websocket": AuthMiddlewareStack( URLRouter([ path("ws/<str:room_name>/",C()), ]) ) })
如上代码所示,HTTP 通过 get_asgi_application 以传统的 HTTP 路由进行处理,而 WebSocket 则通过 Channels 的 URLRouter 进行处理。这样我们的项目启动之后就可以同时支持 HTTP 访问和 WebSocket 访问。
前端连接 WebSocket
后端提供了 WebSocket 服务,前端需要进行连接和处理才行。
来看看前端的处理过程。
首先,通过 new 一个 WebSocket对象,来创建 WebSocket连接:
// 建立一个 websocket 连接 const chatSocket = new WebSocket( 'ws://' + window.loca + '/ws/' + roomName + '/' );
然后编写 WebSocket 各类事件的回调函数:
// websocket连接关闭后的回调函数 c = function(e) { con('The socket closed unexpectedly'); }; // websocket连接从服务器收到消息的回调函数 c = function(e) { const data = JSON.parse); if ) { i == userName){ document.querySelector('#chat-record').innerHTML += ('<div class="right_msg">' + da + '<div class="right-record"><span>' + da + '</span></div></div><br>'); }else{ document.querySelector('#chat-record').innerHTML += ('<div class="left_msg">' + da + '<div class="left-record"><span>' + da + '</span></div></div><br>'); } } else { alert('消息为空!') } };
这样前端就完成了对后端 WebSocket 的连接和消息接收。
最后
运行项目,我们就可以在网页上进行实时在线聊天了。
当然,现在这个项目还有很多问题,比如:
- 聊天记录不会保存,刷新页面之后聊天记录就会消失。
- 没有用户认证和鉴权,谁都能输入房间号和用户名进入聊天室。
接下来,让我们继续完善这个「在线聊天室」,敬请期待!
1.《关于聊天室怎么进我想说使用 Python 开发一个在线聊天室》援引自互联网,旨在传递更多网络信息知识,仅代表作者本人观点,与本网站无关,侵删请联系页脚下方联系方式。
2.《关于聊天室怎么进我想说使用 Python 开发一个在线聊天室》仅供读者参考,本网站未对该内容进行证实,对其原创性、真实性、完整性、及时性不作任何保证。
3.文章转载时请保留本站内容来源地址,https://www.lu-xu.com/gl/2490992.html