2019/08/17

PythonでSocketIO(サーバー編)

背景

PythonでSocketIO通信を行う必要があったため、今後の開発の効率化のためにSocketIO通信を行うクラスのテンプレートを作成する。

記事の目的

PythonでSocketIOサーバーを作成する

python-socketio

python-socketioを使用したSocketIOサーバーを作成する

選定理由

python-socketioの選定理由は、下記の通りである。

導入方法

python-socketioの導入手順は、下記の通りである。
  1. pipを利用してインストールする
    1. $ pip install requests eventlet python-socketio

テンプレート

python-socketioの使用テンプレートは、下記の通りである。
  1. # socketioライブラリのインポート
  2. import socketio
  3. # ログ出力用ライブラリのインポート
  4. from logging import getLogger, StreamHandler, DEBUG, INFO, ERROR
  5. # 時間関係ライブラリのインポート
  6. import time
  7. # 終了シグナルをキャッチするライブラリのインポート
  8. import signal
  9. # eventletライブラリのインポート
  10. import eventlet
  11. # マルチスレッドライブラリをインポート
  12. import threading
  14. # ロガーのインスタンス作成
  15. logger         = getLogger(__name__)
  16. stream_handler = StreamHandler()
  18. # ログレベルを設定
  19. log_level = INFO
  20. logger.setLevel(log_level)
  21. stream_handler.setLevel(log_level)
  23. # ロガーにハンドラーをセット
  24. logger.addHandler(stream_handler)
  26. # SocketIOのテンプレート
  27. class SocketIOServer:
  28.     # namespaceの設定用クラス
  29.     class NamespaceClass(socketio.Namespace):
  30.         def on_connect(self, sid, environ):
  31.             pass
  32.         def on_disconnect(self, sid):
  33.             pass
  34.         def on_message(self, sid, data):
  35.             pass
  36.         def on_client_to_server(self, sid, data):
  37.             pass
  38.     # 接続時に呼ばれるイベント
  39.     def on_connect(self, sid, environ):
  40.         logger.info('Connected to client (sid: %s, environ: %s)',\
  41.                      str(sid), str(environ))
  42.         self.is_connect_ = True
  43.     # 切断時に呼ばれるイベント
  44.     def on_disconnect(self, sid):
  45.         logger.info('Disconnected from client (sid: %s)',str(sid))
  46.         self.is_connect_ = False
  47.     # サーバーからデータ送信(send)する
  48.     def send_data(self, data):
  49.         try:
  50.             self.sio_.send(data, namespace=self.namespace_) 
  51.         except:
  52.             logger.error('Has not connected to client')
  53.         else:
  54.             logger.info('Send message %s (namespace="%s")',\
  55.                          str(data), self.namespace_) 
  56.     # 独自定義のイベント名「server_to_client」で、サーバーからデータ送信(emit)する
  57.     def emit_data(self, data):
  58.         try:
  59.             self.sio_.emit('server_to_client', data, namespace=self.namespace_)
  60.         except:
  61.             logger.error('Has not connected to client')
  62.         else:
  63.             logger.info('Emit message %s (namespace="%s")',\
  64.                          str(data), self.namespace_) 
  65.     def on_message(self, sid, data):
  66.         logger.info('Received message %s', str(data)) 
  67.         self.send_data({'test_ack': 'send_from_server'})
  68.     # クライアントからイベント名「on_client_to_server」でデータがemitされた時に呼ばれる
  69.     def on_client_to_server(self, sid, data):
  70.         logger.info('Received message %s', str(data))
  71.         self.emit_data({'test_ack': 'emit_from_server'})
  72.     # Namespaceクラス内の各イベントをオーバーライド
  73.     def overload_event(self):
  74.         self.Namespace.on_connect          = self.on_connect
  75.         self.Namespace.on_disconnect       = self.on_disconnect
  76.         self.Namespace.on_message          = self.on_message
  77.         self.Namespace.on_client_to_server = self.on_client_to_server
  78.     # 初期化
  79.     def __init__(self,ip,port,namespace):
  80.         self.ip_          = ip
  81.         self.port_        = port
  82.         self.namespace_   = namespace
  83.         self.is_connect_  = False
  84.         self.sio_         = socketio.Server(async_mode='eventlet')
  85.         self.app_         = socketio.WSGIApp(self.sio_)
  86.         self.Namespace    = self.NamespaceClass(self.namespace_)
  87.         self.overload_event()
  88.         self.sio_.register_namespace(self.Namespace)
  89.     # 接続確認
  90.     def isConnect(self):
  91.         return self.is_connect_
  92.     # 切断
  93.     def disconnect(self,sid):
  94.         try:
  95.             self.sio_.disconnect(sid,namespace=self.namespace_)
  96.         except:
  97.             logger.error('Cannot disconnect from Client(sid="%s", namespace="%s")',\
  98.                           namespace=self.namespace_)
  99.         else:
  100.             self.is_connect_ = False
  101.     # 開始
  102.     def start(self):
  103.         try:
  104.             logger.info('Start listening(%s:%d, namespace="%s")',\
  105.                          self.ip_,self.port_,self.namespace_)
  106.             eventlet.wsgi.server(eventlet.listen((self.ip_, self.port_)), self.app_)
  107.         except: 
  108.             logger.error('Cannot start listening(%s:%d, namespace="%s")',\
  109.                           self.ip_,self.port_,self.namespace_)
  110.     # メインの処理
  111.     def run(self):
  112.         p = threading.Thread(target=self.start)
  113.         p.setDaemon(True)
  114.         p.start()
  116. if __name__ == '__main__':
  117.     # Ctrl + C (SIGINT) で終了
  118.     signal.signal(signal.SIGINT, signal.SIG_DFL)
  119.     # SocketIO Server インスタンスを生成
  120.     sio_server = SocketIOServer('localhost', 10000, '/test')
  121.     # SocketIO Server インスタンスを実行
  122.     sio_server.run()
  123.     # 接続待ち
  124.     while not sio_server.isConnect():
  125.         time.sleep(1)
  126.     # 切断待ち
  127.     while sio_server.isConnect():
  128.         time.sleep(1)
  129.     logger.info('Finish')
  130.     # 終了
  131.     exit()

備考

  • namespaceは、必ず「/」(スラッシュ)から始まる必要がある
  • eventletを使用した場合、他の作業スレッドから、SocketIO内のEmitやSendを呼び出せない
  • 上記テンプレートは、クライアントと通信テストができる

まとめ

  • Python-SocketIOを利用したサーバーモジュールを作成した

参考文献


変更履歴

  1. 2019/08/17: 新規作成
時刻:
ラベル: ,

0 件のコメント:

コメントを投稿

登録: コメントの投稿 (Atom)

MQTTの導入

背景 IoTデバイスの接続環境構築のため、MQTT(mosquitto)の導入を行った。 記事の目的 MQTT(mosquitto)をUbuntuに導入する mosquitto ここではmosquittoについて記載する。 MQTT MQTT(Message Qu...