09. 入退室ユーザー名、参加人数の表示

ユーザーの入室/退室に際して、入退室ユーザー名、参加人数が表示されるようにします。

解説

ユーザーの入室/退室に際して、入退室ユーザー名、参加人数が表示されるように、ChatConsumerクラスのチャット参加時／チャット離脱時の処理に、システムメッセージとして、入退室ユーザー名、参加人数を送信する処理を追加します。

準備

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

仮想環境への切り替え

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

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

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

ChatConsumerクラスの変更

ChatConsumerクラスのチャット参加時／チャット離脱時の処理に、システムメッセージとして、入退室ユーザー名、参加人数を送信する処理を追加します。

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

• システムメッセージのユーザー名定数を定義します。
• ルーム管理用のクラス変数の定義を追加します。
• コンストラクタに、クラス変数の初期化処理を追加します。
• 「チャットへの参加」関数に、参加者数の更新、システムメッセージの作成、作成したメッセージの拡散送信、の処理を追加します。
• 「チャットからの離脱」関数に、参加者数の更新、システムメッセージの作成、作成したメッセージの拡散送信、参加者がゼロのときはルーム管理からルームの削除、の処理を追加します。

「mysite/chat/consumers.py」の内容を以下のようにします。
（・・・略・・・） USERNAME_SYSTEM = '*system*' # ChatConsumerクラス: WebSocketからの受け取ったものを処理するクラス class ChatConsumer( AsyncWebsocketConsumer ): # ルーム管理（インスタンス変数ではなく、インスタンス間で使用可能なクラス変数） rooms = None # コンストラクタ def __init__( self, *args, **kwargs ): super().__init__( *args, **kwargs ) # クラス変数の初期化（最初のインスタンスが生成されたときのみ実施する） if ChatConsumer.rooms is None: ChatConsumer.rooms = {} # 空の連想配列 self.strGroupName = '' self.strUserName = '' （・・・略・・・） # チャットへの参加 async def join_chat( self, strRoomName ): # グループに参加 #self.strGroupName = 'chat' self.strGroupName = 'chat_%s' % strRoomName await self.channel_layer.group_add( self.strGroupName, self.channel_name ) # 参加者数の更新 room = ChatConsumer.rooms.get(self.strGroupName) if( None == room ): # ルーム管理にルーム追加 ChatConsumer.rooms[self.strGroupName] = {'participants_count': 1} else: room['participants_count'] += 1 # システムメッセージの作成 strMessage = '"' + self.strUserName + '" joined. there are ' + str( ChatConsumer.rooms[self.strGroupName]['participants_count'] ) + ' participants' # グループ内の全コンシューマーにメッセージ拡散送信（受信関数を'type'で指定） data = { 'type': 'chat_message', # 受信処理関数名 'message': strMessage, # メッセージ 'username': USERNAME_SYSTEM, # ユーザー名 'datetime': datetime.datetime.now().strftime( '%Y/%m/%d %H:%M:%S' ), # 現在時刻 } await self.channel_layer.group_send( self.strGroupName, data ) # チャットからの離脱 async def leave_chat( self ): if( '' == self.strGroupName ): return # グループから離脱 await self.channel_layer.group_discard( self.strGroupName, self.channel_name ) # 参加者数の更新 ChatConsumer.rooms[self.strGroupName]['participants_count'] -= 1 # システムメッセージの作成 strMessage = '"' + self.strUserName + '" left. there are ' + str( ChatConsumer.rooms[self.strGroupName]['participants_count'] ) + ' participants' # グループ内の全コンシューマーにメッセージ拡散送信（受信関数を'type'で指定） data = { 'type': 'chat_message', # 受信処理関数名 'message': strMessage, # メッセージ 'username': USERNAME_SYSTEM, # ユーザー名 'datetime': datetime.datetime.now().strftime( '%Y/%m/%d %H:%M:%S' ), # 現在時刻 } await self.channel_layer.group_send( self.strGroupName, data ) # 参加者がゼロのときは、ルーム管理からルームの削除 if( 0 == ChatConsumer.rooms[self.strGroupName]['participants_count'] ): del ChatConsumer.rooms[self.strGroupName] # ルーム名を空に self.strGroupName = ''

動作確認

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

ブラウザを複数立ち上げ、「http://127.0.0.1:8000」にアクセスします。

チャットに参加し、メッセージを送信したり、チャットから離脱したり、します。


ユーザーの入室/退室に際して、入退室ユーザー名、参加人数がシステムメッセージとして表示されます。

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

ダウンロード

サンプルプログラム

デモ

デモ（Heroku）：https://mychat-django.herokuapp.com/

関連ページ

前項目：08. チャットルームに分かれてチャット