Go实现一个配置包详解

在现代软件开发中，配置文件是不可或缺的一部分。在编写 Go 项目时，不管是一个简单的单文件脚本还是一个庞大的微服务项目，程序的灵活性和可扩展性都需要依赖于配置文件的加载。配置文件可以包含程序的各种设置，如端口号、数据库连接信息、认证密钥等，这些设置可能需要根据不同的环境和部署情况进行调整。因此，一个可靠的配置文件加载机制对于项目的成功实现至关重要。本文就来探究下在 Go 项目中如何更加方便的加载和管理配置。

在 Go 中，有很多方法可以加载和管理配置，例如使用命令行标志、环境变量或者读取特定格式的文件。选择哪种方法取决于项目的具体需求和开发人员的偏好。

需求

根据我的开发经验，一个配置包通常需要支持如下功能：

• 支持从环境变量、命令行标志加载配置文件，然后将配置文件内容映射到 Go 结构体中，这个过程叫作反序列化。

• 支持将 Go 结构体中的配置信息写入配置文件，这个过程叫作序列化。

• 起码要支持 YAML、JSON 这两种最常见的配置文件格式。

config 包实现

反序列化

反序列化操作是配置包最常用的功能，通过反序列化我们可以将配置文件内容映射到 Go 结构体中。所以我们先来实现如何进行配置文件的反序列化操作。

FileType

LoadConfig

os.ReadFile(filename)cfg

序列化

example-config.yaml

DumpConfig

cfgdataos.Create(filename)f.Write(data)

现在配置包的核心功能已经实现了，并且两个函数都被允许导出，如果其他项目想使用，其实是可以拿过去直接使用的。不过目前的配置包在易用性上还有可优化的空间。

通过环境变量/命令行参数指定配置文件

以上序列化/反序列化函数的实现，配置文件名都是需要通过参数传递进来的，我们还可以通过环境变量或者命令行参数的形式来指定配置文件名。

-c-d

initinit

封装

cfgPathdump

反序列化

LoadConfig

cfgPathLoadYAMLConfigLoadJSONConfig

cfgPath

cfgPathflag.Parsed()flag.Parsed()falseflag.Parse()

flag.Parse()flag.Parsed()true

序列化

封装好了反序列化操作，对应的，也要封装序列化操作。代码实现上与反序列化操作如出一辙，我将代码贴在这里，就不再进行讲解了。

统一出口函数

dumpdumpbooltrue

dump

LoadOrDumpYAMLConfigFromFlagLoadOrDumpJSONConfigFromFlagLoadDump

dumptrueos.Exit(0)dumpfalse

以上我们就实现了自定义配置包的全部功能，完整代码可以点击这里查看。

config 包使用

配置包的完整使用示例我写在了项目 GitHub 仓库的 README.md 文件中，你可以点进去查看。

总结

本文带大家一起使用 Go 语言实现了一个简洁的日志包，虽然功能不多，但足够中小型项目使用。如果对加载配置文件有更多的要求，如更多格式的日志文件支持、热加载等，则可以考虑使用更强大的 Go 第三方库 Viper，或者使用 Nacos、Disconf 等配置中心。

ConfigMapSidecar