Python3简单使用xmlrpc实现RPC

# _*_ coding:utf-8 _*_from xmlrpc.server import SimpleXMLRPCServer# 调用函数
def respon_string(str):return "get string:%s"%strif __name__ &＃61;&＃61; &＃39;__main__&＃39;:server &＃61; SimpleXMLRPCServer((&＃39;localhost&＃39;, 8888)) # 初始化server.register_function(respon_string, "get_string") # 注册函数print ("Listening for Client")server.serve_forever() # 保持等待调用状态


可以看到&＃xff0c;代码中就实现了上面说的几点。register_function用于注册一个供调用的函数&＃xff0c;第一个参数为自己实现的方法名&＃xff0c;第二个参数为供客户端调用的方法名。

简单的客户端

客户端要做的就更少了&＃xff1a;根据url和端口号初始化一个服务器对象&＃xff0c;然后调用需要的方法即可&＃xff1a;

# _*_ coding:utf-8 _*_from xmlrpc.client import ServerProxyif __name__ &＃61;&＃61; &＃39;__main__&＃39;:server &＃61; ServerProxy("http://localhost:8888") # 初始化服务器print (server.get_string("cloudox")) # 调用函数并传参


这时候我们用两个终端来跑服务端和客户端&＃xff0c;就可以看到效果了&＃xff1a;

服务端启动并保持监听

客户端远程调用了多次

从图中可以看到&＃xff0c;服务器每次被访问都会打印出访问来源。而客户端访问后&＃xff0c;会远程调用在服务端运行的函数具体实现。

多线程访问

上面的方法只能供单线程访问&＃xff0c;但大多数情况下都需要支持多线程&＃xff0c;该怎么处理呢&＃xff1f;很简单&＃xff0c;只需要更改一下服务端即可&＃xff1a;

# _*_ coding:utf-8 _*_from xmlrpc.server import SimpleXMLRPCServer
from socketserver import ThreadingMixInclass ThreadXMLRPCServer(ThreadingMixIn, SimpleXMLRPCServer):pass# 调用函数1
def respon_string(str):return "get string:%s"%str# 调用函数2
def add(x, y):return x &＃43; yif __name__ &＃61;&＃61; &＃39;__main__&＃39;:server &＃61; ThreadXMLRPCServer((&＃39;localhost&＃39;, 8888)) # 初始化server.register_function(respon_string, "get_string") # 注册函数1server.register_function(add, &＃39;add&＃39;) # 注册函数2print ("Listening for Client")server.serve_forever() # 保持等待调用状态


代码中我们初始化服务器用的不再是SimpleXMLRPCServer了&＃xff0c;而是自定义的一个类&＃xff0c;继承自两个基类&＃xff0c;ThreadingMixIn使其能够支持多线程&＃xff0c;其余的操作方式还是和普通的一样。并且我们新增了一个函数&＃xff0c;接受两个参数&＃xff0c;计算和&＃xff0c;可以看到无论参数数量多少&＃xff0c;我们注册函数的时候都只写函数名。

客户端代码如下&＃xff1a;

# _*_ coding:utf-8 _*_from xmlrpc.client import ServerProxyif __name__ &＃61;&＃61; &＃39;__main__&＃39;:server &＃61; ServerProxy("http://localhost:8888") # 初始化服务器print (server.get_string("cloudox")) # 调用函数1并传参print (server.add(8, 8)) # 调用函数2并传参


客户端调用两个函数的结果

多线程的效果这里没法展示&＃xff0c;不过两个函数的调用都成功了。

文件上传&下载

RPC除了传参以外还可以在客户端与服务器之间传输文件——客户端既可以从服务器下载文件&＃xff0c;也可以上传文件到服务器。

传输文件要用到xmlrpc.client.Binary这个库&＃xff0c;如果要实现从服务器下载文件的功能&＃xff0c;那么服务器端也需要导入这个库&＃xff0c;即使它名义上属于client库。

传输文件的基本步骤是&＃xff1a;

• 用open打开一个文件&＃xff08;没有的话会创建&＃xff09;&＃xff0c;确定是读权限还是写权限&＃xff1b;
• 在文件发送端通过调用xmlrpc.client.Binary来进行文件的传输&＃xff0c;接收端通过值.data来获取内容&＃xff08;详见代码&＃xff09;&＃xff1b;
• 关闭文件。

服务器&＃xff1a;

# _*_ coding:utf-8 _*_from xmlrpc.server import SimpleXMLRPCServer
from socketserver import ThreadingMixIn
import xmlrpc.clientclass ThreadXMLRPCServer(ThreadingMixIn, SimpleXMLRPCServer):pass# 供客户端下载文件
def image_get():handle &＃61; open("boy.jpg", &＃39;rb&＃39;)return xmlrpc.client.Binary(handle.read())# 供客户端上传文件
def image_put(data):handle &＃61; open("get_girl.jpg", &＃39;wb&＃39;)handle.write(data.data)handle.close()if __name__ &＃61;&＃61; &＃39;__main__&＃39;:server &＃61; ThreadXMLRPCServer((&＃39;localhost&＃39;, 8888), allow_none&＃61;True) # 初始化server.register_function(image_put, &＃39;image_put&＃39;)server.register_function(image_get, &＃39;image_get&＃39;)print ("Listening for Client")server.serve_forever() # 保持等待调用状态


代码中初始化服务器时多了个参数allow_none&＃61;True&＃xff0c;这是允许不返回参数给客户端&＃xff0c;因为文件上传的函数都是没有返回值的&＃xff0c;不设置这个参数会报错&＃xff0c;实际上这里也应该返回一个值告诉客户端是否上传成功。

文件上传的代码中可以看到&＃xff0c;写入的是data.data&＃xff0c;单单data是会报错的&＃xff0c;因为实际上要写入的是Binary.data&＃xff0c;这在下面的客户端代码下载文件时也会看到。

客户端&＃xff1a;

from xmlrpc.client import ServerProxy
import xmlrpc.clientif __name__ &＃61;&＃61; &＃39;__main__&＃39;:server &＃61; ServerProxy("http://localhost:8888", allow_none&＃61;True)# 上传文件put_handle &＃61; open("girl.jpg", &＃39;rb&＃39;)server.image_put(xmlrpc.client.Binary(put_handle.read()))put_handle.close()# 下载文件get_handle &＃61; open("get_boy.jpg", &＃39;wb&＃39;)get_handle.write(server.image_get().data)get_handle.close()


可以看到&＃xff0c;下载文件时写入的也是获取到的返回值.data&＃xff0c;而不是返回值本身&＃xff0c;这个一定要注意。

可以查看一下代码目录&＃xff0c;会发现文件传输&＃xff08;上传&下载都在一个目录下&＃xff09;成功了&＃xff1a;

文件传输结果

注&＃xff1a;原始情况下&＃xff0c;只有 boy.jpg 和 girl.jpg 两个文件。

结

以上&＃xff0c;就是Python3使用xmlrpc的方式了&＃xff0c;可以看到&＃xff0c;确实很简单的可以实现远程调用&＃xff0c;虽然这里都在一台机器上&＃xff0c;不过要支持远程只需要改变IP就可以了。这比搭建一个WEB后台服务器要简单多了&＃xff0c;如果只是要实现简单的函数调用&＃xff0c;用RPC会节省不少功夫。

这里是我的代码&＃xff1a;https://github.com/Cloudox/PythonRPCStudy