06. WebSocket Consumer の処理の非同期処理化

パフォーマンスを向上させるために、WebSocket Consumerの処理を、同期ではなく非同期の処理に書き換えます。

解説

Channelsパッケージには、非同期処理に対応したWebSocket Consumerクラスが用意されています。非同期処理に対応したWebSocket Consumerクラスを利用すると、非同期処理を簡単に実現できます。

WebSocket Consumerの処理を、同期処理から非同期処理に変更するために、すべきことは以下です。

1. WebSocket Consumerの実装クラスであるChatConsumerクラスの親クラスを「WebsocketConsumer」から「AsyncWebsocketConsumer」に変更します。
2. ChatConsumerクラスのメンバ関数定義の「def」を「async def」に変更します。
3. ChatConsumerクラスの非同期関数の呼び出しに、「await」を追記します。
4. ChatConsumerクラスの「async_to_sync」は、削除します。

準備

05. を実施していない場合は、まず、05. を実施します。

仮想環境への切り替え

仮想環境に切り替えていない場合は、「MyChat」フォルダにて、下記コマンドを実行し、仮想環境に切り替えます。
.venv\Scripts\activate.bat

「mysite」フォルダに移動していない場合は移動します。
cd mysite

これ以降のコマンドの実行は、仮想環境にて実行します。

WebSocket Consumerの処理を非同期処理に変更

WebSocket Consumerの処理を、同期処理から非同期処理に変更します。

「mysite/chat/consumers.py」に、以下の変更を追加します。

• WebsocketConsumerのimportを、AsyncWebsocketConsumerのimportに変更します。 ( from channels.generic.websocket import AsyncWebsocketConsumer )
• async_to_syncクラスのimport文をコメントアウトします。
• ChatConsumerクラスの親クラスを「WebsocketConsumer」から「AsyncWebsocketConsumer」に変更します。
• ChatConsumerクラスのメンバ関数定義の「def」を「async def」に変更します。
• ChatConsumerクラスの非同期関数の呼び出しに、「await」を追記します。
• ChatConsumerクラスの「async_to_sync」で囲んだ記述は削除します。

「mysite/chat/consumers.py」の内容を、以下のようにします。
import json #from channels.generic.websocket import WebsocketConsumer from channels.generic.websocket import AsyncWebsocketConsumer #from asgiref.sync import async_to_sync # async_to_sync() : 非同期関数を同期的に実行する際に使用する。 # ChatConsumerクラス: WebSocketからの受け取ったものを処理するクラス class ChatConsumer( AsyncWebsocketConsumer ): # WebSocket接続時の処理 async def connect( self ): # グループに参加 self.strGroupName = 'chat' await self.channel_layer.group_add( self.strGroupName, self.channel_name ) # WebSocket接続を受け入れます。 # ・connect()でaccept()を呼び出さないと、接続は拒否されて閉じられます。 # 　たとえば、要求しているユーザーが要求されたアクションを実行する権限を持っていないために、接続を拒否したい場合があります。 # 　接続を受け入れる場合は、connect()の最後のアクションとしてaccept()を呼び出します。 await self.accept() # WebSocket切断時の処理 async def disconnect( self, close_code ): # グループから離脱 await self.channel_layer.group_discard( self.strGroupName, self.channel_name ) # WebSocketからのデータ受信時の処理 # （ブラウザ側のJavaScript関数のsocketChat.send()の結果、WebSocketを介してデータがChatConsumerに送信され、本関数で受信処理します） async def receive( self, text_data ): # 受信データをJSONデータに復元 text_data_json = json.loads( text_data ) # メッセージの取り出し strMessage = text_data_json['message'] # グループ内の全コンシューマーにメッセージ拡散送信（受信関数を'type'で指定） data = { 'type': 'chat_message', # 受信処理関数名 'message': strMessage, # メッセージ } await self.channel_layer.group_send( self.strGroupName, data ) # 拡散メッセージ受信時の処理 # （self.channel_layer.group_send()の結果、グループ内の全コンシューマーにメッセージ拡散され、各コンシューマーは本関数で受信処理します） async def chat_message( self, data ): data_json = { 'message': data['message'], } # WebSocketにメッセージを送信します。 # （送信されたメッセージは、ブラウザ側のJavaScript関数のsocketChat.onmessage()で受信処理されます） # JSONデータをテキストデータにエンコードして送ります。 await self.send( text_data=json.dumps( data_json ) )

動作確認

動作に関しては、前項と本項は変わりません。

「mysite」フォルダにて、下記コマンドを実行し、サーバーを起動します。python manage.py runserver

ブラウザを1つ立ち上げ、「http://127.0.0.1:8000」にアクセスします。
「aiueo」と「あいうえお」というメッセージをフォームに入力し、「Send」ボタンを押します。

送信したメッセージが、即座に、ブラウザのメッセージリストに追加されます。

ブラウザをもう1つ立ち上げ、「http://127.0.0.1:8000」にアクセスします。
「abc」と「xyz」というメッセージをフォームに入力し、「Send」ボタンを押します。

送信したメッセージが、即座に、両方のブラウザのメッセージリストに追加されます。

起動したサーバーは、「Ctrl + C」で終了します。

ダウンロード

サンプルプログラム

関連ページ

前項目：05. チャットメッセージの送受信

次項目：07. メッセージに発言者名の追記