讀取Go項(xiàng)目中的配置文件的方法

第讀取Go項(xiàng)目中的配置文件的方法目錄來(lái)看看gonfig是怎么解決這個(gè)問(wèn)題的約定根據(jù)項(xiàng)目定制化配置文件原理篇Go語(yǔ)言提供了很簡(jiǎn)便的讀取json和yaml文件的api，我們可以很輕松將一個(gè)json或者yaml文件轉(zhuǎn)換成Go的結(jié)構(gòu)體，但是如果直接在項(xiàng)目中讀取配置文件，這種方式并不夠好。缺點(diǎn)如下：

實(shí)際開(kāi)發(fā)中配置項(xiàng)在不同環(huán)境下，配置的值是不同的

上面的問(wèn)題可以通過(guò)不同的配置文件去決定在那個(gè)環(huán)境讀取那個(gè)配置文件，但是還有一個(gè)問(wèn)題就是實(shí)際開(kāi)發(fā)中，配置項(xiàng)有些是相同的，有些是不同的，如果配置文件有一個(gè)主配置文件，里面存放的是不同環(huán)境相同的配置項(xiàng)，還有一個(gè)跟隨環(huán)境的配置文件，里面存放的是不同環(huán)境的配置項(xiàng)，然后讀取兩個(gè)配置文件后，做一個(gè)merge，這樣得到的結(jié)果就是總共的配置項(xiàng)信息。

有些配置項(xiàng)是必填的，有些配置項(xiàng)的值是一些特殊的值，比如,郵箱,手機(jī)號(hào)，IP信息等

來(lái)看看gonfig是怎么解決這個(gè)問(wèn)題的

安裝gonfig

goget/xiao-ren-wu/gonfig

項(xiàng)目中新建配置目錄，并編寫對(duì)應(yīng)配置文件，在配置目錄同級(jí)目錄添加讀取配置文件的go文件

conf.yaml文件中存放的是通用的配置，conf-{{active}}.yaml中存放不同環(huán)境不同的配置信息。

conf

|-conf.yaml

|-conf-dev.yaml

|-conf-prod.yaml

|config.go

利用go:embed將配置文件載入到內(nèi)存，調(diào)用gonfig.Unmarshal讀取配置文件

packageconfig

import(

"model"

"/xiao-ren-wu/gonfig"

"embed"

//go:embed*.yaml

varconfDirembed.FS

//我們配置文件的配置struct

typeAppConfstruct{

AppNamestring`yaml:"app-name"json:"app-name"`

DBDBConf`yaml:"db"json:"db"`

typeDBConfstruct{

Usernamestring`yaml:"username"json:"username"`

Passwordstring`yaml:"password"json:"password"`

varconfConf

funcInit(){

iferr:=gonfig.Unmarshal(confDir,conf);err!=nil{

panic(err)

funcGetConf()*Conf{

returnconf

}

這樣就完成了項(xiàng)目中配置文件的讀取，是不是很簡(jiǎn)單？此時(shí)讀到的配置形式是conf-{{profile}}.yaml和conf.yaml的總和，如果conf-{{profile}}.yaml中定義的屬性和conf.yaml相同，那么會(huì)以conf-{{profile}}.yaml為準(zhǔn)

約定

gonfigAPI的簡(jiǎn)潔性的原因是因?yàn)楸澈笞隽撕芏嗉s束，只有符合約束的配置才能被成功讀取，具體的約束條件如下：

gonfig.Unmarshal會(huì)默認(rèn)讀取文件名稱有前綴conf的文件

通過(guò)環(huán)境變量profile作為環(huán)境名稱，如果沒(méi)有配置，默認(rèn)dev。

程序會(huì)尋找conf.yaml作為主配置文件，conf-{{profile}}.yaml作為環(huán)境特有配置文件，然后對(duì)文件內(nèi)容進(jìn)行合并

如果conf-{{profile}}.yaml中的屬性和conf.yaml中屬性都有定義，那么會(huì)以conf-{{profile}}.yaml為準(zhǔn)。

根據(jù)項(xiàng)目定制化配置文件

gonfig.Unmarshal的函數(shù)簽名funcUnmarshal(confDirReadFileDir,vinterface{},ops...Option)error提供很多配置項(xiàng)，供用戶定制化需求，具體的配置信息如下：

更改配置文件名稱前綴FilePrefix(prefixstring)

更改讀取配置文件類型UnmarshalWith(uTypeUnmarshalType)

更改讀取的環(huán)境變量名稱ProfileUseEnv(envName,defaultProfilestring)

自定義設(shè)置profileProfileFunc(ffunc()string)

原理篇

gonfig的實(shí)現(xiàn)也很簡(jiǎn)單，核心的源碼如下：

funcUnmarshal(confDirReadFileDir,vinterface{},ops...Option)error{

ifv!=nilreflect.ValueOf(v).Kind()!=reflect.Ptr{

returngonfig_error.ErrNonPointerArgument

varcs=confStruct{

confPrefix:"conf",

envName:"profile",

defaultEnvValue:"dev",

unmarshalType:Yaml,

cs.activeProfileFunc=func()string{

returngetActiveProfile(cs.envName,cs.defaultEnvValue)

for_,op:=rangeops{

op(cs)

fileActive=cs.activeProfileFunc()

iferr:=loadConf(confDir,cs);err!=nil{

returnerr

//copyval

v1:=reflect.New(reflect.TypeOf(v).Elem()).Interface()

iferr:=fileUnmarshal(cs.activeConfRaw,v1,cs.unmarshalType);err!=nil{

returnerr

iflen(cs.masterConfRaw)==0{

returngonfig_error.MasterProfileConfNotSetError

iferr:=fileUnmarshal(cs.masterConfRaw,v,cs.unmarshalType);err!=nil{

returnerr

returnmergo.Merge(v,v1,mergo.WithOverride)

}

大概的原理就是復(fù)制了一份用戶傳給函