egg-rpc

实现在 egg 中使用 rpc, 遵循 JSON-RPC 2.0 Specification

安装插件

npm install --save egg-rpc

开启插件

// config/plugin.js

exports.eggRpc = {
  enable: true,
  package: 'egg-rpc',
};

开启插件后，RPC 会暴露一个 http 地址： http://你的 egg 程序地址/rpc.endpoint，如 http://localhost:7001/rpc.endpoint.

编写 rpc

所有的 rpc 文件都必须放到 app/rpc 目录下，可以支持多级目录，访问的时候可以通过目录名级联访问，如有一个文件，其存放在 app/rpc/operation/user.js 目录下，可通过 operation.user.method 进行访问。每个文件代表一个 rpc 的类。

rpc 类

一个类下可以暴露多个 rpc 方法，例如：

const RPC = require('egg-rpc').RPC;

export default class Operation extends RPC { 
  * sum({a,b}){
    if(!_.isNumber(a) || !_.isNumber(b)){
      this.fail(-327001,'输入参数 a,b 必须为数字.');
      return;
    } 
    // 调用 egg 服务
    let randomNum = this.service.Operation.getRadomNum();
    let result = a + b + randomNum; 
    // 输出正确结果
    this.success(result);
  } 

  * substract({a,b}){
    let result = a - b;
    return result;
  }
}

rpc 方法

每个方法都由三部份组成，方法名、输入参数、输出。

输入参数：通过 es6 的解构获取。

输出：调用 rpc context 下提供的三个方法：

this.success(result)：成功返回到客户端。
this.fail(code, message, data): 返回失败到客户端，code 为错误码，message 为返回错误的信息, data 用于告诉客户端具体的错误信息。
this.throw(err, code, message): 返回异常到客户端，error 为 javascript Error 对象，code 为错误码，message 为返回错误的信息。

在方法体内调用 service

直接通过 this.service 访问，例如：this.service.User.add()

客户端调用

通过 axios 或 request 库进行请求，地址为: http://你的 egg 程序地址/rpc.endpoint。发送如下的请求体:

{"jsonrpc": "2.0", "method": "Operation.sum", "params": {"a": 23, "b": 42}, "id": 3}

例如：

axios.post('http://localhost:7001/rpc.endpoint', {
  "jsonrpc": "2.0",
  "method": "Operation.sum",
  "params": {
    "a": 23,
    "b": 42
  },
  "id": 3
})
  .then(function (result) {
    console.log(result);
  })
  .catch(function (error) {
    console.log(error);
  });

Contributors(1)

Ordered by date of first contribution.

@国勇

evilbs / egg-rpc