Django-Channels使⽤和部署
本⽂链接:
Django-Channels作⽤
在Django部署的时候,通常使⽤的都是WSGI(Web Server Gateway Interface)既通⽤服务⽹关接⼝,该协议仅⽤来处理 Http 请求,更多关于WSGI 的说明请参见。
当⽹址需要加⼊ WebSocket 功能时,WSGI 将不再满⾜我们的需求,此时我们需要使⽤ASGI既异步服务⽹关接⼝,该协议能够⽤来处理多种通⽤协议类型,包括HTTP、HTTP2 和 WebSocket,更多关于 ASGI 的说明请参见。
ASGI 由 Django 团队提出,为了解决在⼀个⽹络框架⾥(如 Django)同时处理 HTTP、HTTP2、WebSocket 协议。为此,Django 团队开发了Django Channels 插件,为 Django 带来了 ASGI 能⼒。
在 ASGI 中,将⼀个⽹络请求划分成三个处理层⾯,最前⾯的⼀层,interface server(协议处理服务器),负责对请求协议进⾏解析,并将不同的协议分发到不同的 Channel(频道);频道属于第⼆层,通常可以是⼀个队列系统。频道绑定了第三层的 Consumer(消费者)。
Django-Channels使⽤
本⽂基于Django==2.1,channels==2.1.3,channels-redis==2.3.0。
⽰例项⽬RestaurantOrder旨在实现⼀个基于WebSocket的聊天室,在的基础上稍加修改⽤于点餐过程中的多⼈协作点餐。
在 settings.py 加⼊和 channels 相关的基础设置:
INSTALLED_APPS = [
'ib.admin',
'ib.auth',
'ttypes',
'ib.sessions',
'ssages',
'ib.staticfiles',
'channels',
...
]
ASGI_APPLICATION = "uting.application"
# WebSocket
CHANNEL_LAYERS = {
'default': {
'BACKEND': 'RedisChannelLayer',
'CONFIG': {
"hosts": [('127.0.0.1', 6379)],
},
},
}
在 wsgi.py 同级⽬录新增⽂件 asgi.py:
"""
ASGI entrypoint. Configures Django and then runs the application
defined in the ASGI_APPLICATION setting.
"""
import os
import django
uting import get_default_application
application = get_default_application()
在 wsgi.py 同级⽬录新增⽂件 routing.py,其作⽤类型与 urls.py ,⽤于分发webscoket请求: from django.urls import path
from channels.auth import AuthMiddlewareStack
uting import ProtocolTypeRouter, URLRouter
sumers import TableConsumer
application = ProtocolTypeRouter({
# Empty for now (http->django views is added by default)
'websocket': AuthMiddlewareStack(
URLRouter([
path('ws/table/<slug:table_id>/', TableConsumer),
])
),
})
新增 app 名为 table,在 table ⽬录下新增 consumers.py:
ic.websocket import AsyncJsonWebsocketConsumer
dels import Table
class TableConsumer(AsyncJsonWebsocketConsumer):
table = None
async def connect(self):
self.table = 'table_{}'.format(self.scope['url_route']['kwargs']['table_id'])
# Join room group
await self.up_add(self.table, self.channel_name)
await self.accept()
async def disconnect(self, close_code):
# Leave room group
await self.up_discard(self.table, self.channel_name)
# Receive message from WebSocket
async def receive_json(self, content, **kwargs):
# Send message to room group
await self.up_send(self.table, {'type': 'message', 'message': content})
# Receive message from room group
async def message(self, event):
message = event['message']
# Send message to WebSocket
await self.send_json(message)
TableConsumer类中的函数依次⽤于处理连接、断开连接、接收消息和处理对应类型的消息,其中up_send(self.table, {'type':
'message', 'message': content})⽅法,self.table 参数为当前组的组id, {'type': 'message', 'message': content} 部分分为两部分,type ⽤于指定该消息的类型,根据消息类型调⽤不同的函数去处理消息,⽽ message 内为消息主体。
在 table ⽬录下的 views.py 中新增函数:
def table(request, table_id):
return render(request, 'table/table.html', {
'room_name_json': mark_safe(json.dumps(table_id))
})
table 函数对应的 urls.py 不再赘述。
在 table 的 templates\table ⽬录下新增 table.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/table/' + roomName + '/');
var data = JSON.parse(e.data);
document.querySelector('#chat-log').value += (JSON.stringify(data) + '\n');
};
<('Chat socket closed unexpectedly');
};
document.querySelector('#chat-message-input').focus();
document.querySelector('#chat-message-input').onkeyup = function (e) {
nginx和网关怎么配合使用
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));
messageInputDom.value = '';
};
</script>
</html>
最终效果:
Django-Channels部署
在官⽅⽂档中推荐Djaogo-Channels的http部分和websocket部分均使⽤daphne进⾏部署,该⽅法参见。
本⽂使⽤的⽅法为使⽤Nginx代理,将http部分请求发送给uwsgi进⾏处理,将websocket部分请求发送
给daphne进⾏处理。uwsgi和daphhe均使
⽤supervisord进⾏控制。
需要注意的是,由于Nginx⽆法识别http请求和websocket请求,需要通过路由来区分是哪种协议。我使⽤的⽅法是规定所有的websocket的路由均以/ws开头(如: ws://ample/ws/table/table_id/),这样就可以让Nginx将所有以/ws开头的请求全部转发给daphne进⾏处理。
在Nginx和daphne进⾏通信时,有http socket和file socket两种通信⽅式,推荐使⽤后⼀种file socket的⽅式,在这⾥列出两种通信⽅式的部署代码。
http socket⽅式
upstream restaurant_order {
server unix:///django/RestaurantOrder/restaurant_order.sock;
}
server {
listen 8000;
server_name 114.116.25.246; # substitute your machine's IP address or FQDN
charset utf-8;
client_max_body_size 75M;
location /media {
alias /django/RestaurantOrder/media;
}
location /static {
alias /django/RestaurantOrder/static;
}
access_log /django/RestaurantOrder/log/access.log;
error_log /django/RestaurantOrder/log/error.log;
location / {
uwsgi_pass restaurant_order;
include /django/RestaurantOrder/uwsgi_params;
}
location /ws {
proxy_pass 127.0.0.1:8001;
proxy_http_version 1.1;
proxy_set_header Upgrade $http_upgrade;
proxy_set_header Connection "upgrade";
proxy_redirect    off;
proxy_set_header  Host $host;
proxy_set_header  X-Real-IP $remote_addr;
proxy_set_header  X-Forwarded-For $proxy_add_x_forwarded_for;
proxy_set_header  X-Forwarded-Host $server_name;
proxy_read_timeout  36000s;
proxy_send_timeout  36000s;
}
}
[program:restaurant_order_service]
command=uwsgi --ini /django/RestaurantOrder/restaurant_order_uwsgi.ini
directory=/django/RestaurantOrder
stdout_logfile=/django/RestaurantOrder/log/uwsgi_out.log
stderr_logfile=/django/RestaurantOrder/log/uwsgi_err.log
autostart=true
autorestart=true
user=root
startsecs=10
[program:restaurant_order_websocket]
command=/django/RestaurantOrder/environment/bin/daphne -b 0.0.0.0 -p 8001 RestaurantOrder.asgi:application
directory=/django/RestaurantOrder
stdout_logfile=/django/RestaurantOrder/log/websocket_out.log
stderr_logfile=/django/RestaurantOrder/log/websocket_err.log
autostart=true
autorestart=true
user=root
startsecs=10
file socket⽅式
区别于http socket的为2处,1是f中的新增upstream websocket,并在location /ws中设置proxy_pass websocket;,需要注意此处的前缀不可省略;2是daphne的启动⽅式改为daphne -u /django/RestaurantOrder/websocket.sock RestaurantOrder.asgi:application。
upstream restaurant_order {
server unix:///django/RestaurantOrder/restaurant_order.sock;
}
upstream websocket {
server unix:///django/RestaurantOrder/websocket.sock;
}
server {
listen 8000;
server_name 114.116.25.246; # substitute your machine's IP address or FQDN
charset utf-8;
client_max_body_size 75M;
location /media {
alias /django/RestaurantOrder/media;

版权声明:本站内容均来自互联网,仅供演示用,请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198,我们将在24小时内删除。