Android RPC

时间:2021-7-21 作者:qvyue

前言

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

JSON-RPC是一个无状态且轻量级的远程过程调用(RPC)协议。 本规范主要定义了一些数据结构及其相关的处理规则。它允许运行在基于socket,http等诸多不同消息传输环境的同一进程中。其使用JSON(RFC 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"}
Android RPC
image.png

参考

RPC、JSON-RPC和HTTP区别

声明:本文内容由互联网用户自发贡献自行上传,本网站不拥有所有权,未作人工编辑处理,也不承担相关法律责任。如果您发现有涉嫌版权的内容,欢迎发送邮件至:qvyue@qq.com 进行举报,并提供相关证据,工作人员会在5个工作日内联系你,一经查实,本站将立刻删除涉嫌侵权内容。