rpc配置控制着一个rpc服务的各种功能，包含但不限于监听地址，etcd配置，超时，熔断配置等，下面我们以一个常见的rpc服务配置来进行说明。

配置说明

  1. Config struct {
  2.     zrpc.RpcServerConf
  3.     CacheRedis         cache.CacheConf // redis缓存配置，详情见api配置说明，这里不赘述
  4.     Mysql struct { // mysql数据库访问配置，详情见api配置说明，这里不赘述
  5.         DataSource string
  6.     }
  7. }

zrpc.RpcServerConf

  1. RpcServerConf struct {
  2.     service.ServiceConf // 服务配置，详情见api配置说明，这里不赘述
  3.     ListenOn      string // rpc监听地址和端口，如：127.0.0.1:8888
  4.     Etcd          discov.EtcdConf    `json:",optional"` // etcd相关配置
  5.     Auth          bool               `json:",optional"` // 是否开启Auth，如果是则Redis为必填
  6.     Redis         redis.RedisKeyConf `json:",optional"` // Auth验证
  7.     StrictControl bool               `json:",optional"` // 是否Strict模式，如果是则遇到错误是Auth失败，否则可以认为成功
  8.     // pending forever is not allowed
  9.     // never set it to 0, if zero, the underlying will set to 2s automatically
  10.     Timeout      int64 `json:",default=2000"` // 超时控制，单位：毫秒
  11.     CpuThreshold int64 `json:",default=900,range=[0:1000]"` cpu降载阈值，默认900，可允许设置范围0到1000
  12. }

discov.EtcdConf

  1. type EtcdConf struct {
  2.     Hosts []string // etcd host数组
  3.     Key   string // rpc注册key
  4. }

redis.RedisKeyConf

  1. RedisConf struct {
  2.     Host string // redis 主机
  3.     Type string `json:",default=node,options=node|cluster"` // redis类型
  4.     Pass string `json:",optional"` // redis密码
  5. }
  7. RedisKeyConf struct {
  8.     RedisConf
  9.     Key string `json:",optional"` // 验证key
  10. }

Rpc示例

配置信息

D:\Projects\Github\NoobWu\go-zero-demo\book\service\user\cmd\rpc\etc\user.yaml

  1. Name: user.rpc
  2. #rpc监听地址和端口，如：127.0.0.1:8888
  3. ListenOn: 127.0.0.1:8080
  4. #etcd相关配置
  5. Etcd:
  6.   #etcd host数组
  7.   Hosts:
  8.   - 127.0.0.1:2379 
  9.   # rpc注册key
  10.   Key: user.rpc
  11. #mysql链接地址，满足 $user:$password@tcp($ip:$port)/$db?$queries 格式即可  
  12. Mysql:
  13.   DataSource: root:123456@tcp(127.0.0.1:3306)/gozero?charset=utf8mb4&parseTime=true&loc=Asia%2FShanghai
  14. #缓存相关设置  
  15. CacheRedis:
  16.   - Host: 127.0.0.1:6379
  17.     Pass:
  18.     Type: node

D:\Projects\Github\NoobWu\go-zero-demo\book\service\user\cmd\rpc\user.go

  1. // Code generated by goctl. DO NOT EDIT!
  2. // Source: user.proto
  4. package main
  6. import (
  7.     "flag"
  8.     "fmt"
  10.     "go-zero-demo/book/service/user/cmd/rpc/internal/config"
  11.     "go-zero-demo/book/service/user/cmd/rpc/internal/server"
  12.     "go-zero-demo/book/service/user/cmd/rpc/internal/svc"
  13.     "go-zero-demo/book/service/user/cmd/rpc/user"
  15.     "github.com/tal-tech/go-zero/core/conf"
  16.     "github.com/tal-tech/go-zero/zrpc"
  17.     "google.golang.org/grpc"
  18. )
  20. var configFile = flag.String("f", "etc/user.yaml", "the config file")
  22. func main() {
  23.     flag.Parse()
  25.     var c config.Config
  26.     conf.MustLoad(*configFile, &c) //读取配置文件信息
  27.     ctx := svc.NewServiceContext(c)
  28.     srv := server.NewUserServer(ctx)
  30.     s := zrpc.MustNewServer(c.RpcServerConf, func(grpcServer *grpc.Server) {
  31.         user.RegisterUserServer(grpcServer, srv)
  32.     })
  33.     defer s.Stop()
  35.     fmt.Printf("Starting rpc server at %s...\n", c.ListenOn)
  36.     s.Start()
  37. }

启动Rpc服务

  1. PS D:\Projects\Github\NoobWu\go-zero-demo\book\service\user\cmd\rpc> go  run .\user.go -f .\etc\user.yaml

image.png
image.png

项目源代码

https://github.com/noobwu/go-zero-demo/tree/master/book/service/user/cmd/rpc

  1. PS D:\Projects\Github\NoobWu\go-zero-demo\book\service\user\cmd\rpc> tree /f
  3. .
  4. │  user.go
  5. │  user.proto       
  6. │  
  7. ├─etc
  8. │      user.yaml    
  9. │      
  10. ├─internal
  11. │  ├─config
  12. │  │      config.go
  13. │  │
  14. │  ├─logic
  15. │  │      getuserlogic.go
  16. │  │
  17. │  ├─server
  18. │  │      userserver.go
  19. │  │
  20. │  └─svc
  21. │          servicecontext.go
  22. │
  23. ├─user
  24. │      user.pb.go
  25. │
  26. └─userclient
  27.         user.go

原文链接

https://go-zero.dev/cn/rpc-config.html