快捷導(dǎo)航

Django Channels 實(shí)現(xiàn)點(diǎn)對點(diǎn)實(shí)時聊天和消息推送功能

更新時間：2019年07月17日 13:56:59 作者：Suummmmer

這篇文章主要介紹了Django Channels 實(shí)現(xiàn)點(diǎn)對點(diǎn)實(shí)時聊天和消息推送功能，本文分步驟給大家介紹的非常詳細(xì)，具有一定的參考借鑒價值,需要的朋友可以參考下

簡介在很多實(shí)際的項(xiàng)目開發(fā)中，我們需要實(shí)現(xiàn)很多實(shí)時功能；而在這篇文章中，我們就利用django channels簡單地實(shí)現(xiàn)了點(diǎn)對點(diǎn)聊天和消息推送功能。

手邊有一個項(xiàng)目需要用到后臺消息推送和用戶之間一對一在線聊天的功能。例如用戶A評論了用戶B的帖子，這時候用戶B就應(yīng)該收到一條通知，顯示自己的帖子被評論了。這個功能可以由最基本的刷新頁面后訪問數(shù)據(jù)庫來完成，但是這樣會增加對后臺服務(wù)器的壓力，同時如果是手機(jī)客戶端的話，也會造成流量的損失。于是，我們考慮使用websocket建立一個連接來完成這個功能。

但是django并不支持websocket，因此在一番尋找之后發(fā)現(xiàn)了django-channels這個項(xiàng)目，它允許Django項(xiàng)目不僅可以處理HTTP，還可以處理需要長時間連接的協(xié)議 - WebSockets，MQTT，chatbots，業(yè)余無線電等等。

作者本人也接觸channels沒多久，為了搞這兩個功能看channels文檔看到自閉，最終簡單實(shí)現(xiàn)了這兩個功能，特地記錄一下

一：安裝channels

如果使用的是django 1.9 及以上，在pip安裝channels時可以不加-U參數(shù)

pip install channels

安裝結(jié)束后，我們把channels作為一個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)目目錄下新建一個文件，用來存放我們的channels代碼，為channel。在channel中新建一個comsumers.py文件，在其中新建一個ChatComsumer類用來處理我們聊天時的websocket請求。相對于建立一個聊天室，在這里不同的是我們在ChatComsumer中添加了一個chats來記錄每一個group中的連接數(shù)。以此根據(jù)這個連接數(shù)來判斷，聊天雙方是否都已連接進(jìn)入該個聊天group。

同時，我們設(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)建連接時調(diào)用
    await self.accept()
  async def disconnect(self, close_code):
    # 連接關(guān)閉時調(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是一個字典，用來記錄每一個group中的連接數(shù)目。每當(dāng)一個客戶端訪問正確的websocket url之后，都會調(diào)用connect()函數(shù)，將該客戶端添加入其url中指向的一個group，同時向chats中添加該客戶端的信息。當(dāng)該客戶端斷開連接時，會調(diào)用disconnect()函數(shù)，將該客戶端從group中移除，同時刪除它在chats中的記錄。

完成了連接和斷開連接的處理之后，我們來進(jìn)行接收信息的處理

 async def receive_json(self, message, **kwargs):
    # 收到信息時調(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信息之后，我們首先判斷一下，這個聊天組中客戶端連接個數(shù)是一個還是兩個。如果連接個數(shù)為2，說明聊天雙方都已經(jīng)連接到了該聊天組，因此可以直接向該group發(fā)送信息，這樣對方就可以直接收到信息；如果連接個數(shù)為1，說明信息接受者還未進(jìn)入聊天組，我們便向其推送一條信息，包含group_name和信息內(nèi)容。

就這樣，我們完成了一個點(diǎn)對點(diǎn)的聊天系統(tǒng)。

三：消息推送

消息推送工作原理大致上和聊天的原理一致，即每一個用戶都有屬于自己的一個websocket連接，這里我們可以使用其username作為group_name，當(dāng)其他用戶的某些行為觸發(fā)了推送條件時，后臺便向該用戶所在的group發(fā)送一條信息，這樣就完成了消息推送服務(wù)。

再次，特地說明一下，channels同樣提供了單通道發(fā)送，即每一個客戶端連接時都會生成一個專門的通道名稱。但是我們在這里使用的全部都是group發(fā)送，一個原因是我個人比較懶，使用group便可以完成相應(yīng)的功能，只要在客戶端連接時添加用戶認(rèn)證，便能保證每個用戶只能連接上自己的那個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ù)，然后添加一個對發(fā)送信息的處理函數(shù)push_message()

然后我們再寫一個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
    }
  )

這個函數(shù)寫在PushComsumer之外，因?yàn)槲覀冊陧?xiàng)目的其他地方調(diào)用時，不會使用self.self.channel_layer來獲取通道層，因此單獨(dú)寫做一個函數(shù)，然后使用get_channel_layer來檢索它。

因此，在我們需要使用消息推送的地方，只要直接調(diào)用push()函數(shù)，傳入被推送用戶的用戶名和推送的信息就OK了。

四：routing配置和其他配置

同樣，在channel文件夾下新建一個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同目錄新建一個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)。

總結(jié)

以上所述是小編給大家介紹的Django Channels 實(shí)現(xiàn)點(diǎn)對點(diǎn)實(shí)時聊天和消息推送功能,希望對大家有所幫助，如果大家有任何疑問請給我留言，小編會及時回復(fù)大家的。在此也非常感謝大家對腳本之家網(wǎng)站的支持！
如果你覺得本文對你有幫助，歡迎轉(zhuǎn)載，煩請注明出處，謝謝！

您可能感興趣的文章: