[Python] 18. ネットワーク(Socket)通信する方法

こんにちは。明月です。

この投稿はPythonでネットワーク(Socket)通信する方法に関する説明です。

プログラムでネットワーク通信することはソケット通信といいます。ネットワーク通信はプログラムとプログラム間に通信することやPCとPC間に通信するという意味です。

ソケットはPythonだけではなく、他のプログラム言語でも同じ通信標準です。

基本的にソケット通信流れは下記とおりになります。

ソケット通信はサーバーとクライアントがあります。サーバーはソケット接続を待っているもの(Listen)です。クライアントは接続を待っているサーバーに接続するものです。

つまり、サーバーがListen状況になっているとクライアントがサーバーにconnectionします。そうするとサーバー側はacceptが発生してサーバーとクライアントがSendとReceiveでデータを送受信します。

データを送受信するデータタイプはバイナリ(byte)タイプになります。

# ソケットを使うためにsocketモジュールをimportするべきだ。
import socket, threading

# binder関数はサーバーからacceptしたら生成されるsocketインスタンスを通ってclientからデータを受信するとecho形で再送信するメソッドだ。
def binder(client_socket, addr):
  # コネクションになれば接続アドレスを出力する。
  print('Connected by', addr)
  try:
    # 接続状況でクライアントからデータ受信を待つ。
    # もし、接続が切れちゃうとexceptが発生する。
    while True:
      # socketのrecv関数は連結されたソケットからデータを受信を待つ関数だ。最初に4byteを待機する。
      data = client_socket.recv(4)
      # 最初4byteは転送するデータのサイズだ。そのサイズはlittleエンディアンでbyteからintタイプに変換する。
      length = int.from_bytes(data, "little")
      # データを受信する。上の受け取ったサイズほど
      data = client_socket.recv(length)
      # 受信されたデータをstr形式でdecodeする。
      msg = data.decode()
      # 受信されたメッセージをコンソールに出力する。
      print('Received from', addr, msg)

      # 受信されたメッセージの前に「echo:」という文字を付ける。
      msg = "echo : " + msg
      # バイナリ(byte)タイプに変換する。
      data = msg.encode()
      # バイナリのデータサイズを計算する。
      length = len(data)
      # データサイズをlittleエンディアンタイプのbyteに変換して転送する。
      client_socket.sendall(length.to_bytes(4, byteorder="little"))
      # データをクライアントに転送する。
      client_socket.sendall(data)
  except:
    # 接続が切れちゃうとexceptが発生する。
    print("except : " , addr)
  finally:
    # 接続が切れたらsocketリソースを返却する。
    client_socket.close()

# ソケットを生成する。
server_socket = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
# ソケットレベルとデータタイプを設定する。
server_socket.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
# サーバーは複数ipを使っているPCの場合はIPを設定して、そうではない場合はNoneや''で設定する。
# ポートはPC内で空いているポートを使う。cmdにnetstat -an | find "LISTEN"で確認できる。
server_socket.bind(('', 9999))
# server設定が完了すればlistenを開始する。
server_socket.listen()

try:	
  # サーバーは複数クライアントから接続するので無限ループを使う。
  while True:
    # clientから接続すればacceptが発生する。
    # clientソケットとaddr(アドレス)をタプルで受け取る。
    client_socket, addr = server_socket.accept()
    # スレッドを利用してclient接続を作って、またaccept関数に行ってclientを待機する。
    th = threading.Thread(target=binder, args = (client_socket,addr))
    # スレッド開始
    th.start()
except:
  # コンソール出力
  print("server")
finally:
  # エラーが発生すればサーバーソケットを閉める。
  server_socket.close()

上の例をソケットサーバーソースです。

基本的にbindしてlistenでクライアントを待機します。その後、acceptが発生すればスレッドでクライアントソケットを渡してメッセージ受信を待機します。

binder関数では受信するデータサイズ、データ受信、echoを付けたデータのサイズを送信、echoデータ送信順の流れで繰り返しています。

thread環境で作ったので接続が切れなくても別のスレッドでクライアントを待つことができます。

# ソケットを使うためにsocketをimportするべきだ。
import socket	
# 127.0.0.1のIPはローカルの意味だ。
HOST = '127.0.0.1'
# ポートはサーバーで設定した9999に接続する。
PORT = 9999
# ソケットを生成する。
client_socket = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
# connect関数でサーバーに接続する。
client_socket.connect((HOST, PORT))

# 10回のループでsend、receiveをする。
for i in range(1,10):
  # メッセージはhelloで送信
  msg = 'hello'
  # メッセージをバイナリ(byte)タイプに変換する。
  data = msg.encode()
  # メッセージのサイズを計算する。
  length = len(data)
  # データサイズをlittleエンディアンタイプに変換してサーバーに送信する。
  client_socket.sendall(length.to_bytes(4, byteorder="little"))
  # データを送信する。
  client_socket.sendall(data)

  # サーバーからデータサイズを受信する。
  data = client_socket.recv(4)
  # データサイズはlittleエンディアンタイプでintタイプに変換する。
  length = int.from_bytes(data, "little")
  # データを受信する。
  data = client_socket.recv(length)
  # データをエンコードしてstrタイプに変換する。
  msg = data.decode()
  # コンソールに出力する。
  print('Received from : ', msg)
# ソケットリソースを返却する。
client_socket.close()

上の例をソケットクライアントソースです。

まず、サーバーを起動してクライアントを接続します。

クライアントからサーバーに接続してhelloというメッセージを10回にループで転送しました。サーバーには10回のhelloというメッセージを受信してecho :という文字を付けてecho : helloというメッセージをクライアントに転送しました。

その結果クライアントにはecho: helloが10回にコンソールに出力されました。

ソケットインスタンスを生成する時socket.AF_INETとsocket.SOCK_STREAMを使いましたが、socket.AF_INETはIP4インターネットを使うという意味だし、socket.SOCK_STREAMはデータをバイナリ(byte stream)タイプに使うという意味です。

AF_INET以外にAF_INET6、AF_UNIX、AF_CAN、AF_PACKET、AF_RDSのオプションがありますが、私も使ったことがないので具体的に知りません。AF_INET6だけはIP6インターネットだと思います。

インターネットアドレスタイプオプションみたいですが、一般的なプログラムならsocket.AF_INETだけで十分だと思います。

socket.SOCK_STREAMは連結指向性(TCP)という意味で、似ているなオプションではsocket.SOCK_DGRAM、socket.SOCK_RAW、socket.SOCK_RDM、socket.SOCK_SEQPACKETがあります。

SOCK_DGRAMは非連結指向性(UDP)だし、SOCK_RAWはソケットヘッダ情報まで取得する時に使うオプションです。

ソケットラベルにはSOL_SOCKET、IPPROTO_TCP、IPPROTO_UDPを使えます。

特にSOL_SOCKETの場合、ヘッダーレベルオプションをプロトコル側で設定するオプションです。

私の場合は特別なことがなければsocket.AF_INETとsocket.SOCK_STREAMの設定でSOL_SOCKET + SO_REUSEADDR, IPPROTO_TCP + TCP_NODELAYの形でソケット通信をします。

ここまでPythonでネットワーク(Socket)通信する方法に関する説明でした。

ご不明なところや間違いところがあればコメントしてください。