快捷導(dǎo)航

Go微服務(wù)項(xiàng)目配置文件的定義和讀取示例詳解

更新時(shí)間：2022年06月21日 09:42:15 作者：萬(wàn)俊峰Kevin

這篇文章主要為大家介紹了Go微服務(wù)項(xiàng)目配置文件的定義和讀取示例詳解，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進(jìn)步，早日升職加薪

前言

我們?cè)趯憫?yīng)用時(shí)，基本都會(huì)用到配置文件，從各種 shell 到 nginx 等，都有自己的配置文件。雖然這沒(méi)有太多難度，但是配置項(xiàng)一般相對(duì)比較繁雜，解析、校驗(yàn)也會(huì)比較麻煩。本文就給大家講講我們是怎么簡(jiǎn)化配置文件的定義和解析的。

場(chǎng)景

如果我們要寫一個(gè) Restful API 的服務(wù)，配置項(xiàng)大概有如下內(nèi)容：

Host，偵聽(tīng)的 IP，如果不填，默認(rèn)用 0.0.0.0
Port，偵聽(tīng)的端口，必填，只能是數(shù)字，大于等于80，小于65535
LogMode，日志模式，只能選 file 或者 console
Verbose，看是否輸出詳細(xì)日志，可選，默認(rèn)為 false
MaxConns，允許的最大并發(fā)連接數(shù)，默認(rèn) 10000
Timeout，超時(shí)設(shè)置，默認(rèn) 3s
CpuThreshold，設(shè)置 CPU 使用率觸發(fā)系統(tǒng)降載的閾值，默認(rèn) 900，1000m 表示 100%

之前我們用 json 做配置文件，但是 json 有個(gè)問(wèn)題，無(wú)法加注釋，所以我們后來(lái)切換到了 yaml 格式。

接下來(lái)讓我們看看借助 go-zero 怎么來(lái)方便的的定義和解析這樣的配置文件～

定義配置

首先，我們需要將上述配置需求定義到 Go 結(jié)構(gòu)體里，如下：

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]"`
}

可以看到，我們對(duì)每個(gè)配置項(xiàng)都有一定的定義和限制，其中一些定義如下：

default，配置沒(méi)填的話，使用該默認(rèn)值，可以看到其中的 3s 會(huì)自動(dòng)解析成 time.Duration 類型
optional，此項(xiàng)可以不配置，沒(méi)有的話，用類型零值
range，限定數(shù)字類型，需要在給定的范圍內(nèi)
options，限制配置的值只能是給出的這幾個(gè)之一

并且，一些屬性可以疊加使用，比如：

default 和 range 一起使用，就可以既增加了范圍限制，又提供了默認(rèn)值
default 和 options 一起使用，就可以既增加了可選項(xiàng)限制，又提供了默認(rèn)值

配置文件

因?yàn)槲覀冊(cè)诙x配置的時(shí)候，給了很多的默認(rèn)值，還有使用 optional 指定為可選，所以我們的配置文件里的配置項(xiàng)就相對(duì)比較少了，能用默認(rèn)值的就不用寫了，如下：

# 因?yàn)楹芏喽加心J(rèn)值，所以只需要寫需要指定值和沒(méi)有默認(rèn)值的
Port: 8080
LogMode: console
# 可以讀取環(huán)境變量的值
MaxBytes: ${MAX_BYTES}

這里有個(gè)注意點(diǎn)，如果配置項(xiàng)的 value 全部是數(shù)字，而你定義的配置類型是 string，比如有人測(cè)試密碼經(jīng)常用 123456，但是密碼一般會(huì)定義為 string，配置就要寫成如下（只是舉個(gè)例子哈，密碼一般不建議裸寫到配置文件里）：

Password: "123456"

這里的雙引號(hào)不能少，少了會(huì)報(bào) type mismatch 之類的錯(cuò)誤，因?yàn)閥aml解析器會(huì)把不帶雙引號(hào)的 123456 解析成 int。

加載配置文件

我們有了配置定義（config.go）和配置文件（config.yaml），接下來(lái)就是加載配置文件了，加載配置文件有三種方式：

必須加載成功，否則程序退出，我們一般這么用，如果配置不對(duì)，程序就無(wú)法繼續(xù)了

// 有錯(cuò)誤直接退出程序
var config RestfulConf
conf.MustLoad("config.yaml", &config)

go-zero 自帶的 goctl 生成的默認(rèn)代碼也是使用 MustLoad 來(lái)加載配置文件的

加載配置，并自行判斷是否有 error

// 自己判斷并處理 error
var config RestfulConf
// 為了更簡(jiǎn)潔，這里的 LoadConfig 后續(xù)會(huì)改為 Load，LoadConfig 已被標(biāo)記為 Deprecated
if err := conf.LoadConfig("config.yaml", &config); err != nil {
    log.Fatal(err)
}

加載配置并讀取環(huán)境變量

// 自動(dòng)讀取環(huán)境變量
var config RestfulConf
conf.MustLoad(configFile, &config, conf.UseEnv())

這里為啥我們需要顯式指定 conf.UseEnv()，因?yàn)槿绻J(rèn)讀取的話，可能在配置里大家寫特定字符的時(shí)候就需要 escape 了，所以默認(rèn)不讀取環(huán)境變量，這個(gè)設(shè)計(jì)也歡迎大家多提提建議哈

實(shí)現(xiàn)原理

我們?cè)趯?shí)現(xiàn)類似 yaml/json 解析的時(shí)候一般會(huì)直接使用 encoding/json 或者對(duì)應(yīng)的 yaml 庫(kù)，但是對(duì)于 go-zero 來(lái)說(shuō)，我們需要在 unmarshal 的時(shí)候有更精確的控制，這就需要我們自己定制 yaml/json 的解析了，完整的代碼實(shí)現(xiàn)在：

配置文件代碼：github.com/zeromicro/g…

yaml/json 解析代碼：github.com/zeromicro/g…

這里也充分展示了 reflect 的用法，以及復(fù)雜場(chǎng)景下如何通過(guò)單元測(cè)試保證代碼的正確性。