# egg-grpc-client

**Repository Path**: chufan443/egg-grpc-client

## Basic Information

- **Project Name**: egg-grpc-client
- **Description**: grpc客户端插件，支持在Egg.js框架下连接grpc服务
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-07-21
- **Last Updated**: 2022-07-22

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

## @142vip/egg-grpc-client


#### 可能有用

- 客户端插件：[egg-grpc-client](https://github.com/142vip/egg-grpc-client)
- 服务端插件：[egg-grpc-server](https://github.com/142vip/egg-grpc-server)


#### 支持的功能

- [x] 支持单个grpc-server服务端连接实例
- [x] 支持多个grpc-server服务端连接实例
- [x] 灵活配置app、agent挂载，灵活使用egg.js全局对象
- [x] 详细的日志报警机制,支持日志切割与划分

#### 安装

```bash
## 安装最新版grpc-client插件
npm i @142vip/egg-grpc-client --save
## 安装制定版本grpc-client插件
npm i @142vip/egg-grpc-client@xxx --save
```

#### 快速使用

在plugin.js插件配置文件中配置egg-grpc-client
```js
// {app_root}/config/plugin.js
exports.grpcClient = {
  enable: true,
  package: '@142vip/egg-grpc-client',
};
```

#### 默认配置

```js
// {app_root}/config/config.default.js
exports.grpcClient = {
    // 默认配置，会填充到每个连接实例中
    app: true,
    agent: false,
    // 支持单个grpc-server连接实例
    client: {
      protoDir: 'app/grpc',
      serviceDir: 'app/grpc',
      host: '127.0.0.1',
      port: '50051',
      loaderOptions: {
        keepCase: true,
        longs: String,
        enums: String,
        defaults: true,
        oneofs: true,
      },
    },
    // 支持多个grpc-server连接实例
    clients: {
      gprc_go: {
        protoDir: 'app/grpc',
        serviceDir: 'app/grpc',
        host: '127.0.0.1',
        port: '50051',
        loaderOptions: {
          keepCase: true,
          longs: String,
          enums: String,
          defaults: true,
          oneofs: true,
        },
      },
      grpc_test: {
        protoDir: 'app/grpc',
        serviceDir: 'app/grpc',
        host: '127.0.0.1',
        port: '50051',
        loaderOptions: {
          keepCase: true,
          longs: String,
          enums: String,
          defaults: true,
          oneofs: true,
        },
      },
    },
};
```

更多默认配置，请查看[config/config.default.js](config/config.default.js)

#### 使用示例

```js
// 连接单个grpc server时

ctx.grpcClient.xxx

// 连接多个grpc server用例时
ctx.grpcClient.get('xxx').xxxx

```

完整grpc客户端、服务端插件使用示例，可以参考[egg-grpc-client/example](https://github.com/142vip/egg-grpc-client/example)

#### 证书

```text
MIT License

Copyright (c) 2022 142vip FairySister Rong姐姐好可爱

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
```