python實現(xiàn)一個簡單RPC框架的示例
本文需要一點Python socket基礎(chǔ)。
回顧RPC
實現(xiàn)jsonrpc
在實現(xiàn)前,簡單理一下整體思路。
1、Network Service 直接使用Python Socket相關(guān)的API實現(xiàn) 2.傳輸數(shù)據(jù)使用JSON,在Socket層會被壓成二進(jìn)制,我們無需關(guān)心。
模仿xmlrpc,Client與Server都采用Minix多繼承機(jī)制來實現(xiàn),每個類負(fù)責(zé)自身的事情,最終暴露出現(xiàn)的只有一個類中有限的方法。
先從Client端開始實現(xiàn)。
# 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類,然后調(diào)用connect方法鏈接Server端,隨后直接調(diào)用Server端的add方法,該方法的效果就是將傳入的數(shù)據(jù)進(jìn)行累加并將累加的結(jié)果返回,最后將add方法返回的結(jié)果打印出了。
RPCClient類繼承于TCPClient類與RPCStub類。
# rpclient.pyclass RPCClient(TCPClient, RPCStub): pass
其中TCPClient負(fù)責(zé)通過Socket實現(xiàn)TCP鏈接并將數(shù)據(jù)請求過去,而RPCStub類主要將Client端調(diào)用Server端方法的相關(guān)信息打包,然后調(diào)用TCPClient類中的方法發(fā)送則可,兩個類同樣實現(xiàn)在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):’’’將數(shù)據(jù)發(fā)送到Server端’’’self.sock.send(data) def recv(self, length):’’’接受Server端回傳的數(shù)據(jù)’’’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’)) # 發(fā)送數(shù)據(jù) data = self.recv(1024) # 接收方法執(zhí)行后返回的結(jié)果 return data setattr(self, function, _func)return _func
TCPClient類就是常規(guī)的Socket API的操作,無需多言,主要看看RPCStub類。
當(dāng)我們在Client端調(diào)用res = c.add(1, 2, c=3)時,會執(zhí)行RPCStub中的__getattr__方法,該方法會將Client端調(diào)用的方法、參數(shù)等信息通過TCPServer類的send方法發(fā)送,發(fā)送數(shù)據(jù)進(jìn)行了JSON格式化,方便Server端解碼,隨后便調(diào)用recv方法等待Server端相應(yīng)的數(shù)據(jù)返回。
因為RPCClient類本身沒有add方法,為了讓用戶做到Client端直接調(diào)用Server端方法的形式,先利用__getattr__構(gòu)建了_func方法,并將其通過setattr方法設(shè)置到RPCClient類中,此時該類就有Server端方法對應(yīng)的映射了。
調(diào)用add方法,就調(diào)用了對應(yīng)的_func方法,將數(shù)據(jù)發(fā)送至Server端。
Client端就這樣搞定了,接著來實現(xiàn)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) # 傳入要監(jiān)聽的端口
實例化rpcserver.RPCServer類,然后通過register_function方法將想被Client端調(diào)用的方法傳入,隨后調(diào)用loop方法,將要監(jiān)聽的端口傳入,RPCServer類的實現(xiàn)如下。
# rpcserver.py class RPCServer(TCPServer, JSONRPC, RPCStub): def __init__(self):TCPServer.__init__(self)JSONRPC.__init__(self)RPCStub.__init__(self) def loop(self, port):# 循環(huán)監(jiān)聽 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,這些類同樣實現(xiàn)在rpcserver.py文件中并且給出了詳細(xì)的注釋,所以就詳細(xì)解釋了。
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):’’’解析數(shù)據(jù)’’’self.data = json.loads(data.decode(’utf-8’)) def call_method(self, data):’’’解析數(shù)據(jù),調(diào)用對應(yīng)的方法變將該方法執(zhí)行結(jié)果返回’’’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端只可調(diào)用被注冊的方法’’’if name is None: name = function.__name__self.funs[name] = function
至此,Client端和Server端都寫好了。
測試:
以上就是python實現(xiàn)一個簡單RPC框架的示例的詳細(xì)內(nèi)容,更多關(guān)于python 實現(xiàn)RPC框架的資料請關(guān)注好吧啦網(wǎng)其它相關(guān)文章!
相關(guān)文章:
