Python编程
搜索
分类

详解Django-channels 实现WebSocket实例

作者：SharePoint团队 时间：2021-02-12 03:53:48　

引入

先安装三个模块


pip install channels

pip install channels_redis

pip install pywin32

创建一个Django项目和一个app

项目名随意，app名随意。这里项目名为 django_websocket_demo ，app名 chat

把app文件夹下除了 views.py 和 __init__.py 的文件都删了，最终项目目录结构如下：


django_websocket_demo/
 manage.py
 django_websocket_demo/
   __init__.py
   settings.py
   urls.py
   wsgi.py
 chat/
   __init__.py
   views.py

在app下新建一个templates文件夹用来存放HTML页面：


chat/
 __init__.py
 templates/
   chat/
     index.html
 views.py

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>

在 chat/views.py 中添加视图函数：


from django.shortcuts import render

def index(request):
 return render(request, 'chat/index.html', {})

添加 chat/urls.py 文件并设置路由信息：


from django.urls import re_path

from . import views

urlpatterns = [
 re_path(r'^$', views.index, name='index'),
]

在项目路由 django_websocket_demo/urls.py 中配置路由信息：


from django.conf.urls import include, url
from django.contrib import admin

urlpatterns = [
 url(r'^chat/', include('chat.urls')),
 url(r'^admin/', admin.site.urls),
]

在 settings.py 文件同级目录下新建 routing.py 文件，内容如下：


from channels.routing import ProtocolTypeRouter

application = ProtocolTypeRouter({
 # (http->django views is added by default)
})

把 channels 注册在 settings.py 里：


INSTALLED_APPS = [
 'channels',
 'chat',
 'django.contrib.admin',
 'django.contrib.auth',
 'django.contrib.contenttypes',
 'django.contrib.sessions',
 'django.contrib.messages',
 'django.contrib.staticfiles',
]

在   settings.py 文件中，添加如下配置项：


# django_websocket_demo/settings.py
# Channels
# Channels
ASGI_APPLICATION = 'django_websocket_demo.routing.application'

创建聊天页面

创建一个 chat/templates/chat/room.html 文件，添加如下内容：


<!-- chat/templates/chat/room.html -->
<!DOCTYPE html>
<html>
<head>
 <meta charset="utf-8"/>
 <title>Chat Room</title>
</head>
<body>
 <textarea id="chat-log" cols="100" rows="20"></textarea><br/>
 <input id="chat-message-input" type="text" size="100"/><br/>
 <input id="chat-message-submit" type="button" value="Send"/>
</body>
<script>
 var roomName = {{ room_name_json }};

var chatSocket = new WebSocket(
   'ws://' + window.location.host +
   '/ws/chat/' + roomName + '/');

chatSocket.onmessage = function(e) {
   var data = JSON.parse(e.data);
   var message = data['message'];
   document.querySelector('#chat-log').value += (message + '\n');
 };

chatSocket.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) {
   var messageInputDom = document.querySelector('#chat-message-input');
   var message = messageInputDom.value;
   chatSocket.send(JSON.stringify({
     'message': message
   }));

messageInputDom.value = '';
 };
</script>
</html>

在 chat/views.py 中添加一个处理 room的视图函数：


from django.shortcuts import render
from django.utils.safestring import mark_safe
import json

def index(request):
 return render(request, 'chat/index.html', {})

def room(request, room_name):
 return render(request, 'chat/room.html', {
   'room_name_json': mark_safe(json.dumps(room_name))
 })

在 chat/urls.py 中注册路由


from django.urls import re_path

from . import views

urlpatterns = [
 re_path(r'^$', views.index, name='index'),
 re_path(r'^(?P<room_name>[^/]+)/$', views.room, name='room'),
]

新建 chat/consumers.py 文件，添加如下内容：


from channels.generic.websocket import AsyncWebsocketConsumer
import json

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

# Join room group
   await self.channel_layer.group_add(
     self.room_group_name,
     self.channel_name
   )

await self.accept()

async def disconnect(self, close_code):
   # Leave room group
   await self.channel_layer.group_discard(
     self.room_group_name,
     self.channel_name
   )

# Receive message from WebSocket
 async def receive(self, text_data):
   text_data_json = json.loads(text_data)
   message = text_data_json['message']

# Send message to room group
   await self.channel_layer.group_send(
     self.room_group_name,
     {
       'type': 'chat_message',
       'message': message
     }
   )

# Receive message from room group
 async def chat_message(self, event):
   message = event['message']

# Send message to WebSocket
   await self.send(text_data=json.dumps({
     'message': message
   }))

新建一个 chat/routing.py 文件，添加以下内容：


from django.urls import re_path

from . import consumers

websocket_urlpatterns = [
 re_path(r'^ws/chat/(?P<room_name>[^/]+)/$', consumers.ChatConsumer),
]

将 django_websocket_demo/routing.py 文件中修改为以下内容：


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

application = ProtocolTypeRouter({
 # (http->django views is added by default)
 'websocket': AuthMiddlewareStack(
   URLRouter(
     chat.routing.websocket_urlpatterns
   )
 ),
})

配置redis

在本地6379端口启动redis : redis-server

在 settings.py 中添加如下配置：


CHANNEL_LAYERS = {
 'default': {
   'BACKEND': 'channels_redis.core.RedisChannelLayer',
   'CONFIG': {
     "hosts": [('127.0.0.1', 6379)],
   },
 },
}

最后启动Django项目

使用多个浏览器打开http://127.0.0.1:8000/chat/lobby/ ，开始实时聊天吧。

来源：https://www.cnblogs.com/peng104/p/11390152.html

标签：Django,channels,WebSocket
0
投稿

猜你喜欢

  • ASp使用AspJpeg组件制作透明文字水印

    2008-01-15 20:25:00

  • Python 时间处理datetime实例

    2023-11-17 08:09:37

  • 用isapi rewrite 实现asp的HTML静态化

    2007-11-25 12:28:00

  • Python利用Redis计算经纬度距离案例

    2021-03-05 04:51:35

  • Python socket实现的简单通信功能示例

    2023-03-03 07:49:40

  • 图像检索之基于vlfeat实现SIFT特征

    2021-11-18 13:13:40

  • Python 中获取数组的子数组示例详解

    2022-11-04 19:26:26

  • Python通过2种方法输出带颜色字体

    2023-02-08 20:53:22

  • 学习ASP和编程的28个观点

    2008-06-27 12:57:00

  • Python cookbook（数据结构与算法）让字典保持有序的方法

    2022-04-28 03:28:04

  • python递归调用中的坑:打印有值, 返回却None

    2023-11-02 23:07:42

  • python读取大文件越来越慢的原因与解决

    2022-07-23 08:35:28

  • 判断数据库里存在的BIG5码

    2009-04-09 18:31:00

  • python中使用％与.format格式化文本方法解析

    2023-09-21 18:02:11

  • 在Django框架中设置语言偏好的教程

    2022-01-18 22:47:35

  • python 批量添加的button 使用同一点击事件的方法

    2022-10-11 20:13:46

  • MySQL的存储过程写法和Cursor的使用

    2008-12-03 15:55:00

  • python request post 列表的方法详解

    2023-10-04 11:46:19

  • python命令行模式的用法及流程

    2022-05-01 17:31:13

  • 木鸟：ASP缓存类无错版

    2008-02-20 12:53:00
    • asp之家 网络编程 m.aspxhome.com