Django中如何使用Channels功能
:最近后臺寫游戲更新版本功能,簡單就是前端發(fā)送更新請求,后端需要對很多臺服務(wù)器進(jìn)行更新和各種操作,本來想著實現(xiàn)不難,后來發(fā)現(xiàn)因為后端需要執(zhí)行很長時間,前端返回報錯,后端會執(zhí)行完畢,但是前端先斷開了,這樣在前端頁面我就看不到更新結(jié)果了。通過調(diào)整nginx參數(shù),設(shè)置超時時間,還是日志會報499狀態(tài)碼錯誤。后來了解到了websocket,對于需要長時間處理的請求,使用websocket會更好,通過使用websocket實現(xiàn)了自己的功能,簡單分享下
一、什么是WebSocket
WebSocket是一種在單個TCP連接上進(jìn)行全雙工通訊的協(xié)議。WebSocket允許服務(wù)端主動向客戶端推送數(shù)據(jù)。
在WebSocket協(xié)議中,客戶端瀏覽器和服務(wù)器只需要完成一次握手就可以創(chuàng)建持久性的連接,并在瀏覽器和服務(wù)器之間進(jìn)行雙向的數(shù)據(jù)傳輸。
WebSocket的響應(yīng)頭中重要的字段:
HTTP/1.1 101 Swi tching Protocols:切換協(xié)議,WebSocket協(xié)議通過HTTP協(xié)議來建立運輸層的TCP連接
Connection和Upgrade:表示服務(wù)端發(fā)起的WebSocket響應(yīng)
Sec-WebSocket-Accept:表示服務(wù)器接受了客戶端的請求,由Sec-WebSocket-Key計算得來
WebSocket協(xié)議的優(yōu)點:
支持雙向通信,實時性更強
數(shù)據(jù)格式比較輕量,性能開銷小,通信高效
支持?jǐn)U展,用戶可以擴展協(xié)議或者實現(xiàn)自定義的子協(xié)議(比如支持自定義壓縮算法等)
WebSocket協(xié)議的缺點:
少部分瀏覽器不支持,瀏覽器支持的程度與方式有區(qū)別
長連接對后端處理業(yè)務(wù)的代碼穩(wěn)定性要求更高,后端推送功能相對復(fù)雜
成熟的HTTP生態(tài)下有大量的組件可以復(fù)用,WebSocket較少
WebSocket的應(yīng)用場景:
即時聊天通信,網(wǎng)站消息通知
在線協(xié)同編輯,如騰訊文檔
多玩家在線游戲,視頻彈幕,股票基金實施報價
二、什么是Channels
Django本身不支持WebSocket,但可以通過集成Channels框架來實現(xiàn)WebSocket
Channels是針對Django項目的一個增強框架,可以使Django不僅支持HTTP協(xié)議,還能支持WebSocket,MQTT等多種協(xié)議,同時Channels還整合了Django的auth以及session系統(tǒng)方便進(jìn)行用戶管理及認(rèn)證。
2.1channels文件和配置的含義
asgi.py:介于網(wǎng)絡(luò)協(xié)議服務(wù)和Python應(yīng)用之間的接口,能夠處理多種通用協(xié)議類型,包括HTTP、HTTP2和WebSocket
channel_layers:在settings.py中配置。類似于一個通道,發(fā)送者(producer)在一段發(fā)送消息,消費者(consumer)在另一端進(jìn)行監(jiān)聽
routings.py:相當(dāng)于Django中的urls.py
consumers.py:相當(dāng)于Django中的views.py
2.2channels文檔鏈接
https://channels.readthedocs.io/en/latest/introduction.html
2.3.WSGI和ASGI不同
WSGI(Python Web Server Gateway Interface):為Python語言定義的Web服務(wù)器和Web應(yīng)用程序或者框架之間的一種簡單而通用的接口。
ASGI(Asynchronous Web Server Gateway Interface):異步網(wǎng)關(guān)協(xié)議接口,一個介于網(wǎng)絡(luò)協(xié)議服務(wù)和Python應(yīng)用之間的標(biāo)準(zhǔn)接口,能夠處理多種通用的協(xié)議類型,包括HTTP,HTTP2和WebSocket。
三、Django中使用Channel
3.1安裝channels
pip install channels==2.1.7
3.2修改setting.py文件
INSTALLED_APPS = [ 'django.contrib.staticfiles', ... ... 'channels', ] # 指定ASGI的路由地址 ASGI_APPLICATION = 'webapp.routing.application' #ASGI_APPLICATION 指定主路由的位置為webapp下的routing.py文件中的application
3.3setting.py的同級目錄下創(chuàng)建routing.py路由文件,routing.py類似于Django中的url.py指明websocket協(xié)議的路由
from channels.auth import AuthMiddlewareStack from channels.routing import ProtocolTypeRouter, URLRouter from channels.security.websocket import AllowedHostsOriginValidator import webapp.routing application = ProtocolTypeRouter({ 'websocket':AllowedHostsOriginValidator( AuthMiddlewareStack( URLRouter( webapp.routing.websocket_urlpatterns ) ) ) })
ProtocolTypeRouter:ASGI支持多種不同的協(xié)議,在這里可以指定特定協(xié)議的路由信息,這里只使用了websocket協(xié)議,這里只配置websocket即可
AllowedHostsOriginValidator:指定允許訪問的IP,設(shè)置后會去Django中的settings.py中去查找ALLOWED_HOSTS設(shè)置的IP
AuthMiddlewareStack:用于WebSocket認(rèn)證,繼承了Cookie Middleware,SessionMiddleware,SessionMiddleware。
django的channels封裝了django的auth模塊,使用這個配置我們就可以在consumer中通過下邊的代碼獲取到用戶的信息,和請求的url路徑
self.sc
def connect(self): self.user = self.scope["user"] self.request_url = self.scope['path']
ope類似于django中的request,包含了請求的type、path、header、cookie、session、user等等有用的信息
URLRouter: 指定路由文件的路徑,也可以直接將路由信息寫在這里,代碼中配置了路由文件的路徑,會去對應(yīng)應(yīng)用下的routeing.py文件中查找websocket_urlpatterns
3.4webapp.routing.py內(nèi)容如下
from django.urls import path from webapp.consumers import ChatConsumer websocket_urlpatterns = [ path('ws/chat/',ChatConsumer) ]
routing.py路由文件跟django的url.py功能類似,語法也一樣,意思就是訪問ws/chat/都交給ChatConsumer處理?! ?/p>
3.5在要使用WebSocket的應(yīng)用中創(chuàng)建consumers.py,consumers.py是用來開發(fā)ASGI接口規(guī)范的python應(yīng)用,而Django中的view.py是用來開發(fā)符合WSGI接口規(guī)范的python應(yīng)用。
from channels.generic.websocket import WebsocketConsumer from channels.generic.websocket import AsyncWebsocketConsumer import json,time
Channels支持同步,也支持異步方式
同步方式代碼如下:
class ChatConsumer(WebsocketConsumer): # websocket建立連接時執(zhí)行方法 def connect(self): self.accept() # websocket斷開時執(zhí)行方法 def disconnect(self, close_code): self.close() # 從websocket接收到消息時執(zhí)行函數(shù) def receive(self, text_data): text_data_json = json.loads(text_data) message = f'結(jié)果:{text_data_json}' self.send(text_data=json.dumps( { 'message': message }))
異步方式代碼如下:
class ChatConsumer(AsyncWebsocketConsumer): #websocket建立連接時執(zhí)行方法 async def connect(self): await self.accept() # websocket斷開時執(zhí)行方法 async def disconnect(self, close_code): print(close_code) # 從websocket接收到消息時執(zhí)行函數(shù) async def receive(self, text_data): for i in range(10): time.sleep(i) message = '結(jié)果: ' + str(i) await self.send(text_data=json.dumps({ 'message': message }) )
需要注意的是在異步中所有的邏輯都應(yīng)該是異步的,不可以那同步的和異步的代碼混合使用?! ?/p>
四、前端Websocket使用
WebSocket對象一個支持四個消息:onopen,onmessage,oncluse和onerror
onopen: 當(dāng)瀏覽器和websocket服務(wù)端連接成功后會觸發(fā)onopen消息
onerror: 如果連接失敗,或者發(fā)送、接收數(shù)據(jù)失敗,或者數(shù)據(jù)處理出錯都會觸發(fā)onerror消息
onmessage: 當(dāng)瀏覽器接收到websocket服務(wù)器發(fā)送過來的數(shù)據(jù)時,就會觸發(fā)onmessage消息,參數(shù)e包含了服務(wù)端發(fā)送過來的數(shù)據(jù)
onclose: 當(dāng)瀏覽器接收到websocket服務(wù)器發(fā)送過來的關(guān)閉連接請求時,會觸發(fā)onclose消息
拼接websocket請求地址,建立長連接
var chatSocket = new WebSocket('ws://' + window.location.host + '/ws/ver_update/');
連接事件
chatSocket.onopen = function () { console.log(getCurrentDate(2) + ' ' + 'websocket connection success') };
錯誤事件
chatSocket.onerror = function () { console.error(getCurrentDate(2) + ' ' + 'websocket connection error') };
關(guān)閉事件
chatSocket.onclose = function (e) { layer.msg('websocket關(guān)閉,檢查錯誤日志', {icon: 2}); console.error(getCurrentDate(2) + ' ' + 'websocket closed unexpectedly 狀態(tài)碼:' + e.code); chatSocket.close(); };
接收事件
chatSocket.onmessage = function (e) { var data = JSON.parse(e.data); }
五、測試Channels功能
總結(jié):自從使用Websocket功能后,再也沒發(fā)生前端突然斷開的情況了,對于長時間運行的任務(wù),使用websocket是不錯的選擇~,有不足的地方請多多指教
到此這篇關(guān)于Django中使用Channels功能的文章就介紹到這了,更多相關(guān)Django使用Channels內(nèi)容請搜索本站以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持本站!
版權(quán)聲明:本站文章來源標(biāo)注為YINGSOO的內(nèi)容版權(quán)均為本站所有,歡迎引用、轉(zhuǎn)載,請保持原文完整并注明來源及原文鏈接。禁止復(fù)制或仿造本網(wǎng)站,禁止在非www.sddonglingsh.com所屬的服務(wù)器上建立鏡像,否則將依法追究法律責(zé)任。本站部分內(nèi)容來源于網(wǎng)友推薦、互聯(lián)網(wǎng)收集整理而來,僅供學(xué)習(xí)參考,不代表本站立場,如有內(nèi)容涉嫌侵權(quán),請聯(lián)系alex-e#qq.com處理。