Python的xmlrpc库提供轻量级RPC实现,基于XML和HTTP,适合简单跨语言通信;客户端用ServerProxy调用远程方法,服务端需注册函数并支持基础类型,推荐ThreadingXMLRPCServer并发。
Python 的 xmlrpc 库(即 xmlrpc.client 和 xmlrpc.server)是标准库中轻量级的远程过程调用(RPC)实现,适合简单跨语言通信或内部工具集成。它基于 XML 编码和 HTTP 传输,虽不如 REST 或 gRPC 现代,但部署简单、无需额外依赖。
使用 xmlrpc.client.ServerProxy 连接服务端,像调用本地函数一样调用远程方法。
基本用法示例:
import xmlrpc.client连接服务端(假设服务运行在 https://www./link/fcbb3a1c04ec11f1506563c26ca63774)
proxy = xmlrpc.client.ServerProxy('https://www./link/fcbb3a1c04ec11f1506563c26ca63774')
调用远程函数(如 add、get_user)
result = proxy.add(3, 5) # 返回 8 user = proxy.get_user(123) # 返回字典,如 {'id': 123, 'name': 'Alice'}
支持列表、字典、整数、字符串、布尔值、None、datetime、bytes(需 base64 编码)
proxy.echo({'msg': 'hello', 'count': 2})
注意点:
http:// 或 https://),否则报错ConnectionRefusedError 或 xmlrpc.client.ProtocolError
transport 参数自定义(见下文进阶用法)Python 提供两种常用服务端:单线程的 SimpleXMLRPCServer(Python 3.9+ 已弃用)和推荐的 xmlrpc.server.SimpleXMLRPCServer(兼容旧版写法);新项目建议用 ThreadingXMLRPCServer 支持并发。
简易服务端示例:
from xmlrpc.server import SimpleXMLRPCServer from xmlrpc.server import SimpleXMLRPCRequestHandler仅允许 /RPC2 路径访问(可选安全限制)
class RequestHandler(SimpleXMLRPCRequestHandler): rpc_paths = ('/RPC2',)
创建服务端(监听 localhost:8000)
server = SimpleXMLRPCServer(('localhost', 8000), requestHandler=RequestHandler) server.register_introspection_functions() # 启用 system.listMethods 等调试方法
注册函数(可直接注册普通函数)
def add(x, y): return x + y
def get_user(user_id): return {'id': user_id, 'name': 'Test User', 'active': True}
server.register_function(add, 'add') server.register_function(get_user, 'get_user')
启动服务(阻塞式)
print("XML-RPC server running on https://www./link/fcbb3a1c04ec11f1506563c26ca63774/RPC2") server.serve_forever()
关键细节:
register_function() 才能让客户端发现并调用该函数register_introspection_functions() 开启内省能力(如 system.listMethods),方便调试ThreadingXMLRPCServer(继承自同名类,用法一致)客户端设置超时:
import xmlrpc.clientclass TimeoutTransp
ort(xmlrpc.client.Transport): def init(self, timeout=10, *args, *kwargs): self.timeout = timeout super().init(args, **kwargs)
def make_connection(self, host): conn = super().make_connection(host) conn.timeout = self.timeout return connproxy = xmlrpc.client.ServerProxy( 'https://www./link/fcbb3a1c04ec11f1506563c26ca63774', transport=TimeoutTransport(timeout=5) )
基础认证(HTTP Basic Auth):
Authorization 头http://user:pass@localhost:8000/RPC2 即可自动携带凭证(注意密码需 URL 编码)处理 bytes 和 datetime:
bytes 会被自动 base64 编码传输,客户端接收后仍是 bytes
datetime.datetime 对象可直接传递,服务端和客户端均能正确识别(前提是双方都用 Python xmlrpc 实现)典型报错:
xmlrpc.client.Fault:服务端抛出异常,错误信息在 faultString 中xmlrpc.client.ProtocolError:HTTP 状态非 200(如 404、500)、响应非 XML 格式ExpatError:服务端返回了非法 XML(常见于日志打印干扰响应体)是否还该用 XML-RPC?
不复杂但容易忽略 —— 把好类型边界、加好超时、打开 introspection,就能稳定跑起来。