python实现一个简单RPC框架的示例


Posted in Python onOctober 28, 2020

本文需要一点Python socket基础。

回顾RPC

python实现一个简单RPC框架的示例

  • 客户端(Client):服务调用方。
  • 客户端存根(Client Stub):存放服务端地址信息,将客户端的请求参数数据信息打包成网络消息,再通过网络传输发送给服务端。
  • 服务端存根(Server Stub):接收客户端发送过来的请求消息并进行解包,然后再调用本地服务进行处理。
  • 服务端(Server):服务的真正提供者。
  • Network Service:底层传输,可以是 TCP 或 HTTP。

实现jsonrpc

在实现前,简单理一下整体思路。

1、Network Service 直接使用Python Socket相关的API实现 2.传输数据使用JSON,在Socket层会被压成二进制,我们无需关心。

模仿xmlrpc,Client与Server都采用Minix多继承机制来实现,每个类负责自身的事情,最终暴露出现的只有一个类中有限的方法。

先从Client端开始实现。

# client.py

 

import rpcclient

 

c = rpcclient.RPCClient()

c.connect('127.0.0.1', 5000)

res = c.add(1, 2, c=3)

print(f'res: [{res}]')

实例化rpcclient.RPCClient类,然后调用connect方法链接Server端,随后直接调用Server端的add方法,该方法的效果就是将传入的数据进行累加并将累加的结果返回,最后将add方法返回的结果打印出了。

RPCClient类继承于TCPClient类与RPCStub类。

# rpclient.py

class RPCClient(TCPClient, RPCStub):

    pass

其中TCPClient负责通过Socket实现TCP链接并将数据请求过去,而RPCStub类主要将Client端调用Server端方法的相关信息打包,然后调用TCPClient类中的方法发送则可,两个类同样实现在rpclient.py文件中,代码如下。

class TCPClient(object):

    def __init__(self):

        self.sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)

 

    def connect(self, host, port):

        '''链接Server端'''

        self.sock.connect((host, port))

 

    def send(self, data):

        '''将数据发送到Server端'''

        self.sock.send(data)

 

    def recv(self, length):

        '''接受Server端回传的数据'''

        return self.sock.recv(length)

         

 

class RPCStub(object):

    def __getattr__(self, function):

        def _func(*args, **kwargs):

            d = {'method_name': function, 'method_args': args, 'method_kwargs': kwargs}

            self.send(json.dumps(d).encode('utf-8')) # 发送数据

            data = self.recv(1024) # 接收方法执行后返回的结果

            return data

 

        setattr(self, function, _func)

        return _func

TCPClient类就是常规的Socket API的操作,无需多言,主要看看RPCStub类。

当我们在Client端调用res = c.add(1, 2, c=3)时,会执行RPCStub中的__getattr__方法,该方法会将Client端调用的方法、参数等信息通过TCPServer类的send方法发送,发送数据进行了JSON格式化,方便Server端解码,随后便调用recv方法等待Server端相应的数据返回。

因为RPCClient类本身没有add方法,为了让用户做到Client端直接调用Server端方法的形式,先利用__getattr__构建了_func方法,并将其通过setattr方法设置到RPCClient类中,此时该类就有Server端方法对应的映射了。

调用add方法,就调用了对应的_func方法,将数据发送至Server端。

Client端就这样搞定了,接着来实现Server端,不用紧张,非常简单。

Server端的使用方式如下。

# server.py

 

import rpcserver

 

def add(a, b, c=10):

    sum = a + b + c

    return sum

 

s = rpcserver.RPCServer()

s.register_function(add) # 注册方法

s.loop(5000) # 传入要监听的端口

实例化rpcserver.RPCServer类,然后通过register_function方法将想被Client端调用的方法传入,随后调用loop方法,将要监听的端口传入,RPCServer类的实现如下。

# rpcserver.py

 

class RPCServer(TCPServer, JSONRPC, RPCStub):

    def __init__(self):

        TCPServer.__init__(self)

        JSONRPC.__init__(self)

        RPCStub.__init__(self)

 

    def loop(self, port):

        # 循环监听 5000 端口

        self.bind_listen(port)

        print('Server listen 5000 ...')

        while True:

            self.accept_receive_close()

 

    def on_msg(self, data):

        return self.call_method(data)

RPCServer继承自TCPServer、JSONRPC、RPCStub,这些类同样实现在rpcserver.py文件中并且给出了详细的注释,所以就详细解释了。

class TCPServer(object):

    def __init__(self):

        self.sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)

 

    def bind_listen(self, port):

        self.sock.bind(('0.0.0.0', port))

        self.sock.listen(5)

 

    def accept_receive_close(self):

        '''获取Client端信息'''

        (client_socket, address) = self.sock.accept()

        msg = client_socket.recv(1024)

        data = self.on_msg(msg)

        client_socket.sendall(data) # 回传

        client_socket.close()

 

 

class JSONRPC(object):

    def __init__(self):

        self.data = None

 

    def from_data(self, data):

        '''解析数据'''

        self.data = json.loads(data.decode('utf-8'))

 

    def call_method(self, data):

        '''解析数据,调用对应的方法变将该方法执行结果返回'''

        self.from_data(data)

        method_name = self.data['method_name']

        method_args = self.data['method_args']

        method_kwargs = self.data['method_kwargs']

        res = self.funs[method_name](*method_args, **method_kwargs)

        data = {"res": res}

        return json.dumps(data).encode('utf-8')

 

 

class RPCStub(object):

    def __init__(self):

        self.funs = {}

 

    def register_function(self, function, name=None):

        '''Server端方法注册,Client端只可调用被注册的方法'''

        if name is None:

            name = function.__name__

        self.funs[name] = function

至此,Client端和Server端都写好了。

测试:

python实现一个简单RPC框架的示例

以上就是python实现一个简单RPC框架的示例的详细内容,更多关于python 实现RPC框架的资料请关注三水点靠木其它相关文章!

Python 相关文章推荐
Python遍历目录的4种方法实例介绍
Apr 13 Python
Python实现将罗马数字转换成普通阿拉伯数字的方法
Apr 19 Python
python docx 中文字体设置的操作方法
May 08 Python
python中正则表达式与模式匹配
May 07 Python
详解基于python的多张不同宽高图片拼接成大图
Sep 26 Python
pygame实现打字游戏
Feb 19 Python
python中设置超时跳过,超时退出的方式
Dec 13 Python
浅谈spring boot 集成 log4j 解决与logback冲突的问题
Feb 20 Python
python GUI库图形界面开发之PyQt5 MDI(多文档窗口)QMidArea详细使用方法与实例
Mar 05 Python
Python3操作读写CSV文件使用包过程解析
Apr 10 Python
Python 使用Opencv实现目标检测与识别的示例代码
Sep 08 Python
Python list和str互转的实现示例
Nov 16 Python
pycharm永久激活超详细教程
Oct 29 #Python
linux mint中搜狗输入法导致pycharm卡死的问题
Oct 28 #Python
浅谈Python __init__.py的作用
Oct 28 #Python
详解Selenium-webdriver绕开反爬虫机制的4种方法
Oct 28 #Python
详解Python流程控制语句
Oct 28 #Python
详解selenium + chromedriver 被反爬的解决方法
Oct 28 #Python
手把手教你从PyCharm安装到激活(最新激活码),亲测有效可激活至2089年
Nov 25 #Python
You might like
浅谈PHP安全防护之Web攻击
2017/01/03 PHP
深入理解PHP的远程多会话调试
2017/09/21 PHP
Laravel 解决419错误 -ajax请求错误的问题(CSRF验证)
2019/10/25 PHP
非常不错的功能强大代码简单的管理菜单美化版
2008/07/09 Javascript
Ext 表单布局实例代码
2009/04/30 Javascript
一组JS创建和操作表格的函数集合
2009/05/07 Javascript
浅谈javascript中的instanceof和typeof
2015/02/27 Javascript
js实现从中间开始往上下展开网页窗口的方法
2015/03/02 Javascript
基于javascript实现页面加载loading效果
2020/09/15 Javascript
利用jQuery插件imgAreaSelect实现图片上传裁剪(同步显示图像位置信息)
2016/12/02 Javascript
教你一步步用jQyery实现轮播器
2016/12/18 Javascript
基于JavaScript实现窗口拖动效果
2017/01/18 Javascript
vue2.0项目中使用Ueditor富文本编辑器示例代码
2017/08/14 Javascript
Node.js中Bootstrap-table的两种分页的实现方法
2017/09/18 Javascript
浅析Node.js非对称加密方法
2018/01/29 Javascript
解决vue A对象赋值给B对象,修改B属性会影响到A的问题
2018/09/25 Javascript
JavaScript ES6中的简写语法总结与使用技巧
2018/12/30 Javascript
Vue.js实现大转盘抽奖总结及实现思路
2019/10/09 Javascript
Javascript confirm多种使用方法解析
2020/09/25 Javascript
python使用PyFetion来发送短信的例子
2014/04/22 Python
Python读写/追加excel文件Demo分享
2018/05/03 Python
python3实现字符串的全排列的方法(无重复字符)
2018/07/07 Python
Python图像处理之简单画板实现方法示例
2018/08/30 Python
python RC4加密操作示例【测试可用】
2019/09/26 Python
Jupyter打开图形界面并画出正弦函数图像实例
2020/04/24 Python
Java ExcutorService优雅关闭方式解析
2020/05/30 Python
Python包和模块的分发详细介绍
2020/06/19 Python
如何在python中判断变量的类型
2020/07/29 Python
python 利用matplotlib在3D空间绘制二次抛物面的案例
2021/02/06 Python
小学中秋节活动方案
2014/02/06 职场文书
小学家长评语大全
2014/04/16 职场文书
教师三严三实心得体会
2014/10/11 职场文书
学校纪律作风整改措施思想汇报
2014/10/11 职场文书
学习党的群众路线教育实践活动剖析材料
2014/10/13 职场文书
工作时间证明
2015/06/15 职场文书
Vue如何实现组件间通信
2021/05/15 Vue.js