Android RPC

前言

RPC是一个请求响应模型,客户端发起请求,服务器返回响应。

JSON-RPC是一个无状态且轻量级的远程过程调用(RPC)协议。 本规范主要定义了一些数据结构及其相关的处理规则。它允许运行在基于socket,http等诸多不同消息传输环境的同一进程中。其使用JSONRFC 4627)作为数据格式。

JSON-RPC就和HTTP、webservice类似的一个协议。他的请求和返回结果都是有一定规范的。


JSON-RPC请求

jsonrpc: 指定JSON-RPC的版本,必须设置为2.0
id: 调用标识符,用于标示一次远程调用过程,值必须包含一个字符串、数值。
method: 所要调用方法名称的字符串
params: 方法传入的参数,若无参数则传入空[]

JSON-RPC响应

jsonrpc: 指定JSON-RPC的版本,固定为为2.0
id: 调用标识符,用于标示一次远程调用过程,值必须包含一个字符串、数值。
result: 如果调用成功则显示响应结果
error: 如果调用失败则显示错误的信息,error带有以下几个字段
code: 错误类型,必须为整数 【必须】
message: 错误的简单描述字,该描述应尽量简短 【必须】
data: 包含关于错误附加信息的基本类型或结构化类型 【可选】

可以看看jsonrpc2.0的中文文档http://wiki.geekdream.com/Specification/json-rpc_2.0.html


jsonrpc4j

jsonrpc4j为 Java 编程语言提供轻松实现 JSON-RPC 的工具。 jsonrpc4j 使用 Jackson 库将 java 对象与 json 对象(以及与 JSON-RPC 相关的其他内容)相互转换。

他大概的作用就是接受InputStream \ OutputStream或者HttpServletRequest \ HttpServletResponse,将其中的json数据按照JSON-RPC协议解析,然后调用对应的类方法。

jsonrpc4j提供了客户端和服务端的封装,也非常好的支持了spring框架。但是由于是在Android中我们不使用spring。使用spring和不使用在它的git上都提供了例子。


jsonrpc4j + NanoHttpd

我们直接在上一章的代码中加入jsonrpc4j 的代码


public class MyServer extends NanoHTTPD {
    private Context mContext;
    private final static int PORT = 33445;
    public final static String TAG = "SharkChilli";
    private final JsonRpcServer jrs;

    public MyServer(Context context) throws IOException {
        super(PORT);
        this.mContext = context;
        start();

        jrs = new JsonRpcServer(new ObjectMapper(), new TestService(context), TestService.class);

        Log.i(TAG, "MyServer start");
    }

    @Override
    public Response serve(IHTTPSession session) {
        //打印请求数据
        Log.i(TAG, "serve uri: " + session.getUri());
        Log.i(TAG, "serve getQueryParameterString: " + session.getQueryParameterString());
        Log.i(TAG, "serve getRemoteHostName: " + session.getRemoteHostName());
        Log.i(TAG, "serve getRemoteIpAddress: " + session.getRemoteIpAddress());
        session.getHeaders().forEach((key, val) -> {
            Log.i(TAG, key + " : " + val);
        });

        InputStream inputStream = session.getInputStream();
        ByteArrayOutputStream outputStream = new ByteArrayOutputStream();

        try {
            jrs.handleRequest(inputStream, outputStream);

            return newFixedLengthResponse(Response.Status.OK, "application/json",
                    new ByteArrayInputStream(outputStream.toByteArray()), outputStream.size());
        } catch (Exception exception) {
            return newFixedLengthResponse(Response.Status.INTERNAL_ERROR, MIME_PLAINTEXT, "Internal Server Error!!!");
        }

    }
}
  1. 在创建服务类的时候我们初始化了一个JsonRpcServer实例,并且将我们的TestService注册进去。这样这个实例处理jsonrpc的时候就会调用这个TestService实例对应的方法

  2. 在serve方法中我们调用了JsonRpcServer实例的handleRequest,传入了输入输出流,其实就是协议的参数和处理后的结果。最后将outputStream的内容通过NanoHttpd返回。


TestService.java

package com.shark.service;

import android.app.Activity;
import android.content.Context;
import android.util.Log;
import android.widget.Toast;

public class TestService {
    public final static String TAG = "SharkChilli";
    private Context mContext;


    public TestService(Context context) {
        mContext = context;
    }

    public String sayHello() {
        Activity activity = (Activity) mContext;
        activity.runOnUiThread(() -> {
            Toast.makeText(mContext, "远程调用成功", Toast.LENGTH_LONG).show();

        });
        Log.i(TAG, "sayHello: ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------");
        return "ok";
    }
}

至此jsonrpc4j的服务端代码就编写完成了。在项目运行在手机上后只要访问符合JsonRpc2.0的协议就可以调用到对应的方法。所以你直接用postman或者编写一个java程序都可以调用成功。

python jsonrpc

其实你可以直接用jsonrpc4j的JsonRpcHttpClient类就可以调用了,但是我这里使用了python所以安装了一个模块jsonrpcclient,在python3 pyjsonrpc不好使了啊。如果用的的我到时候考虑封装一个吧!

from jsonrpcclient import request

response = request("http://192.168.124.2:33445/", "sayHello")
print(response.text)

结果

{"jsonrpc":"2.0","id":1,"result":"ok"}
image.png

参考

RPC、JSON-RPC和HTTP区别

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 194,088评论 5 459
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 81,715评论 2 371
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 141,361评论 0 319
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 52,099评论 1 263
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 60,987评论 4 355
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 46,063评论 1 272
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,486评论 3 381
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,175评论 0 253
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,440评论 1 290
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,518评论 2 309
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,305评论 1 326
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,190评论 3 312
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 37,550评论 3 298
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 28,880评论 0 17
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,152评论 1 250
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 41,451评论 2 341
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 40,637评论 2 335

推荐阅读更多精彩内容