服务配置

概述

本文介绍如何使用 go-zero 框架进行 gRPC Client 的开发。

配置

  1. type RpcClientConf struct {
  2.     Etcd          discov.EtcdConf `json:",optional,inherit"`
  3.     Endpoints     []string        `json:",optional"`
  4.     Target        string          `json:",optional"`
  5.     App           string          `json:",optional"`
  6.     Token         string          `json:",optional"`
  7.     NonBlock      bool            `json:",optional"`
  8.     Timeout       int64           `json:",default=2000"`
  9.     KeepaliveTime time.Duration   `json:",default=20s"`
  10.     Middlewares   ClientMiddlewaresConf
  11. }
  13. type EtcdConf struct {
  14.     Hosts              []string
  15.     Key                string
  16.     ID                 int64  `json:",optional"`
  17.     User               string `json:",optional"`
  18.     Pass               string `json:",optional"`
  19.     CertFile           string `json:",optional"`
  20.     CertKeyFile        string `json:",optional=CertFile"`
  21.     CACertFile         string `json:",optional=CertFile"`
  22.     InsecureSkipVerify bool   `json:",optional"`
  23. }
  25. type ServerMiddlewaresConf struct {
  26.     Trace      bool `json:",default=true"`
  27.     Recover    bool `json:",default=true"`
  28.     Stat       bool `json:",default=true"`
  29.     Prometheus bool `json:",default=true"`
  30.     Breaker    bool `json:",default=true"`
  31. }

RpcClientConf

名称类型含义默认值是否必选
EtcdEtcdConf服务发现配置，当需要使用 etcd 做服务发现时配置无否
Endpointsstring 类型数组RPC Server 地址列表，用于直连，当需要直连 rpc server 集群时配置无否
Targetstring域名解析地址，名称规则请参考 https://github.com/grpc/grpc/blob/master/doc/naming.md无否
Appstringrpc 认证的 app 名称，仅当 rpc server 开启认证时配置无否
Tokenstringrpc 认证的 token，仅当 rpc server 开启认证时配置无否
NonBlockbool是否阻塞模式,当值为 true 时，不会阻塞 rpc 链接false否
Timeoutint64超时时间2000ms否
KeepaliveTimeTime.Duration保活时间20s否
MiddlewaresClientMiddlewaresConf是否启用中间件无否

EtcdConf

EtcdConf 为服务发现配置，当需要使用 etcd 做服务发现时配置。

名称类型含义默认值是否必选
Hostsstring 类型数组etcd 集群地址无是
Keystring服务发现 key无是
IDint64etcd 租户 id无否
Userstringetcd 用户名无否
Passstringetcd 密码无否
CertFilestringetcd 证书文件CertFile否
CertKeyFilestringetcd 证书私钥文件无否
CACertFilestringetcd 证书根文件CertFile否
InsecureSkipVerifybooletcd 是否跳过证书验证无否

ServerMiddlewaresConf

ServerMiddlewaresConf 为中间件配置，当需要控制中间件时配置。

名称类型含义默认值是否必选
Tracebool是否开启链路追踪true否
Recoverbool是否开启异常恢复true否
Statbool是否开启统计true否
Prometheusbool是否开启 prometheustrue否
Breakerbool是否开启熔断true否