什么是 RPC
全称是Remote Procedure Call,远程过程调用。直观的理解就是,通过网络来请求服务,不用知晓底层网络协议的细节。
RPC支持的格式很多,比如XML格式,JSON格式等等。
这种介绍,一般都是皮毛,去看维基百科上的介绍会更加深入一些:
在分布式计算中,远程过程调用就是当计算机程序运行过程中导致一个子进程在不同的地址空间运行,通常是另一台电脑,通过网络共享地址空间。这时候,这个子进程就像是在自己的电脑上运行的一样,不用编程者显式处理 编码 细节,毕竟进程运行在别的电脑了嘛。
这其实就是C/S架构的交互形式,发起调用的是客户端,执行子进程的是服务端。一般来说,这种实现是通过请求-响应的消息传递机制。
另外,RPC也是IPC的一种形式。所谓IPC是指Inter-Process Communication,进程间通信。
什么是 JSON -RPC
JSON是一种轻量级的数据交换格式,它可以表示数值、 字符串 、序列及名/值对集合。
JSON-RPC是一种无状态的,轻量级的远程程序调用协议。
如何使用JSON-RPC
JSON-RPC协议中的客户端一般是为了向远程系统请求执行某个方法。客户端向实现了JSON-RPC协议的服务端发送请求,多个输入参数能够通过数组或者对象传递到远程方法,这个远程方法也能返回多个输出数据,具体是什么,当然要看具体的方法实现。
所有的传输都是单个对象,用JSON格式进行序列化。请求包含三个特定属性:
method,方法,是等待调用的远程方法名,字符串类型
params,参数,对象类型或者是数组,向远程方法传递的多个参数值
id,任意类型值,用于和最后的响应进行匹配,也就是这里设定多少,后面响应里这个值也设定为相同的
响应的接收者必须能够给出所有请求以正确的响应。响应也有三个属性:
result,结果,是方法的返回值,如果方法执行时出现了错误,那么这个值必须为空
error,错误,当出现错误时,返回一个特定的错误编码,没有错误就为空值
id,就是请求带的那个id值,用于匹配
需要注意到,有一些场景下,是不用返回值的,比如只对客户端进行通知,由于不用对请求的id进行匹配,所以这个id就是不必要的,置空或者直接不要了。
技术简介
json-rpc是基于json的跨语言远程调用协议,比xml-rpc、webservice等基于文本的协议传输数据格小;相对hessian、 Java -rpc等二进制协议便于调试、实现、扩展,是非常优秀的一种远程调用协议。目前主流语言都已有json-rpc的实现框架,java语言中较好的json-rpc实现框架有jsonrpc4j、jpoxy、json-rpc。三者之中json rpc 4j既可独立使用,又可与spring无缝集合,比较适合于基于spring的项目开发。
一、JSON-RPC协议描述
json-rpc协议非常简单,发起远程调用时向服务端传输数据格式如下:
{ “method”: “sayHello”, “params”: [“Hello JSON-RPC”], “id”: 1}
参数说明:
method: 调用的方法名
params: 方法传入的参数,若无参数则传入 []
id : 调用标识符,用于标示一次远程调用过程
服务器其收到调用请求,处理方法调用,将方法效用结果效应给调用方;返回数据格式:
{
“result”: “Hello JSON-RPC”,
“error”: null,
“id”: 1
}
参数说明:
result: 方法返回值,若无返回值,则返回null。若调用错误,返回null。
error :调用时错误,无错误返回null。
id : 调用标识符,与调用方传入的标识符一致。
以上就是json-rpc协议规范,非常简单,小巧,便于各种语言实现。
二、JSON-RPC简单示例
2.1、服务器端Java调用示例
jsonrpc4j服务器端java示例:
public class HelloWorldServlet extends HttpServlet {
private static final long serialVersionUID = 3638336826344504848L;
private JsonRpcServer rpcService = null;
@ Override
public void init(ServletConfig config) throws ServletException {
super.init(config);
rpcService = new JsonRpcServer(new HelloWorldService(), HelloWorldService.class);
}
@Override
protected void service(HttpServletRequest req, HttpServletResponse resp)
throws ServletException, IOException {
rpcService.handle(req, resp);
}
}
2.2、Java客户端调用示例
jsonrpc4j的Java客户端调用示例:
JsonRpcHttpClient client = new JsonRpcHttpClient( new URL("")); Map<String,String> headers = new HashMap<String,String>(); headers.put("name", "剑白"); client.setHeaders(headers); String properties = client.invoke("getSystemProperties", null, String.class); System.out.println(properties);
2.3、PHP客户端调用示例
基于json-rpc-php的PHP客户端调用示例:
<?php include(dirname(__FILE__)."/lib/client/JsonRpcClient.php"); $client = new JsonRpcClient(""); $response = $client->getSystemProperties(); echo $response->result; ?>
2.3、JavaScript客户端调用示例
基于jsonrpcjs的JavaScript客户端调用示例:
var rpc = new jsonrpc.JsonRpc(' rpc.call('getSystemProperties', function(result){ alert(result); });
2.4、直接GET请求进行调用
无需任何客户端,只需手工拼接参数进行远程调用,请求URL如下:
参数说明:
method : 方法名
params :调用参数,json的数组格式[], 将参数需先进行url编码,再进行base64编码
id : 调用标识符,任意值。
三、JSON-RPC总结
json-rpc是一种非常轻量级的跨语言远程调用协议,实现及使用简单。仅需几十行代码,即可实现一个远程调用的客户端,方便语言扩展客户端的实现。服务器端有php、java、python、ruby、.net等语言实现,是非常不错的及轻量级的远程调用协议。
参考文档