https://github.com/eggjs/egg-rpc-generator
RPC tools for egg framework
https://github.com/eggjs/egg-rpc-generator
eggjs rpc sofa-rpc
Last synced: 2 months ago
JSON representation
RPC tools for egg framework
- Host: GitHub
- URL: https://github.com/eggjs/egg-rpc-generator
- Owner: eggjs
- License: mit
- Created: 2018-06-08T02:56:27.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2023-06-16T13:26:17.000Z (almost 3 years ago)
- Last Synced: 2025-10-08T00:33:55.597Z (6 months ago)
- Topics: eggjs, rpc, sofa-rpc
- Language: JavaScript
- Size: 85 KB
- Stars: 37
- Watchers: 11
- Forks: 5
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# egg-rpc-generator
[![NPM version][npm-image]][npm-url]
[![Test coverage][codecov-image]][codecov-url]
[![npm download][download-image]][download-url]
[npm-image]: https://img.shields.io/npm/v/egg-rpc-generator.svg?style=flat-square
[npm-url]: https://npmjs.org/package/egg-rpc-generator
[codecov-image]: https://img.shields.io/codecov/c/github/eggjs/egg-rpc-generator.svg?style=flat-square
[codecov-url]: https://codecov.io/github/eggjs/egg-rpc-generator?branch=master
[download-image]: https://img.shields.io/npm/dm/egg-rpc-generator.svg?style=flat-square
[download-url]: https://npmjs.org/package/egg-rpc-generator
RPC tools for egg framework
## Install
```bash
$ npm i egg-rpc-generator -g
```
## Usage
### 1. Command-line interface (cli) usage
```bash
$ egg-rpc-generator -h
Usage: egg-rpc-generator [options]
Options:
-b, --base [base] the base directory of the project
-p, --plugin [plugin] the plugins used in generation process
-f, --framework [framework] specify framework that can be absolute path or npm package
-k, --keep-case keeps field casing instead of converting to camel case
-h, --help output usage information
```
- `-b, --base` the egg project root folder, default is `process.cwd()`
- `-p, --plugin` the plugins will be used in generation process, by default `protobuf` plugin will be activated
- `-f, --framework` specify the custom egg framework name or path
- `-k, --keep-case` keeps field casing instead of converting to camel case
run `egg-rpc-generator` under the egg project root folder
```bash
$ egg-rpc-generator
Create /home/admin/project proxy
[ProtoRPCPlugin] found "com.rpc.test.ProtoService" in proto file
[ProtoRPCPlugin] save all proto info into "/home/admin/project/run/proto.json"
------------------------------------------------
All done
```
### 2. Usage with `package.json` scripts
```js
{
"scripts": {
"rpc": "egg-rpc-generator"
}
}
```
Run arbitrary package scripts
```bash
$ npm run rpc
Create /home/admin/project proxy
[ProtoRPCPlugin] found "com.rpc.test.ProtoService" in proto file
[ProtoRPCPlugin] save all proto info into "/home/admin/project/run/proto.json"
------------------------------------------------
All done
```
## Build-in Plugin
### Protobuf Plugin
To generate rpc schema and proxy files from *.proto files
- step 1: put your *.proto files into `$base/proto` folder
```
.
├── app
├── config
│ ├── config.default.js
│ └── proxy.js
├── package.json
└── proto
└── ProtoService.proto
```
`proto/ProtoService.proto`
```proto
syntax = "proto3";
package com.alipay.sofa.rpc.test;
// 可选
option java_multiple_files = false;
service ProtoService {
rpc echoObj (EchoRequest) returns (EchoResponse) {}
}
message EchoRequest {
string name = 1;
Group group = 2;
}
message EchoResponse {
int32 code = 1;
string message = 2;
}
enum Group {
A = 0;
B = 1;
}
```
- step 2: config the config/proxy.js
```js
module.exports = {
group: 'SOFA',
errorAsNull: false,
services: [{
appName: 'pb',
responseTimeout: 100,
api: {
ProtoService: {
interfaceName: 'com.alipay.sofa.rpc.test.ProtoService',
version: '1.0',
method: {
echoObj: {
responseTimeout: 3000,
},
},
},
},
}],
};
```
- step 3: run `egg-rpc-generator` under the project folder
will generate `app/proxy/ProtoService.js` and `run/proto.json`
```bash
.
├── app
│ └── proxy
│ └── ProtoService.js
├── config
│ ├── config.default.js
│ └── proxy.js
├── package.json
├── proto
│ └── ProtoService.proto
└── run
└── proto.json
```
`app/proxy/ProtoService.js`
```js
// Don't modified this file, it's auto created by egg-rpc-generator
'use strict';
const path = require('path');
/* eslint-disable */
/* istanbul ignore next */
module.exports = app => {
const consumer = app.rpcClient.createConsumer({
interfaceName: 'com.alipay.sofa.rpc.test.ProtoService',
targetAppName: 'pb',
version: '1.0',
group: 'SOFA',
proxyName: 'ProtoService',
responseTimeout: 100,
});
if (!consumer) {
// `app.config['pb.rpc.service.enable'] = false` will disable this consumer
return;
}
app.beforeStart(async() => {
await consumer.ready();
});
class ProtoService extends app.Proxy {
constructor(ctx) {
super(ctx, consumer);
}
async echoObj(req) {
return await consumer.invoke('echoObj', [ req ], {
ctx: this.ctx,
responseTimeout: 3000,
});
}
}
return ProtoService;
};
/* eslint-enable */
```
### Jar2Proxy Plugin
To generate rpc proxy from jar.
- step 1: config `config/proxy.js`
Please refer to [jar2proxy configuration](https://github.com/eggjs/jar2proxy#config-configproxyjs) for detail.
- step 2: put jar file into `$app_root/assembly` folder
```bash
.
├── app
├── assembly
│ ├── dubbo-demo-api-1.0-SNAPSHOT-sources.jar
│ ├── dubbo-demo-api-1.0-SNAPSHOT.jar
│ ├── jar2proxy-facade-1.0.0-sources.jar
│ └── jar2proxy-facade-1.0.0.jar
├── config
│ └── proxy.js
└── package.json
```
- step 3: run `egg-rpc-generator` under the project folder
will generate following folders:
- `app/proxy` all proxy files.
- `app/proxy_class` all class definitions
- `app/proxy_enums` all enums definitions
### Jsdoc2Jar
To generator jave interface definitions(jars) from JavaScript comments.
- step 1: config `config/config.default.js`
```js
exports.rpc = {
server: {
namespace: 'com.eggjs.xxx',
// group: 'xxx',
// version: '1.0.0',
// pom: {
// version: '1.0.0',
// groupId: 'com.eggjs.facade',
// artifactId: 'your-artifactId',
// },
},
};
```
- step 2: write rpc service with js comments
```js
// $app_root/rpc/HelloService.js
/**
* say hello
* @param {String} name - user name
* @return {String} hello words
* @rpc
*/
exports.sayHello = async function (name) {
return 'hello ' + name;
};
```
- step 3: run `egg-rpc-generator` under the project folder
will generate:
- `$app_root/src`: java interface definitions source code
- `$app_root/target`: the output of `mvn clean install`
## Write Your Plugin
You can write your own egg-rpc-generator plugin.
- Write a plugin, and publish it to NPM.
```js
module.exports = async (units, { baseDir }) => {
// do something
};
```
- Use plugin:
install plugin from NPM, then use it with egg-rpc-generator:
```
$ egg-rpc-generator -p pluginName1,pluginName2,...
```
## License
[MIT](LICENSE)
## Contributors
|[
gxcsoccer](https://github.com/gxcsoccer)
|[
zhoukk](https://github.com/zhoukk)
|
| :---: | :---: |
This project follows the git-contributor [spec](https://github.com/xudafeng/git-contributor), auto updated at `Fri Jun 16 2023 21:14:08 GMT+0800`.