XML-RPC是一种基于XML的远程过程调用协议,Python标准库中的xmlrpc模块提供了完整的实现,无需安装额外依赖就能快速搭建XML-RPC服务端和客户端,适合轻量级的跨进程、跨机器通信场景。

xmlrpc库的核心组件
xmlrpc库主要包含两个核心子模块,分别用于实现服务端和客户端:
- xmlrpc.server:提供XML-RPC服务端相关类,支持单线程和多线程服务模式
- xmlrpc.client:提供XML-RPC客户端相关类,用于向服务端发起远程调用请求
实现XML-RPC服务端
服务端的核心逻辑是注册可被远程调用的方法,然后启动服务监听指定端口。下面是一个基础的服务端示例,实现了两个简单的远程方法:
from xmlrpc.server import SimpleXMLRPCServer
# 定义可被远程调用的方法
def add(a, b):
"""两个数相加"""
return a + b
def get_user_info(user_id):
"""根据用户ID获取用户信息"""
user_dict = {
1: {"name": "张三", "age": 25},
2: {"name": "李四", "age": 30}
}
return user_dict.get(user_id, {})
# 创建服务端实例,绑定本地8000端口
server = SimpleXMLRPCServer(("127.0.0.1", 8000))
# 注册远程方法
server.register_function(add, "add")
server.register_function(get_user_info, "get_user_info")
print("XML-RPC服务端已启动,监听127.0.0.1:8000")
# 启动服务,持续监听请求
server.serve_forever()
如果需要支持多线程处理并发请求,可以使用SimpleXMLRPCServer的多线程版本:
from xmlrpc.server import SimpleXMLRPCServer
from socketserver import ThreadingMixIn
# 定义多线程混合类
class ThreadingXMLRPCServer(ThreadingMixIn, SimpleXMLRPCServer):
pass
def multiply(a, b):
return a * b
server = ThreadingXMLRPCServer(("127.0.0.1", 8000))
server.register_function(multiply, "multiply")
server.serve_forever()
实现XML-RPC客户端
客户端的实现非常简单,只需要创建ServerProxy对象,指向服务端的地址,就可以直接调用服务端注册的远程方法:
from xmlrpc.client import ServerProxy
# 创建客户端代理,指向服务端地址
client = ServerProxy("http://127.0.0.1:8000")
# 调用远程方法add
result1 = client.add(3, 5)
print(f"3 + 5 = {result1}")
# 调用远程方法get_user_info
result2 = client.get_user_info(1)
print(f"用户ID为1的信息:{result2}")
# 调用多线程服务端的multiply方法
result3 = client.multiply(4, 6)
print(f"4 * 6 = {result3}")
常见使用注意事项
参数和返回值的类型限制
XML-RPC协议支持的基础类型包括:整数、浮点数、字符串、布尔值、数组、结构体(对应Python的字典)、日期时间、二进制数据。不支持自定义类、函数等复杂类型,传递复杂数据时需要先转换为支持的基础类型。
异常处理
当远程调用出现异常时,客户端会收到Fault异常,需要进行捕获处理:
from xmlrpc.client import ServerProxy, Fault
client = ServerProxy("http://127.0.0.1:8000")
try:
# 调用不存在的远程方法
client.not_exist_method()
except Fault as e:
print(f"远程调用失败,错误码:{e.faultCode},错误信息:{e.faultString}")
except Exception as e:
print(f"其他异常:{e}")
二进制数据传输
如果需要传递二进制数据(比如文件内容),可以使用xmlrpc.client.Binary类型:
# 服务端注册二进制处理方法
def save_file(file_data, filename):
with open(filename, "wb") as f:
f.write(file_data.data)
return True
# 客户端传递二进制数据
from xmlrpc.client import Binary
client = ServerProxy("http://127.0.0.1:8000")
with open("test.txt", "rb") as f:
file_binary = Binary(f.read())
result = client.save_file(file_binary, "received.txt")
print(f"文件保存结果:{result}")