這篇文章將為大家詳細(xì)講解有關(guān)Django Channels如何實(shí)現(xiàn)點(diǎn)對點(diǎn)實(shí)時(shí)聊天和消息推送功能,小編覺得挺實(shí)用的,因此分享給大家做個(gè)參考,希望大家閱讀完這篇文章后可以有所收獲。
專注于為中小企業(yè)提供成都網(wǎng)站設(shè)計(jì)、網(wǎng)站建設(shè)服務(wù),電腦端+手機(jī)端+微信端的三站合一,更高效的管理,為中小企業(yè)曲江免費(fèi)做網(wǎng)站提供優(yōu)質(zhì)的服務(wù)。我們立足成都,凝聚了一批互聯(lián)網(wǎng)行業(yè)人才,有力地推動了上1000+企業(yè)的穩(wěn)健成長,幫助中小企業(yè)通過網(wǎng)站建設(shè)實(shí)現(xiàn)規(guī)模擴(kuò)充和轉(zhuǎn)變。簡介在很多實(shí)際的項(xiàng)目開發(fā)中,我們需要實(shí)現(xiàn)很多實(shí)時(shí)功能;而在這篇文章中,我們就利用django channels簡單地實(shí)現(xiàn)了點(diǎn)對點(diǎn)聊天和消息推送功能。
手邊有一個(gè)項(xiàng)目需要用到后臺消息推送和用戶之間一對一在線聊天的功能。例如用戶A評論了用戶B的帖子,這時(shí)候用戶B就應(yīng)該收到一條通知,顯示自己的帖子被評論了。這個(gè)功能可以由最基本的刷新頁面后訪問數(shù)據(jù)庫來完成,但是這樣會增加對后臺服務(wù)器的壓力,同時(shí)如果是手機(jī)客戶端的話,也會造成流量的損失。于是,我們考慮使用websocket建立一個(gè)連接來完成這個(gè)功能。
但是django并不支持websocket,因此在一番尋找之后發(fā)現(xiàn)了django-channels這個(gè)項(xiàng)目,它允許Django項(xiàng)目不僅可以處理HTTP,還可以處理需要長時(shí)間連接的協(xié)議 - WebSockets,MQTT,chatbots,業(yè)余無線電等等。
作者本人也接觸channels沒多久,為了搞這兩個(gè)功能看channels文檔看到自閉,最終簡單實(shí)現(xiàn)了這兩個(gè)功能,特地記錄一下
一:安裝channels
如果使用的是django 1.9 及以上,在pip安裝channels時(shí)可以不加-U參數(shù)
pip install channels
安裝結(jié)束后,我們把channels作為一個(gè)app添加進(jìn)入我們的django項(xiàng)目,在settings.py中添加
INSTALLED_APPS = [ 'django.contrib.admin', 'django.contrib.auth', 'django.contrib.contenttypes', 'django.contrib.sessions', 'django.contrib.messages', 'django.contrib.staticfiles', 'Your-app', 'channels', ]
在這里,我們使用redis做為channels的通道后端,以便支持更多的功能,具體涉及到的一些功能在后文中會提及。于是我們還需要安裝一些依賴包以支持其正常工作
pip install channels_redis
然后在settings.py文件中添加
CHANNEL_LAYERS = { "default": { "BACKEND": "channels_redis.core.RedisChannelLayer", "CONFIG": { "hosts": [('127.0.0.1', 6379)], }, # 配置路由的路徑 # "ROUTING": "exmchannels.routing.channel_routing", }, } ASGI_APPLICATION = 'exmchannels.routing.application'
二:點(diǎn)對點(diǎn)聊天
在項(xiàng)目目錄下新建一個(gè)文件,用來存放我們的channels代碼,為channel。在channel中新建一個(gè)comsumers.py文件,在其中新建一個(gè)ChatComsumer類用來處理我們聊天時(shí)的websocket請求。相對于建立一個(gè)聊天室,在這里不同的是我們在ChatComsumer中添加了一個(gè)chats來記錄每一個(gè)group中的連接數(shù)。以此根據(jù)這個(gè)連接數(shù)來判斷,聊天雙方是否都已連接進(jìn)入該個(gè)聊天group。
同時(shí),我們設(shè)定聊天組的命名形式為user_a的id加上下劃線_加上user_b的id,其中id值從小到大放置,例如:195752_748418
class ChatConsumer(AsyncJsonWebsocketConsumer): chats = dict() async def connect(self): self.group_name = self.scope['url_route']['kwargs']['group_name'] await self.channel_layer.group_add(self.group_name, self.channel_name) # 將用戶添加至聊天組信息chats中 try: ChatConsumer.chats[self.group_name].add(self) except: ChatConsumer.chats[self.group_name] = set([self]) #print(ChatConsumer.chats) # 創(chuàng)建連接時(shí)調(diào)用 await self.accept() async def disconnect(self, close_code): # 連接關(guān)閉時(shí)調(diào)用 # 將關(guān)閉的連接從群組中移除 await self.channel_layer.group_discard(self.group_name, self.channel_name) # 將該客戶端移除聊天組連接信息 ChatConsumer.chats[self.group_name].remove(self) await self.close()
ChatComsumer中的chats是一個(gè)字典,用來記錄每一個(gè)group中的連接數(shù)目。每當(dāng)一個(gè)客戶端訪問正確的websocket url之后,都會調(diào)用connect()函數(shù),將該客戶端添加入其url中指向的一個(gè)group,同時(shí)向chats中添加該客戶端的信息。當(dāng)該客戶端斷開連接時(shí),會調(diào)用disconnect()函數(shù),將該客戶端從group中移除,同時(shí)刪除它在chats中的記錄。
完成了連接和斷開連接的處理之后,我們來進(jìn)行接收信息的處理
async def receive_json(self, message, **kwargs): # 收到信息時(shí)調(diào)用 to_user = message.get('to_user') # 信息發(fā)送 length = len(ChatConsumer.chats[self.group_name]) if length == 2: await self.channel_layer.group_send( self.group_name, { "type": "chat.message", "message": message.get('message'), }, ) else: await self.channel_layer.group_send( to_user, { "type": "push.message", "event": {'message': message.get('message'), 'group': self.group_name} }, ) async def chat_message(self, event): # Handles the "chat.message" event when it's sent to us. await self.send_json({ "message": event["message"], })
在上述函數(shù)中,我們可以看到,當(dāng)接收到來自客戶端的websocket信息之后,我們首先判斷一下,這個(gè)聊天組中客戶端連接個(gè)數(shù)是一個(gè)還是兩個(gè)。如果連接個(gè)數(shù)為2,說明聊天雙方都已經(jīng)連接到了該聊天組,因此可以直接向該group發(fā)送信息,這樣對方就可以直接收到信息;如果連接個(gè)數(shù)為1,說明信息接受者還未進(jìn)入聊天組,我們便向其推送一條信息,包含group_name和信息內(nèi)容。
就這樣,我們完成了一個(gè)點(diǎn)對點(diǎn)的聊天系統(tǒng)。
三:消息推送
消息推送工作原理大致上和聊天的原理一致,即每一個(gè)用戶都有屬于自己的一個(gè)websocket連接,這里我們可以使用其username作為group_name,當(dāng)其他用戶的某些行為觸發(fā)了推送條件時(shí),后臺便向該用戶所在的group發(fā)送一條信息,這樣就完成了消息推送服務(wù)。
再次,特地說明一下,channels同樣提供了單通道發(fā)送,即每一個(gè)客戶端連接時(shí)都會生成一個(gè)專門的通道名稱。但是我們在這里使用的全部都是group發(fā)送,一個(gè)原因是我個(gè)人比較懶,使用group便可以完成相應(yīng)的功能,只要在客戶端連接時(shí)添加用戶認(rèn)證,便能保證每個(gè)用戶只能連接上自己的那個(gè)group。當(dāng)然,在這里只是展示簡單的消息推送如何實(shí)現(xiàn),并不展示其他代碼。
# 推送consumer class PushConsumer(AsyncWebsocketConsumer): async def connect(self): self.group_name = self.scope['url_route']['kwargs']['username'] await self.channel_layer.group_add( self.group_name, self.channel_name ) await self.accept() async def disconnect(self, close_code): await self.channel_layer.group_discard( self.group_name, self.channel_name ) # print(PushConsumer.chats) async def push_message(self, event): print(event) await self.send(text_data=json.dumps({ "event": event['event'] }))
消息推送是后臺向客戶端推送信息,因此不涉及處理接受來自客戶端的信息的操作,因此我們只要改寫connect()、disconnect()函數(shù),然后添加一個(gè)對發(fā)送信息的處理函數(shù)push_message()
然后我們再寫一個(gè)push()函數(shù),用來在項(xiàng)目的其他地方調(diào)用,這就是為什么我們在第一步里面要使用redis做為channels的通道后端。
from channels.layers import get_channel_layer def push(username, event): channel_layer = get_channel_layer() async_to_sync(channel_layer.group_send)( username, { "type": "push.message", "event": event } )
這個(gè)函數(shù)寫在PushComsumer之外,因?yàn)槲覀冊陧?xiàng)目的其他地方調(diào)用時(shí),不會使用self.self.channel_layer來獲取通道層,因此單獨(dú)寫做一個(gè)函數(shù),然后使用get_channel_layer來檢索它。
因此,在我們需要使用消息推送的地方,只要直接調(diào)用push()函數(shù),傳入被推送用戶的用戶名和推送的信息就OK了。
四:routing配置和其他配置
同樣,在channel文件夾下新建一個(gè)routing.py文件,然后在其中添加以下內(nèi)容,其工作原理和django的urls.py一致,是websocket的連接路徑。
from . import consumers websocket_urlpatterns = [ url(r'^ws/chat/(?P<group_name>[^/]+)/$', consumers.ChatConsumer), url(r'^push/(?P<username>[0-9a-z]+)/$', consumers.PushConsumer), ]
然后在settings.py同目錄新建一個(gè)routing.py文件,在其中添加以下代碼
from channels.auth import AuthMiddlewareStack from channels.routing import ProtocolTypeRouter, URLRouter import example.routing application = ProtocolTypeRouter({ # (http->django views is added by default) 'websocket': AuthMiddlewareStack( URLRouter( example.routing.websocket_urlpatterns ) ), })
這樣,客戶端便可以成功連接到websocket了,功能簡單實(shí)現(xiàn)。
關(guān)于“Django Channels如何實(shí)現(xiàn)點(diǎn)對點(diǎn)實(shí)時(shí)聊天和消息推送功能”這篇文章就分享到這里了,希望以上內(nèi)容可以對大家有一定的幫助,使各位可以學(xué)到更多知識,如果覺得文章不錯(cuò),請把它分享出去讓更多的人看到。
本文標(biāo)題:DjangoChannels如何實(shí)現(xiàn)點(diǎn)對點(diǎn)實(shí)時(shí)聊天和消息推送功能-創(chuàng)新互聯(lián)
當(dāng)前路徑:http://jinyejixie.com/article22/dipejc.html
成都網(wǎng)站建設(shè)公司_創(chuàng)新互聯(lián),為您提供定制網(wǎng)站、網(wǎng)頁設(shè)計(jì)公司、面包屑導(dǎo)航、移動網(wǎng)站建設(shè)、網(wǎng)站收錄、云服務(wù)器
聲明:本網(wǎng)站發(fā)布的內(nèi)容(圖片、視頻和文字)以用戶投稿、用戶轉(zhuǎn)載內(nèi)容為主,如果涉及侵權(quán)請盡快告知,我們將會在第一時(shí)間刪除。文章觀點(diǎn)不代表本網(wǎng)站立場,如需處理請聯(lián)系客服。電話:028-86922220;郵箱:631063699@qq.com。內(nèi)容未經(jīng)允許不得轉(zhuǎn)載,或轉(zhuǎn)載時(shí)需注明來源: 創(chuàng)新互聯(lián)
猜你還喜歡下面的內(nèi)容