# README

grpc客户端组件
快速开始
配置文件
- 最少配置设置
- 完整配置说明
请求负载均衡
- hashKey 设置方式
- 目标选择
注册器
- static

grpc客户端组件

提供用于 https://github.com/zly-app/zapp 的组件

快速开始

创建一个项目

mkdir client && cd client
go mod init client

添加 hello/hello.proto 文件

syntax = 'proto3';
package hello; // 决定proto引用路径和rpc路由
option go_package = "server/hello/hello"; // 用于对golang包管理的定位

service helloService{
   rpc Say(SayReq) returns (SayResp);
}

message SayReq{
   string msg = 1;
}
message SayResp{
   string msg = 1;
}

编译 proto

protoc \
--go_out=. --go_opt=paths=source_relative \
--go-grpc_out=. --go-grpc_opt=paths=source_relative \
hello/hello.proto

添加 main.go 文件

package main

import (
	"context"

	"github.com/zly-app/zapp"

	"github.com/zly-app/grpc"
	"github.com/zly-app/grpc/example/pb/hello"
)

func main() {
	app := zapp.NewApp("grpc-client")
	defer app.Exit()

	helloClient := hello.NewHelloServiceClient(grpc.GetClientConn("hello")) // 获取客户端. 每次请求都应该尽量重新获取客户端

	// 调用
	resp, err := helloClient.Say(context.Background(), &hello.SayReq{Msg: "hello"})
	if err != nil {
		app.Fatal(resp)
	}
	app.Info("收到结果", resp.GetMsg())
}

运行

go mod tidy && go run .

配置文件

添加配置文件 configs/default.yaml.

最少配置设置

components:
   grpc:
      hello: # 客户端名
         Address: localhost:3000 # 链接地址

完整配置说明

components:
   grpc:
      hello: # 服务名
         Address: localhost:3000 # 服务地址, 参考 https://github.com/zly-app/grpc/tree/master/discover
         Balance: weight_consistent_hash # 均衡器, 支持 round_robin, weight_random, weight_hash, weight_consistent_hash
         WaitFirstConn: true # 初始化时等待第一个链接
         MinIdle: 2 # 最小闲置
         MaxIdle: 4 # 最大闲置
         MaxActive: 10 # 最大活跃连接数, 小于1表示不限制
         BatchIncrement: 4 # 批次增量, 当conn不够时, 一次性最多申请多少个链接
         BatchShrink: 4 # 批次缩容, 当conn太多时(超过最大闲置), 一次性最多释放多少个链接
         IdleTimeout: 3600 # 空闲链接超时时间, 单位秒, 如果一个连接长时间未使用将被视为连接无效, 小于1表示永不超时
         WaitTimeout: 5 # 等待获取连接的超时时间, 单位秒
         MaxWaitConnCount: 2000 # 最大等待conn的数量, 小于1表示不限制
         ConnectTimeout: 5 # 连接超时, 单位秒
         MaxConnLifetime: 3600 # 一个连接最大存活时间, 单位秒, 小于1表示不限制
         CheckIdleInterval: 5 # 检查空闲间隔, 单位秒
         ProxyAddress: "" # 代理地址. 支持 socks5, socks5h. 示例: socks5://127.0.0.1:1080 socks5://127.0.0.1:1080 socks5://user:[email protected]:1080
         TLSCertFile: "" # tls公钥文件路径
         TLSDomain: "" # tls签发域名