在現(xiàn)代軟件開(kāi)發(fā)中，配置文件是不可或缺的一部分。在編寫(xiě) Go 項(xiàng)目時(shí)，不管是一個(gè)簡(jiǎn)單的單文件腳本還是一個(gè)龐大的微服務(wù)項(xiàng)目，程序的靈活性和可擴(kuò)展性都需要依賴(lài)于配置文件的加載。配置文件可以包含程序的各種設(shè)置，如端口號(hào)、數(shù)據(jù)庫(kù)連接信息、認(rèn)證密鑰等，這些設(shè)置可能需要根據(jù)不同的環(huán)境和部署情況進(jìn)行調(diào)整。因此，一個(gè)可靠的配置文件加載機(jī)制對(duì)于項(xiàng)目的成功實(shí)現(xiàn)至關(guān)重要。本文就來(lái)探究下在 Go 項(xiàng)目中如何更加方便的加載和管理配置。

在 Go 中，有很多方法可以加載和管理配置，例如使用命令行標(biāo)志、環(huán)境變量或者讀取特定格式的文件。選擇哪種方法取決于項(xiàng)目的具體需求和開(kāi)發(fā)人員的偏好。

需求

根據(jù)我的開(kāi)發(fā)經(jīng)驗(yàn)，一個(gè)配置包通常需要支持如下功能：

• 支持從環(huán)境變量、命令行標(biāo)志加載配置文件，然后將配置文件內(nèi)容映射到 Go 結(jié)構(gòu)體中，這個(gè)過(guò)程叫作反序列化。

• 支持將 Go 結(jié)構(gòu)體中的配置信息寫(xiě)入配置文件，這個(gè)過(guò)程叫作序列化。

• 起碼要支持 YAML、JSON 這兩種最常見(jiàn)的配置文件格式。

config 包實(shí)現(xiàn)

反序列化

反序列化操作是配置包最常用的功能，通過(guò)反序列化我們可以將配置文件內(nèi)容映射到 Go 結(jié)構(gòu)體中。所以我們先來(lái)實(shí)現(xiàn)如何進(jìn)行配置文件的反序列化操作。

type FileType int

const (
	FileTypeYAML = iota
	FileTypeJSON
)

func LoadConfig(filename string, cfg interface{}, typ FileType) error {
	data, err := os.ReadFile(filename)
	if err != nil {
		return fmt.Errorf("ReadFile: %v", err)
	}
	switch typ {
	case FileTypeYAML:
		return yaml.Unmarshal(data, cfg)
	case FileTypeJSON:
		return json.Unmarshal(data, cfg)
	}
	return errors.New("unsupported file type")
}

首先定義一個(gè) FileType 類(lèi)型，用來(lái)區(qū)分不同的配置文件格式，我們要實(shí)現(xiàn)的日志包能夠支持 YAML 和 JSON 兩種格式。

接下來(lái)實(shí)現(xiàn)了 LoadConfig 函數(shù)，用來(lái)加載配置，它接收三個(gè)參數(shù)：配置文件名稱(chēng)、配置結(jié)構(gòu)體、文件類(lèi)型。

在函數(shù)內(nèi)部，首先使用 os.ReadFile(filename) 讀取配置文件內(nèi)容，然后根據(jù)文件類(lèi)型，使用不同的方法來(lái)反序列化，最終將配置信息映射到 cfg 結(jié)構(gòu)體中。

序列化

配置包還要支持序列化操作，也就是將配置信息從內(nèi)存中寫(xiě)入文件。有時(shí)候我們想保存一個(gè) example-config.yaml 供項(xiàng)目使用者參考，這個(gè)功能就很實(shí)用。

func DumpConfig(filename string, cfg interface{}, typ FileType) error {
	var (
		data []byte
		err  error
	)
	switch typ {
	case FileTypeYAML:
		data, err = yaml.Marshal(cfg)
	case FileTypeJSON:
		data, err = json.Marshal(cfg)
	}
	if err != nil {
		return err
	}
	f, err := os.Create(filename)
	if err != nil {
		return err
	}
	_, err = f.Write(data)
	_ = f.Close()
	return err
}

我們實(shí)現(xiàn)了 DumpConfig 函數(shù)用來(lái)進(jìn)行序列化操作，該函數(shù)同樣接收三個(gè)參數(shù)：配置文件名、配置結(jié)構(gòu)體、文件類(lèi)型。

在函數(shù)中，首先根據(jù)文件類(lèi)型對(duì)配置對(duì)象 cfg 進(jìn)行序列化操作得到 data，然后通過(guò) os.Create(filename) 創(chuàng)建配置文件文件，最后使用 f.Write(data) 將序列化后的內(nèi)容寫(xiě)入文件。

現(xiàn)在配置包的核心功能已經(jīng)實(shí)現(xiàn)了，并且兩個(gè)函數(shù)都被允許導(dǎo)出，如果其他項(xiàng)目想使用，其實(shí)是可以拿過(guò)去直接使用的。不過(guò)目前的配置包在易用性上還有可優(yōu)化的空間。

通過(guò)環(huán)境變量/命令行參數(shù)指定配置文件

以上序列化/反序列化函數(shù)的實(shí)現(xiàn)，配置文件名都是需要通過(guò)參數(shù)傳遞進(jìn)來(lái)的，我們還可以通過(guò)環(huán)境變量或者命令行參數(shù)的形式來(lái)指定配置文件名。

var (
	cfgPath = flag.String("c", "config.yaml", "path to config file")
	dump    = flag.Bool("d", false, "dump config to file")
)

func init() {
	_ = flag.Set("c", os.Getenv("CONFIG_PATH"))
	_ = flag.Set("d", os.Getenv("DUMP_CONFIG"))
}

命令行參數(shù)解析可以使用 Go 內(nèi)置的 flag 包來(lái)實(shí)現(xiàn)，我們?cè)谶@里聲明了兩個(gè)標(biāo)志，-c 用來(lái)傳遞配置文件名，-d 用來(lái)決定要進(jìn)行序列化還是反序列化操作。

此外，在 init 函數(shù)中，我們實(shí)現(xiàn)了從環(huán)境變量中加載配置文件名和需要執(zhí)行的操作。當(dāng)配置包被導(dǎo)入時(shí)，會(huì)優(yōu)先執(zhí)行 init 函數(shù)，所以這些信息會(huì)優(yōu)先從環(huán)境變量讀取。

封裝

現(xiàn)在我們可以通過(guò)環(huán)境變量或命令行參數(shù)的形式拿到配置文件名和需要執(zhí)行的操作兩個(gè)參數(shù)，并且分別賦值給 cfgPath、dump 兩個(gè)變量，接下來(lái)我們將對(duì)之前實(shí)現(xiàn)的序列化/反序列化函數(shù)進(jìn)行封裝，讓其使用起來(lái)更加便捷。

反序列化

首先，我們可以將反序列化操作函數(shù) LoadConfig 進(jìn)一步封裝，將其包裝成兩個(gè)函數(shù)分別加載 YAML 配置和 JSON 配置，這樣調(diào)用方在使用時(shí)能夠少傳遞一個(gè)參數(shù)。實(shí)現(xiàn)如下：

func LoadYAMLConfig(filename string, cfg interface{}) error {
	return LoadConfig(filename, cfg, FileTypeYAML)
}

func LoadJSONConfig(filename string, cfg interface{}) error {
	return LoadConfig(filename, cfg, FileTypeJSON)
}

其次，我們拿到的 cfgPath 參數(shù)也能派上用場(chǎng)了，可以對(duì) LoadYAMLConfig、LoadJSONConfig 進(jìn)一步封裝：

func LoadYAMLConfigFromFlag(cfg interface{}) error {
	if !flag.Parsed() {
		flag.Parse()
	}
	return LoadYAMLConfig(*cfgPath, cfg)
}

func LoadJSONConfigFromFlag(cfg interface{}) error {
	if !flag.Parsed() {
		flag.Parse()
	}
	return LoadJSONConfig(*cfgPath, cfg)
}

因?yàn)?cfgPath 是通過(guò)環(huán)境變量或命令行參數(shù)形式傳入，所以調(diào)用反序列化函數(shù)的時(shí)候也就沒(méi)必要手動(dòng)傳入了。

不過(guò)在使用 cfgPath 變量之前，我們調(diào)用了 flag.Parsed() 并對(duì)其返回值進(jìn)行了判斷，如果 flag.Parsed() 返回 false 則調(diào)用 flag.Parse()。

這一步操作是因?yàn)?，配置包的調(diào)用方可能也使用了 flag 包，那么如果調(diào)用方已經(jīng)調(diào)用過(guò) flag.Parse() 解析了命令行參數(shù)，調(diào)用 flag.Parsed() 就會(huì)返回 true，此時(shí)配置包內(nèi)部沒(méi)必要再解析一遍命令行參數(shù)，可以直接使用。

序列化

封裝好了反序列化操作，對(duì)應(yīng)的，也要封裝序列化操作。代碼實(shí)現(xiàn)上與反序列化操作如出一轍，我將代碼貼在這里，就不再進(jìn)行講解了。

func DumpYAMLConfig(filename string, cfg interface{}) error {
	return DumpConfig(filename, cfg, FileTypeYAML)
}

func DumpJSONConfig(filename string, cfg interface{}) error {
	return DumpConfig(filename, cfg, FileTypeJSON)
}

func DumpYAMLConfigFromFlag(cfg interface{}) error {
	if !flag.Parsed() {
		flag.Parse()
	}
	return DumpYAMLConfig(*cfgPath, cfg)
}

func DumpJSONConfigFromFlag(cfg interface{}) error {
	if !flag.Parsed() {
		flag.Parse()
	}
	return DumpJSONConfig(*cfgPath, cfg)
}

統(tǒng)一出口函數(shù)

我們通過(guò)環(huán)境變量或命令行參數(shù)拿到的另外一個(gè)用戶(hù)指定的變量 dump 還沒(méi)有使用，dump 是一個(gè) bool 值，代表用戶(hù)是否想要序列化配置，如果為 true 則進(jìn)行序列化操作，否則進(jìn)行反序列化操作。

由此，我們可以將序列化/反序列化操作封裝成一個(gè)函數(shù)，內(nèi)部通過(guò) dump 的值來(lái)決定執(zhí)行哪種操作。實(shí)現(xiàn)如下：

func LoadOrDumpYAMLConfigFromFlag(cfg interface{}) error {
	if !flag.Parsed() {
		flag.Parse()
	}
	if *dump {
		if err := DumpYAMLConfig(*cfgPath, cfg); err != nil {
			return err
		}
		os.Exit(0)
	}
	return LoadYAMLConfig(*cfgPath, cfg)
}

func LoadOrDumpJSONConfigFromFlag(cfg interface{}) error {
	if *dump {
		if err := DumpJSONConfigFromFlag(cfg); err != nil {
			return err
		}
		os.Exit(0)
	}
	return LoadJSONConfigFromFlag(cfg)
}

我們對(duì) YAML 和 JSON 格式的配置分別實(shí)現(xiàn)了 LoadOrDumpYAMLConfigFromFlag 和 LoadOrDumpJSONConfigFromFlag 函數(shù)。顧名思義，這個(gè)函數(shù)既能加載（Load）配置，也能將配置寫(xiě)入（Dump）文件。

兩個(gè)函數(shù)內(nèi)部思路相同，如果 dump 為 true，就序列化配置信息到文件中，并且使用 os.Exit(0) 退出程序。此時(shí)，控制臺(tái)不會(huì)有任何輸出，這遵循了 Linux/Unix 系統(tǒng)的設(shè)計(jì)哲學(xué)，沒(méi)有消息就是最好的消息；如果 dump 為 false，則進(jìn)行反序列化操作。

以上我們就實(shí)現(xiàn)了自定義配置包的全部功能，完整代碼可以點(diǎn)擊這里查看。

config 包使用

配置包的完整使用示例我寫(xiě)在了項(xiàng)目 GitHub 倉(cāng)庫(kù)的 README.md 文件中，你可以點(diǎn)進(jìn)去查看。

總結(jié)

本文帶大家一起使用 Go 語(yǔ)言實(shí)現(xiàn)了一個(gè)簡(jiǎn)潔的日志包，雖然功能不多，但足夠中小型項(xiàng)目使用。如果對(duì)加載配置文件有更多的要求，如更多格式的日志文件支持、熱加載等，則可以考慮使用更強(qiáng)大的 Go 第三方庫(kù) Viper，或者使用 Nacos、Disconf 等配置中心。

在這個(gè)云原生的時(shí)代，其實(shí)多數(shù)情況下，配置包不需要實(shí)現(xiàn)多么復(fù)雜的功能，盡量保持簡(jiǎn)潔。配置文件可以使用 K8s ConfigMap 來(lái)實(shí)現(xiàn)，配置包的高級(jí)特性也可以考慮通過(guò) Sidecar 的形式來(lái)實(shí)現(xiàn)。

最新評(píng)論