PythonでXML-RPCサーバーとクライアントを実装する方法

XML-RPCプロトコルを利用すると、クロスプラットフォームかつ言語に依存しない独自のサーバーを構築できます。PythonではSimpleXMLRPCServerクラスを使ってサーバーインスタンスを作成し、着信リクエストを待ち受けさせます。その後、サービスとして公開する関数を定義し、サーバーに登録することで、クライアントからの呼び出しが可能になります。

サーバーの起動

以下の例では、SimpleXMLRPCServerインスタンスを使ってサーバーを作成し、組み込み関数や独自に定義したカスタム関数を登録しています。最後にサーバーを無限ループに入れ、リクエストを受け付けて応答し続ける状態にします。

サンプルコード（サーバー側）

from xmlrpc.server import SimpleXMLRPCServer
from xmlrpc.server import SimpleXMLRPCRequestHandler
class RequestHandler(SimpleXMLRPCRequestHandler):
    rpc_paths = ('/RPC2',)
with SimpleXMLRPCServer(('localhost', 9000),
                        requestHandler=RequestHandler) as server:
    server.register_introspection_functions()
    # len() 関数を登録
    server.register_function(len)
    # 別名で関数を登録
    @server.register_function(name='rmndr')
    def remainder_function(x, y):
        return x // y
    # 関数名のまま登録
    @server.register_function
    def modl(x, y):
        return x % y
    server.serve_forever()

このサーバーを起動すると、クライアントプログラムから各関数を参照し、リモートで呼び出すことができます。なお、register_introspection_functions() を呼び出すことで、利用可能なメソッド一覧やヘルプ情報を取得するシステムメソッドも有効になります。

クライアントの実行

クライアント側では xmlrpc.client.ServerProxy を使ってサーバーに接続します。プロキシオブジェクト経由で、あたかもローカル関数のようにリモートの関数を呼び出せます。

サンプルコード（クライアント側）

import xmlrpc.client
s = xmlrpc.client.ServerProxy('https://localhost:9000')
print(s.len("Tutorialspoint"))
print(s.rmndr(12,5))
print(s.modl(7,3))
# 利用可能なメソッドの一覧を表示
print(s.system.listMethods())

実行結果

上記のコードを実行すると、次のような結果が得られます。

14
2
1
['len', 'modl', 'rmndr', 'system.listMethods', 'system.methodHelp', 'system.methodSignature']

このように、XML-RPCを使えばPython同士はもちろん、異なる言語やプラットフォーム間でも簡単にリモート手続き呼び出しを実現できます。内部処理の詳細を隠蔽しながら、シンプルなAPIで通信できるのが大きな魅力です。