api配置

api配置控制着api服务中的各种功能，包含但不限于服务监听地址，端口，环境配置，日志配置等，下面我们从一个简单的配置来看一下api中常用配置分别有什么作用。

配置说明

通过yaml配置我们会发现，有很多参数我们并没有与config对齐，这是因为config定义中，有很多都是带optional或者default 标签的，对于optional可选项，你可以根据自己需求判断是否需要设置，对于default标签，如果你觉得默认值就已经够了，可以不用设置， 一般default中的值基本不用修改，可以认为是最佳实践值。

Config

  1. type Config struct{
  2.     rest.RestConf // rest api配置
  3.     Auth struct { // jwt鉴权配置
  4.         AccessSecret string // jwt密钥
  5.         AccessExpire int64 // 有效期，单位：秒
  6.     }
  7.     Mysql struct { // 数据库配置，除mysql外，可能还有mongo等其他数据库
  8.         DataSource string // mysql链接地址，满足 $user:$password@tcp($ip:$port)/$db?$queries 格式即可
  9.     }
  10.     CacheRedis cache.CacheConf // redis缓存
  11.     UserRpc    zrpc.RpcClientConf // rpc client配置
  12. }

rest.RestConf

api服务基础配置，包含监听地址，监听端口，证书配置，限流，熔断参数，超时参数等控制，对其展开我们可以看到：

  1. service.ServiceConf // service配置
  2. Host     string `json:",default=0.0.0.0"` // http监听ip，默认0.0.0.0
  3. Port     int // http监听端口,必填
  4. CertFile string `json:",optional"` // https证书文件，可选
  5. KeyFile  string `json:",optional"` // https私钥文件，可选 
  6. Verbose  bool   `json:",optional"` // 是否打印详细http请求日志
  7. MaxConns int    `json:",default=10000"` // http同时可接受最大请求数（限流数），默认10000
  8. MaxBytes int64  `json:",default=1048576,range=[0:8388608]"` // http可接受请求的最大ContentLength，默认1048576，被设置值不能必须在0到8388608之间
  9. // milliseconds
  10. Timeout      int64         `json:",default=3000"` // 超时时长控制，单位：毫秒，默认3000
  11. CpuThreshold int64         `json:",default=900,range=[0:1000]"` // cpu降载阈值，默认900，可允许设置范围0到1000
  12. Signature    SignatureConf `json:",optional"` // 签名配置

service.ServiceConf

  1. type ServiceConf struct {
  2.     Name       string // 服务名称
  3.     Log        logx.LogConf // 日志配置
  4.     Mode       string            `json:",default=pro,options=dev|test|pre|pro"` // 服务环境，dev-开发环境，test-测试环境，pre-预发环境，pro-正式环境
  5.     MetricsUrl string            `json:",optional"` // 指标上报接口地址，该地址需要支持post json即可
  6.     Prometheus prometheus.Config `json:",optional"` // prometheus配置
  7. }

logx.LogConf

  1. type LogConf struct {
  2.     ServiceName         string `json:",optional"` // 服务名称
  3.     Mode                string `json:",default=console,options=console|file|volume"` // 日志模式，console-输出到console，file-输出到当前服务器（容器）文件，，volume-输出docker挂在文件内
  4.     Path                string `json:",default=logs"` // 日志存储路径
  5.     Level               string `json:",default=info,options=info|error|severe"` // 日志级别
  6.     Compress            bool   `json:",optional"` // 是否开启gzip压缩
  7.     KeepDays            int    `json:",optional"` // 日志保留天数
  8.     StackCooldownMillis int    `json:",default=100"` // 日志write间隔
  9. }

prometheus.Config

  1. type Config struct {
  2.     Host string `json:",optional"` // prometheus 监听host
  3.     Port int    `json:",default=9101"` // prometheus 监听端口
  4.     Path string `json:",default=/metrics"` // 上报地址
  5. }

SignatureConf

  1. SignatureConf struct {
  2.     Strict      bool          `json:",default=false"` // 是否Strict模式，如果是则PrivateKeys必填
  3.     Expiry      time.Duration `json:",default=1h"` // 有效期，默认1小时
  4.     PrivateKeys []PrivateKeyConf // 签名密钥相关配置
  5. }

PrivateKeyConf

  1. PrivateKeyConf struct {
  2.     Fingerprint string // 指纹配置
  3.     KeyFile     string // 密钥配置
  4. }

cache.CacheConf

  1. ClusterConf []NodeConf
  3. NodeConf struct {
  4.     redis.RedisConf
  5.     Weight int `json:",default=100"` // 权重
  6. }

redis.RedisConf

  1. RedisConf struct {
  2.     Host string // redis地址
  3.     Type string `json:",default=node,options=node|cluster"` // redis类型
  4.     Pass string `json:",optional"` // redis密码
  5. }