grpc

README

gRPC接入Apinto

背景

为了方便用户快速测试apinto的gRPC协议透传功能，本仓库提供gRPC客户端、gRPC服务端简易代码，使用者可按需修改使用。

快速使用

一、启动gRPC服务端

1. 进入到server目录，编译gRPC服务端程序。

   cd server/ && go build -o -o grpcServer
   

2. 启动gRPC服务端程序

   ./grpcServer
   

   当需要绑定证书，启动命令如下：

   ./grpcServer -key 密钥文件路径 -cert 证书文件路径
   

   启动参数说明

   参数名	参数说明
   key	密钥文件路径，文件名称一般以**.key**为后缀
   cert	证书文件路径，文件名称一般以**.crt**、.pem为后缀
   p	监听端口号，默认9001
   Ip	监听IP，默认：0.0.0.0

二、配置gRPC路由

此处使用**Apinto-Dashboard进行配置演示，若为部署Apinto-Dashboard**，可点击**Apinto-Dashboard教程**快速部署使用。

注意：创建路由之前，需要确保已经新建了上游服务，若未新建，可点击**上游服务教程**进一步了解。

1. 进入路由列表页面，点击 "创建"，Driver选择grpc。

   

2. 填写grpc配置，为了方便验证gRPC的不同传输模式的调用情况，方法名在此示例中不填。

   

   字段	说明
   端口号	路由监听端口号，该端口必须是apinto程序的config.yml中已经存在的端口号，详情请点击程序配置说明
   域名	客户端访问网关时请求的域名地址，从gRPC头部 :authority 中获取，路由匹配规则之一
   服务名	gRPC服务名
   方法名	gRPC方法名，不填则默认匹配该服务下的所有方法
   路由规则	可规定客户端请求的头部参数，路由规则说明请参考路由规则
   目标服务	路由匹配成功后，将转发到指定上游服务
   插件模版	插件模版引用
   重试次数	当上游服务连接失败、连接超时时，重新转发的次数
   超时时间	请求上游服务的总时间

至此，路由配置完成

三、启动gRPC客户端

1. 进入到client目录，编译gRPC客户端程序

   cd client/ && go build -o grpcClient
   

2. 启动gRPC客户端程序

   ./grpcClient -addr grpc服务端地址
   

   启动参数说明

   参数名	参数说明
   key	密钥文件路径，文件名称一般以**.key**为后缀
   cert	证书文件路径，文件名称一般以**.crt**、.pem为后缀
   addr	grpc服务端地址，默认：127.0.0.1:8099
   insecure	当连接地址使用tls传输时，是否跳过证书检查
   serverName	当进行TLS证书校验时，使用该值替换域名信息
   authority	服务端主机地址，将会被设置到头部 :authority 中

   示例命令

   ./grpcClient -addr 127.0.0.1:8099
   

   输出消息如下：

   2023/02/16 19:00:08 start current request client,please wait...
   2023/02/16 19:00:08 err: <nil>
   2023/02/16 19:00:08 header: map[content-type:[application/grpc]]
   2023/02/16 19:00:08 trailing: map[app:[apinto]]
   2023/02/16 19:00:08 msg: hello
   2023/02/16 19:00:08 err: <nil>
   2023/02/16 19:00:08 header: map[content-type:[application/grpc]]
   2023/02/16 19:00:08 trailing: map[app:[apinto]]
   2023/02/16 19:00:08 msg: hello
   2023/02/16 19:00:08 end current request
   2023/02/16 19:00:08 start stream request client,please wait...
   2023/02/16 19:00:08 err: <nil>
   2023/02/16 19:00:08 header: map[content-type:[application/grpc]]
   2023/02/16 19:00:08 trailing: map[app:[apinto]]
   2023/02/16 19:00:08 reply apinto
   eolink
   2023/02/16 19:00:08 end stream request
   2023/02/16 19:00:08 start stream response client,please wait...
   2023/02/16 19:00:09 header: map[content-type:[application/grpc]]
   2023/02/16 19:00:09 trailing: map[app:[apinto]]
   2023/02/16 19:00:09 reply map[2023-02-16 19:00:09.127:now is 2023-02-16 19:00:09,name is apinto,eolink]
   2023/02/16 19:00:09 end stream response
   2023/02/16 19:00:09 start all stream client,please wait...
   2023/02/16 19:00:12 header: map[content-type:[application/grpc]]
   2023/02/16 19:00:12 trailing: map[app:[apinto]]
   2023/02/16 19:00:12 reply map[2023-02-16 19:00:09.136:eolink 2023-02-16 19:00:10.130:eolink 2023-02-16 19:00:11.136:eolink 2023-02-16 19:00:12.132:eolink 2023-02-16 19:00:12.137:close stream]
   2023/02/16 19:00:12 end all stream
   

拓展使用

生成grpc调用代码

1. 安装protoc

（1）进入https://github.com/protocolbuffers/protobuf/releases

![](http://data.eolinker.com/course/yG1bRKq7867c7da93fed4e7a814b3e5fd89132b2c09fe31.png)

（2）根据操作系统、架构选择下载对应的安装包，这里以64位的Windows系统为例，选择protoc-22.0-rc-3-win64.zip

1. 安装针对go的protoc插件

   命令后执行下述命令

   go install google.golang.org/protobuf/cmd/protoc-gen-go@latest
   go install google.golang.org/grpc/cmd/protoc-gen-go-grpc@latest
   

2. 执行脚本grpc.sh

   ./grpc.sh
   

运行完成后，grpc代码将会输出到demo_service目录中