JsonRPC

JsonRPC

相比RESTful规范，JsonRPC是更符合后台开发习惯的文本协议，Java代码映射也更加简单。

WeEvent除了少量系统管理功能外，主题的CRUD和事件的订阅发布等都支持JsonRPC协议访问。

协议说明

JsonRPC和RESTful实现的功能和参数都相同，只是不同的承载协议，可以自由选择使用。
WeEvent 使用JsonRPC 2.0 协议规范。
JsonRPC的传输对象使用Jackson库进行序列化。对于字符数组byte[]，Jackson会先使用Base64进行编解码。
调用异常返回的信息BrokerException如下

{
    "jsonrpc": "2.0",
    "id": "1",
    "error": {
        "code": -32001,
        "message": "topic not exist",
        "data": {
            "exceptionTypeName": "com.webank.weevent.broker.sdk.BrokerException",
            "message": "topic not exist"
        }
    }
}

代码样例

public class JsonRPC {
    private final static String groupId = "1";
    private final static Map<String, String> extensions = new HashMap<>();
 
    public static void main(String[] args) {
        System.out.println("This is WeEvent json rpc sample.");
        try {
            URL remote = new URL("http://localhost:8080/weevent/jsonrpc");
            // init jsonrpc client
            JsonRpcHttpClient client = new JsonRpcHttpClient(remote);
            // init IBrokerRpc object
            IBrokerRpc rpc = ProxyUtil.createClientProxy(client.getClass().getClassLoader(), IBrokerRpc.class, client);
            // open topic
            rpc.open("com.weevent.test", groupId);
            // publish event
            SendResult sendResult = rpc.publish("com.weevent.test", groupId, "hello weevent".getBytes(StandardCharsets.UTF_8), extensions);
            System.out.println(sendResult.getStatus());
        } catch (MalformedURLException e) {
            e.printStackTrace();
        } catch (BrokerException e) {
            e.printStackTrace();
        }
    }
}

上述样例演示了使用JsonRPC如何创建主题和发布事件。完整代码，请参见JsonRPC代码样例。

接口说明

JsonRPC接口包括两大类功能：一类是主题Topic的CRUD管理，包括open、close、exist、state、list；一类是事件的发布和订阅，包括publish、subscribe、unsubscribe 。

创建Topic

请求

$ curl -H"Content-Type: application/json" -d'{"id":"1","jsonrpc":"2.0","method":"open","params":{"topic":"com.weevent.test","groupId":"1"}}' http://localhost:8080/weevent/jsonrpc

应答

{
    "jsonrpc": "2.0",
    "id": "1",
    "result": "true"
}

说明
- topic：主题。ascii值在[32,128]之间。支持通配符按层次订阅，因’+’、’#’为通配符的关键字故不能为topic的一部分，详情参见MQTT通配符。
- groupId：群组Id，fisco-bcos 2.0+版本支持多群组功能，2.0以下版本不支持该功能可以不传。

可以重复open，也是返回true

关闭Topic

请求

$ curl -H"Content-Type: application/json" -d'{"id":"1","jsonrpc":"2.0","method":"close","params":{"topic":"com.weevent.test","groupId":"1"}}' http://localhost:8080/weevent/jsonrpc

应答

{
    "jsonrpc": "2.0",
    "id": "1",
    "result": "true"
}

检查Topic是否存在

请求

$ curl -H"Content-Type: application/json" -d'{"id":"1","jsonrpc":"2.0","method":"exist","params":{"topic":"com.weevent.test","groupId":"1"}}' http://localhost:8080/weevent/jsonrpc

应答

{
    "jsonrpc": "2.0",
    "id": "1",
    "result": "true"
}

发布事件

请求

$ curl -H "Content-Type: application/json" -d'{"id":"1","jsonrpc":"2.0","method":"publish","params":{"topic":"com.weevent.test","groupId":"1","content":"MTIzNDU2","extensions":{"weevent-format": "json","userId":"3924261998"}}}' http://localhost:8080/weevent/jsonrpc

应答

{
    "jsonrpc": "2.0",
    "id": "1",
    "result": {
        "topic": "com.weevent.test",
        "status": "SUCCESS",
        "eventId": "10-123"
    }
}

说明：
- content：MTIzNDU2是123456进行Base64编码后的值。
- extensions：用户自定义数据以weevent-开头。可选参数。
- result ：返回字段result ，是一个WeEvent对象的序列化，可查看WeEvent对象。“status”：“SUCCESS”表示成功。”eventId“：”10-123”表示发布事件成功ID。

订阅事件

请求

$ curl -H"Content-Type: application/json" -d'{"id":"1","jsonrpc":"2.0","method":"subscribe","params":{"topic":"com.weevent.test","groupId":"1","subscriptionId":"df68c385-f62d-437f-b32c-669211d51d88","url":"http://localhost:8080/weevent/mock/rest/onEvent"}}' http://localhost:8080/weevent/jsonrpc

应答

{
    "jsonrpc": "2.0",
    "id": "1",
    "result": "df68c385-f62d-437f-b32c-669211d51d88"
}

说明
- topic：主题。ascii值在[32,128]之间。支持通配符按层次订阅，因’+’、’#’为通配符的关键字故不能为topic的一部分，详情参见MQTT通配符。
- url：事件通知回调CGI，当有生产者发布事件时，所有的事件都会通知到这个URL。
- subscriptionId：第一次订阅可以不填。继续上一次订阅subscriptionId为上次订阅ID。
- result：订阅ID。

取消订阅

请求

$ curl -H"Content-Type: application/json" -d'{"id":"1","jsonrpc":"2.0","method":"unSubscribe","params":{"subscriptionId":"c8a600c0-61a7-4077-90f6-3aa39fc9cdd5"}}' http://localhost:8080/weevent/jsonrpc

应答

{
    "jsonrpc": "2.0",
    "id": "1",
    "result": "true"
}

说明
- 如果Broker没有配置Zookeeper模块，该接口无法使用。
- subscriptionId：Subscribe成功订阅后，返回的订阅ID。

获取Event详情

请求

$ curl -H"Content-Type: application/json" -d '{"id":"1","jsonrpc":"2.0","method":"getEvent","params":{"eventId":"2cf24dba-59-1124","groupId":"1"}}' http://localhost:8080/weevent/jsonrpc

应答

{
    "jsonrpc": "2.0",
    "id": "1",
    "result": {
        "topic": "hello",
        "content": "MTIzNDU2",
        "extensions":{"weevent-format":"json"},
        "eventId": "2cf24dba-59-1124"
    }
}

注意以下管理端接口，业务程序里一般用不到，可以直接安装Goverance模块来使用这部分功能。

当前Topic列表

请求

$ curl -H"Content-Type: application/json" -d'{"id":"1","jsonrpc":"2.0","method":"list","params":{"pageIndex":0,"pageSize":10,"groupId":"1"}}' http://localhost:8080/weevent/jsonrpc

应答

{
    "jsonrpc": "2.0",
    "id": "1",
    "result": {
        "total": 51,
        "pageIndex": 1,
        "pageSize": 10,
        "topicInfoList": [
            {
                "topicName": "123456",
                "topicAddress": "0x420f853b49838bd3e9466c85a4cc3428c960dde2",
                "senderAddress": "0x64fa644d2a694681bd6addd6c5e36cccd8dcdde3",
                "createdTimestamp": 1548211117753
            }
        ]
    }
}

说明
- total：Topic的总数量
- pageIndex:：查询第几页，从0开始
- pageSize：分页大小（0,100），默认每页10条数据。
- topicInfoList：Topic 详细信息列表

查询某个Topic详情

请求

$ curl -H"Content-Type: application/json" -d'{"id":"1","jsonrpc":"2.0","method":"state","params":{"topic":"com.weevent.test","groupId":"1"}}' http://localhost:8080/weevent/jsonrpc

应答

{
    "jsonrpc": "2.0",
    "id": "1",
    "result": {
        "topicName": "com.weevent.test",
        "topicAddress": "0x171befab4c1c7e0d33b5c3bd932ce0112d4caecd",
        "senderAddress": "0x64fa644d2a694681bd6addd6c5e36cccd8dcdde3",
        "createdTimestamp": 1548328570965,
        "sequenceNumber": 9,
        "blockNumber": 2475
    }
}

说明
- topicAddress： Topic区块链上的合约地址。
- createdTimestamp：Topic创建的时间。
- sequenceNumber：已发布事件数。
- blockNumber：最新已发布事件的区块高度。