RPC API介绍与实现

简介：RPC（Remote Procedure Call，远程过程调用）是一种通信协议，用于使远程计算机之间的程序能够相互调用。与本地调用类似，远程调用的过程是将一个请求发送到远程计算机上，远程计算机执行该请求并将结果返回给本地计算机。RPC常用于构建分布式系统和微服务架构中的服务之间的通信。

RPC的哲学思想可以概括为：

1. 透明性：RPC应该使远程过程调用看起来像本地调用一样简单和透明。调用者不需要了解远程过程调用的细节，只需要像调用本地函数一样调用远程函数。

2. 互操作性：RPC应该支持不同编程语言和不同操作系统之间的相互通信，使得分布式系统可以跨平台和跨语言进行通信。

3. 高效性：RPC应该尽可能地减少网络传输和处理时间，提高系统的性能和吞吐量。

4. 可靠性：RPC应该能够处理网络故障和其他错误，保证系统的可靠性和稳定性。

python代码实现

下面是一个简单的Python代码实现RPC接口的示例，使用了Pyro4库。

安装Pyro4库

pip install pyro4

Pyro4库简介

        Pyro4是一个用于Python语言的分布式对象中间件，它可以让Python对象在分布式环境中进行远程调用，从而实现分布式系统的构建。

        Pyro4提供了很多有用的功能，比如动态对象代理、异步调用、对象序列化等。它支持多种网络协议，包括TCP、Unix域套接字、ZeroMQ等，还提供了可扩展的安全模型，包括基于SSL/TLS的加密、基于密码的身份验证等。

        Pyro4介绍以及用例实现

定义RPC服务接口

# example_service.py
import Pyro4

@Pyro4.expose
class ExampleService(object):
    def say_hello(self, name):
        return "Hello, {}!".format(name)

实现RPC服务

# example_service_server.py
import Pyro4
from example_service import ExampleService

def main():
    example_service = ExampleService()
    daemon = Pyro4.Daemon()
    ns = Pyro4.locateNS()
    uri = daemon.register(example_service)
    ns.register("example.service", uri)
    print("Ready.")
    daemon.requestLoop()

if __name__ == "__main__":
    main()

实现RPC客户端 

# example_service_client.py
import Pyro4

uri = Pyro4.locateNS().lookup("example.service")
example_service = Pyro4.Proxy(uri)

print(example_service.say_hello("John"))

 这个示例实现了一个简单的RPC服务，客户端可以调用服务端的say_hello方法来获取一个问候语。在实际应用中，可以将服务拆分成不同的微服务，使用RPC协议来实现微服务之间的通信。

应用范例，在odoo当中的jsonRPC接口

1、定义一个jsonRPC服务端

# my_module/controllers/main.py
from odoo import http
from odoo.http import JsonRequest, request, Response

class MyController(http.Controller):
    @http.route('/my_module/rpc', type='json', auth='none', csrf=False)
    def my_rpc_method(self, method=None, params=None, id=None):
        if method == 'hello':
            name = params[0]
            return {'result': f'Hello, {name}!'}
        else:
            error = {'code': -32601, 'message': 'Method not found', 'data': {'method': method}}
            return {'error': error, 'id': id}

2、实现一个jsonRPC客户端

# my_module/client.py
import requests
import json

url = "http://localhost:8069/my_module/rpc"

def jsonrpc_request(method, params):
    payload = {'jsonrpc': '2.0', 'method': method, 'params': params, 'id': 1}
    headers = {'Content-type': 'application/json'}
    response = requests.post(url, data=json.dumps(payload), headers=headers)
    if response.status_code == 200:
        result = response.json().get('result')
        if result is not None:
            return result
        else:
            error = response.json().get('error')
            if error is not None:
                raise Exception(f"JSON-RPC error: {error.get('message')}")
    else:
        raise Exception(f"HTTP error: {response.status_code}")

result = jsonrpc_request('hello', ['John'])
print(result)  # output: {'result': 'Hello, John!'}

在上述代码中，my_rpc_method方法是jsonRPC服务端的实现，使用@http.route装饰器将该方法映射为一个HTTP接口。jsonrpc_request方法是jsonRPC客户端的实现，它构造了一个符合jsonRPC协议的HTTP请求，并将请求发送到jsonRPC服务端。客户端通过判断响应的状态码和内容来确定jsonRPC通信的成功与否，并获取结果或抛出异常。

总的来说，Odoo的jsonRPC实现比较简单，主要依赖于Python内置的JSON库和第三方的requests库来实现JSON编解码和HTTP通信功能。