Go 項目配置文件的定義和讀取

前言

我們在寫應用時，基本都會用到配置文件，從各種 shell 到 nginx 等，都有自己的配置文件。雖然這沒有太多難度，但是配置項一般相對比較繁雜，解析、校驗也會比較麻煩。本文就給大家講講我們是怎麼簡化配置文件的定義和解析的。

場景

如果我們要寫一個 Restful API 的服務，配置項大概有如下內容：

• Host，偵聽的 IP，如果不填，默認用 0.0.0.0
• Port，偵聽的端口，必填，只能是數字，大於等於80，小於65535
• LogMode，日誌模式，只能選 file 或者 console
• Verbose，看是否輸出詳細日誌，可選，默認爲 false
• MaxConns，允許的最大併發連接數，默認 10000
• Timeout，超時設置，默認 3s
• CpuThreshold，設置 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 支持我們！

微信交流羣

關注『微服務實踐』公衆號並點擊 交流羣 獲取社區羣二維碼。

如果你有 go-zero 的使用心得文章，或者源碼學習筆記，歡迎通過公衆號聯繫投稿！