共计 2492 个字符，预计需要花费 7 分钟才能阅读完成。
前言
咱们在写利用时，根本都会用到配置文件，从各种 shell 到 nginx 等，都有本人的配置文件。尽管这没有太多难度，然而配置项个别绝对比拟繁冗，解析、校验也会比拟麻烦。本文就给大家讲讲咱们是怎么简化配置文件的定义和解析的。
场景
如果咱们要写一个 Restful API 的服务，配置项大略有如下内容：
Host，侦听的IP，如果不填，默认用0.0.0.0Port，侦听的端口，必填，只能是数字，大于等于 80，小于 65535LogMode，日志模式，只能选file或者consoleVerbose，看是否输入具体日志，可选，默认为falseMaxConns，容许的最大并发连接数，默认10000Timeout，超时设置，默认3sCpuThreshold，设置CPU使用率触发零碎降载的阈值，默认900，1000m示意100%
之前咱们用 json 做配置文件，然而 json 有个问题，无奈加正文，所以咱们起初切换到了 yaml 格局。
接下来让咱们看看借助 go-zero 怎么来不便的的定义和解析这样的配置文件～
定义配置
首先，咱们须要将上述配置需要定义到 Go 构造体里，如下：
RestfulConf struct {
Host string `json:",default=0.0.0.0"`
Port int `json:",range=[80,65535)"`
LogMode string `json:",options=[file,console]"`
Verbose bool `json:",optional"`
MaxConns int `json:",default=10000"`
Timeout time.Duration `json:",default=3s"`
CpuThreshold int64 `json:",default=900,range=[0:1000]"`
}能够看到，咱们对每个配置项都有肯定的定义和限度，其中一些定义如下：
default，配置没填的话，应用该默认值，能够看到其中的3s会主动解析成time.Duration类型optional，此项能够不配置，没有的话，用类型零值range，限定数字类型，须要在给定的范畴内options，限度配置的值只能是给出的这几个之一
并且，一些属性能够叠加应用，比方：
default和range一起应用，就能够既减少了范畴限度，又提供了默认值default和options一起应用，就能够既减少了可选项限度，又提供了默认值
配置文件
因为咱们在定义配置的时候，给了很多的默认值，还有应用 optional 指定为可选，所以咱们的配置文件里的配置项就绝对比拟少了，能用默认值的就不必写了，如下：
# 因为很多都有默认值，所以只须要写须要指定值和没有默认值的
Port: 8080
LogMode: console
# 能够读取环境变量的值
MaxBytes: ${MAX_BYTES}这里有个留神点，如果配置项的 value 全副是数字，而你定义的配置类型是 string，比方有人测试明码常常用 123456，然而明码个别会定义为 string，配置就要写成如下（只是举个例子哈，明码个别不倡议裸写到配置文件里）：
Password: "123456"这里的双引号不能少，少了会报 type mismatch 之类的谬误，因为 yaml 解析器会把不带双引号的 123456 解析成 int。
加载配置文件
咱们有了配置定义（config.go）和配置文件（config.yaml），接下来就是加载配置文件了，加载配置文件有三种形式：
- 必须加载胜利，否则程序退出，咱们个别这么用，如果配置不对，程序就无奈持续了
// 有谬误间接退出程序
var config RestfulConf
conf.MustLoad("config.yaml", &config)go-zero 自带的 goctl 生成的默认代码也是应用 MustLoad 来加载配置文件的
- 加载配置，并自行判断是否有
error
// 本人判断并解决 error
var config RestfulConf
// 为了更简洁，这里的 LoadConfig 后续会改为 Load，LoadConfig 已被标记为 Deprecated
if err := conf.LoadConfig("config.yaml", &config); err != nil {log.Fatal(err)
}- 加载配置并读取环境变量
// 主动读取环境变量
var config RestfulConf
conf.MustLoad(configFile, &config, conf.UseEnv())这里为啥咱们须要显式指定 conf.UseEnv()，因为如果默认读取的话，可能在配置里大家写特定字符的时候就须要 escape 了，所以默认不读取环境变量，这个设计也欢送大家多提提倡议哈
实现原理
咱们在实现相似 yaml/json 解析的时候个别会间接应用 encoding/json 或者对应的 yaml 库，然而对于 go-zero 来说，咱们须要在 unmarshal 的时候有更准确的管制，这就须要咱们本人定制 yaml/json 的解析了，残缺的代码实现在：
配置文件代码：https://github.com/zeromicro/go-zero/tree/master/core/conf
yaml/json 解析代码：https://github.com/zeromicro/go-zero/tree/master/core/mapping
这里也充沛展现了 reflect 的用法，以及简单场景下如何通过单元测试保障代码的正确性。
总结
我始终比拟举荐 Fail Fast 的思维，咱们在加载配置文件的时候也是这样，一旦有谬误，立马退出，这样运维在部署服务时就会及时发现问题，因为过程压根起不来。
go-zero 的所有服务的配置项都是通过这样的形式来加载和主动验证的，包含我写的很多工具的配置也是基于此来实现的，心愿能对你有所帮忙！
我的项目地址
https://github.com/zeromicro/go-zero
欢送应用 go-zero 并 star 反对咱们！
微信交换群
关注『微服务实际 』公众号并点击 交换群 获取社区群二维码。
