FISCO搭建开放服务网关

2023-10-25

改造官方的SDK，搭建开放服务平台，支持appId调用，支持代理上链。

总述

FISCO官方的SDK，一般使用都是连接一条链，然后通过SDK构造签名交易，jni发送到链上。jni的RPC连接一般项目启动的时候就初始化好，后续直接调用发送交易。

理解了官方的SDK使用后，现在就需要改造这个SDK设计出一个开放服务网关。

这个开放服务网关，支持申请appId，支持appId鉴权，支持appId余额扣费，支持代理上链。

正常的调用是这样的：构造交易 -> rpc请求 -> 上链 -> 获取结果。

那怎么改造呢？

把rpc请求切开，切成两份，在两份中间是不是就可以增加其他业务程序呢？如appId的鉴权扣费等。切开的两份，前一份获取到最终的上链参数，HTTP方式转发到两份中间。在中间，执行appId鉴权扣费，同时接收最终的上链参数。后一份，拿到最终的上链参数，通过jni连接，把交易发送到链上。这样是不是就实现了简单的开放服务网关呢。其中，前一份需要在客户端实现，作为一个项目存在。中间和后一份需要放在网关实现，可以在一个项目里，也可以拆分为两个项目，本文是设计在一个项目里。

然后调用顺序就是这样的：
构造交易 -> HTTP发送交易到网关 -> 网关鉴权扣费 -> rpc请求链 -> 上链 -> 网关获取结果 -> 客户端获取结果。

这里面，

构造交易不改变，还是使用SDK进行交易构造。不过这个SDK是经过改造的SDK，非官方原生SDK。但构造交易的方法不改变。
改造客户端SDK，实现HTTP转发rpc参数到网关。官方SDK需要注销Jni的初始化连接，禁止直接连接链。同时，把最终发送rpc交易参数的rpc方式修改为HTTP方式，实现直接转发到网关。这样，客户端只需要引入特定的SDK，配置一下网关和appId等，就可以把最终需要上链的rpc参数和网关相关参数转发到网关。
网关Nginx代理设计。网关配置Nginx前置代理，设置路由规则，不用的子链使用不同的请求后缀，这个后缀建议为链的群组名。通过路由，转发到不同的SpringBoot单体应用，每个应用单独对接一条链。这种既保证了性能，又方便扩展。如果需要增加一条链，就再启动一个SpringBoot应用，Nginx增加配置规则。
网关appId前置业务设计。appId模式是开放服务接口调用基本的设计，通过appId等参数校验请求的合法性，实现余额充值与扣减，实现第三方服务的调用。
网关上链后置业务设计。每一条子链对应一个SpringBoot应用，对于上链部分，应用会收到最终的rpc参数，这个参数可以通过rpc方式直接发送到链上的。所以后置业务需要做的就是接受客户端发出的rpc参数，转发到链上即可。
返回结果。返回结果到客户端需要两次，一次是网关接受上链的结果，一次是网关把上链结果返回给客户端。

改造SDK

configOption增加网关配置，支持配置文件注入网关信息。
注释jni初始化连接，应用可以不连接链启动，且禁止连接链。
修改callRemoteMethod方法，修改为HTTP请求转发到网关。

public <T extends JsonRpcResponse<?>> T callRemoteHttpMethod(
        String groupID, String node, JsonRpcRequest<?> request, Class<T> responseType) {
    try {

        // 调用网关服务
        String urlString = configOption.getGateway().get("url").toString();
        String data = this.objectMapper.writeValueAsString(request);
        // 当前时间戳
        long timeStamp = System.currentTimeMillis();
        String result =
                HttpRequest.post(urlString)
                        .header("appId", configOption.getGateway().get("appId").toString())
                        .header("timeStamp", String.valueOf(timeStamp))
                        .header(
                                "sign",
                                AppMd5.generateSign(
                                        configOption.getGateway().get("appId").toString(),
                                        configOption.getGateway().get("appSecret").toString(),
                                        String.valueOf(timeStamp)))
                        .timeout(60000)
                        .body(data)
                        .execute()
                        .body();

        // 判断请求结果是否返回自定义异常
        // result转json对象
      	// 网关请求发生异常，json中的id为-1
        JSONObject jsonObject = JSONUtil.parseObj(result);
        if (jsonObject.getInt("id").equals(-1)) {
            // 自定义业务异常，直接抛出
            throw new ClientException(
                    jsonObject.getInt("id"),
                    jsonObject.getStr("error"),
                    jsonObject.getStr("error"));
        }

        return new Gson().fromJson(result, responseType);
    } catch (ClientException e) {
        throw new ClientException(
                e.getErrorCode(),
                e.getErrorMessage(),
                "callRemoteHttpMethod failed for decode the message exception, error message:"
                        + e.getMessage());
    } catch (JsonProcessingException e) {
        logger.error("e: ", e);
        throw new ClientException(
                "callRemoteHttpMethod failed for decode the message exception, error message:"
                        + e.getMessage(),
                e);
    } catch (Exception e) {
        logger.error("e: ", e);
        throw new ClientException(
                "callRemoteHttpMethod failed, error message:" + e.getMessage(), e);
    }
}

参考代码：https://gitee.com/yegetaier/bcos-sdk-3.3.0

网关对接链

网关SpringBoot应用接收改造SDK请求的rpc参数。

@PostMapping("/proxy")
public Object proxy(
        @VerifyAuthentication @ApiIgnore AuthenticationDto authentication,
        @RequestBody String body) {
    return proxyService.call(authentication, body);
}

SpringBoot应用使用官方SDK初始化项目，直接jni连接到链。
转发层实现，直接转发rpc参数上链。

@Override
public Object call(AuthenticationDto authentication, String body) {

    // 打印body
    log.warn("body: {}", body);

    // 解析body为JSON对象
    JSONObject jsonObject = JSON.parseObject(body);

    // 判断是否有method字段
    if (!jsonObject.containsKey("method")) {
        return Result.create(
                jsonObject.getString("id"),
                jsonObject.getString("jsonrpc"),
                null,
                "缺少method字段");
    }
    // 获取method字段
    String method = jsonObject.getString("method");

    // 判断是否有params字段
    if (!jsonObject.containsKey("params")) {
        return Result.create(
                jsonObject.getString("id"),
                jsonObject.getString("jsonrpc"),
                null,
                "缺少params字段");
    }
    // 获取params字段
    JSONArray params = (JSONArray) JSON.parse(jsonObject.getString("params"));

    // 根据方法名调用对应的方法
    switch (method) {
        case GET_BLOCK_NUMBER:
            // 调用getBlockNumber方法
            return client.getBlockNumber();

        case GET_BLOCK_BY_HASH:
            // 调用getBlockByHash方法
            return client.getBlockByHash(
                    params.getString(1),
                    params.getString(2),
                    params.getBoolean(3),
                    params.getBoolean(4));

        case GET_BLOCK_BY_NUMBER:
            // 调用getBlockByNumber方法
            return client.getBlockByNumber(
                    params.getString(1),
                    params.getBigInteger(2),
                    params.getBoolean(3),
                    params.getBoolean(4));

        case GET_TRANSACTION_BY_HASH:
            // 调用getTransactionByHash方法
            return client.getTransaction(
                    params.getString(1), params.getString(2), params.getBoolean(3));

        case GET_TRANSACTION_RECEIPT:
            // 调用getTransactionReceipt方法
            return client.getTransactionReceipt(
                    params.getString(1), params.getString(2), params.getBoolean(3));

        case CALL:
            // 调用call方法
            return client.call(
                    params.getString(1),
                    new Transaction(
                            null, params.getString(2), Hex.decode(params.getString(3))));

        case SEND_TRANSACTION:
            // 调用sendTransaction方法
        		// 这个方法需要扣费，为上链写方法
            return client.sendTransaction(
                        params.getString(1), params.getString(2), params.getBoolean(3));

        default:
            return Result.create(
                    jsonObject.getString("id"), jsonObject.getString("jsonrpc"), null, "未知方法");
    }
}