返回顶部
首页 > 资讯 > 后端开发 > GO >Go实现一个配置包详解
  • 160
分享到

Go实现一个配置包详解

Go实现配置包Go 配置 2023-05-18 05:05:01 160人浏览 薄情痞子
摘要

目录需求config 包实现反序列化序列化通过环境变量/命令行参数指定配置文件封装反序列化序列化统一出口函数config 包使用总结在现代软件开发中,配置文件是不可或缺的一部分。在编

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

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

需求

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

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

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

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

config 包实现

反序列化

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

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")
}

首先定义一个 FileType 类型,用来区分不同的配置文件格式,我们要实现的日志包能够支持 YAML 和 JSON 两种格式。

接下来实现了 LoadConfig 函数,用来加载配置,它接收三个参数:配置文件名称、配置结构体、文件类型。

在函数内部,首先使用 os.ReadFile(filename) 读取配置文件内容,然后根据文件类型,使用不同的方法来反序列化,最终将配置信息映射到 cfg 结构体中。

序列化

配置包还要支持序列化操作,也就是将配置信息从内存中写入文件。有时候我们想保存一个 example-config.yaml 供项目使用者参考,这个功能就很实用。

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
}

我们实现了 DumpConfig 函数用来进行序列化操作,该函数同样接收三个参数:配置文件名、配置结构体、文件类型。

在函数中,首先根据文件类型对配置对象 cfg 进行序列化操作得到 data,然后通过 os.Create(filename) 创建配置文件文件,最后使用 f.Write(data) 将序列化后的内容写入文件。

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

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

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

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"))
}

命令行参数解析可以使用 Go 内置的 flag 包来实现,我们在这里声明了两个标志,-c 用来传递配置文件名,-d 用来决定要进行序列化还是反序列化操作。

此外,在 init 函数中,我们实现了从环境变量中加载配置文件名和需要执行的操作。当配置包被导入时,会优先执行 init 函数,所以这些信息会优先从环境变量读取。

封装

现在我们可以通过环境变量或命令行参数的形式拿到配置文件名和需要执行的操作两个参数,并且分别赋值给 cfgPathdump 两个变量,接下来我们将对之前实现的序列化/反序列化函数进行封装,让其使用起来更加便捷。

反序列化

首先,我们可以将反序列化操作函数 LoadConfig 进一步封装,将其包装成两个函数分别加载 YAML 配置和 JSON 配置,这样调用方在使用时能够少传递一个参数。实现如下:

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 参数也能派上用场了,可以对 LoadYAMLConfigLoadJSONConfig 进一步封装:

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)
}

因为 cfgPath 是通过环境变量或命令行参数形式传入,所以调用反序列化函数的时候也就没必要手动传入了。

不过在使用 cfgPath 变量之前,我们调用了 flag.Parsed() 并对其返回值进行了判断,如果 flag.Parsed() 返回 false 则调用 flag.Parse()

这一步操作是因为,配置包的调用方可能也使用了 flag 包,那么如果调用方已经调用过 flag.Parse() 解析了命令行参数,调用 flag.Parsed() 就会返回 true,此时配置包内部没必要再解析一遍命令行参数,可以直接使用。

序列化

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

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)
}

统一出口函数

我们通过环境变量或命令行参数拿到的另外一个用户指定的变量 dump 还没有使用,dump 是一个 bool 值,代表用户是否想要序列化配置,如果为 true 则进行序列化操作,否则进行反序列化操作。

由此,我们可以将序列化/反序列化操作封装成一个函数,内部通过 dump 的值来决定执行哪种操作。实现如下:

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)
}

我们对 YAML 和 JSON 格式的配置分别实现了 LoadOrDumpYAMLConfigFromFlagLoadOrDumpJSONConfigFromFlag 函数。顾名思义,这个函数既能加载(Load)配置,也能将配置写入(Dump)文件。

两个函数内部思路相同,如果 dumptrue,就序列化配置信息到文件中,并且使用 os.Exit(0) 退出程序。此时,控制台不会有任何输出,这遵循了 linux/Unix 系统的设计哲学,没有消息就是最好的消息;如果 dumpfalse,则进行反序列化操作。

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

config 包使用

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

总结

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

在这个云原生的时代,其实多数情况下,配置包不需要实现多么复杂的功能,尽量保持简洁。配置文件可以使用 k8s ConfigMap 来实现,配置包的高级特性也可以考虑通过 Sidecar 的形式来实现。

您可能感兴趣的文档:

--结束END--

本文标题: Go实现一个配置包详解

本文链接: https://www.lsjlt.com/news/211768.html(转载时请注明来源链接)

有问题或投稿请发送至: 邮箱/279061341@qq.com    QQ/279061341

猜你喜欢
  • Go实现一个配置包详解
    目录需求config 包实现反序列化序列化通过环境变量/命令行参数指定配置文件封装反序列化序列化统一出口函数config 包使用总结在现代软件开发中,配置文件是不可或缺的一部分。在编...
    99+
    2023-05-18
    Go实现配置包 Go 配置
  • Flutter配置代理抓包实现过程详解
    目录背景工具准备配置Flutter代理方式一、http请求库配置代理web_socket_channel配置代理方式二、重写原生方法背景 在开发Flutter中,我们经常需要对网络...
    99+
    2023-02-13
    Flutter配置抓包 Flutter 配置 抓包
  • go使用consul实现服务发现及配置共享实现详解
    目录使用consul四大特性通过docker安装consul实现代码运行结果使用consul四大特性 1. 服务发现:利用服务注册,服务发现功能来实现服务治理。 2. 健康检查:利用...
    99+
    2024-04-02
  • electron-builder打包配置详解
    目录1.基础配置2.打包目标配置3.其他平台配置4.nsis配置5.关于操作系统的配置6.更新配置这里介绍的是直接在package.json中直接配置使用: 1.基础配置 "buil...
    99+
    2024-04-02
  • 详解go中通过方法和goroutine实现一个进程
    Golang是一种现代的编程语言,可以用于快速开发高效的服务器应用程序。其中最重要的特点之一是它具有强大的并发支持。Golang的并发性建立在goroutine和channel之上。goroutine类似于线程,但是它们比线程更轻量级,可以...
    99+
    2023-05-14
  • vite + electron-builder 打包配置详解
    目录创一个vite项目安装打包工具配置桌面环境创建 主进程 main.js添加electron 运行命令打包项目,生成dist解决资源无法加载开发环境:热更新两个工具 concurr...
    99+
    2024-04-02
  • kindeditor配置及功能实现详解
    KindEditor是一款基于jQuery的富文本编辑器,可以用于网页中的富文本编辑功能。下面是KindEditor的配置和功能实现...
    99+
    2023-09-28
    kindeditor
  • 详解Nacos配置中心的实现
    目录基础配置pom文件YML文件配置配置中心文件Nacos中的匹配规则Nacos作为配置中心-分类配置Nacos的图形化管理界面三种方案加载配置DataID方案Group方案Name...
    99+
    2024-04-02
  • Nginx怎么实现一个服务配置多个站点
    这篇文章主要介绍了Nginx怎么实现一个服务配置多个站点,具有一定借鉴价值,感兴趣的朋友可以参考下,希望大家阅读完这篇文章之后大有收获,下面让小编带着大家一起了解一下。一个服务配置多个站点server&nb...
    99+
    2024-04-02
  • Nginx怎么实现一个站点配置多个域名
    这篇文章给大家分享的是有关Nginx怎么实现一个站点配置多个域名的内容。小编觉得挺实用的,因此分享给大家做个参考,一起跟随小编过来看看吧。一个站点配置多个域名server {  list...
    99+
    2024-04-02
  • Oracle一个实例配置多个监听
    要想给一个Oracle实例配置多个监听,首先要定义多个监听器,因为是多个监听,势必会有一些监听端口不是1521. 现在服务端的listener.ora文件中定义如下监听器: [oracle@wa...
    99+
    2024-04-02
  • PHP解析一个配置文件
    这篇文章将为大家详细讲解有关PHP解析一个配置文件,小编觉得挺实用的,因此分享给大家做个参考,希望大家阅读完这篇文章后可以有所收获。解析 PHP 配置文件 简介 PHP 配置文件 (php.ini) 保存着影响 PHP 脚本执行的设置。解析...
    99+
    2024-04-02
  • Nginx如何实现同一个域名配置多个项目
    这篇文章主要介绍Nginx如何实现同一个域名配置多个项目,文中介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们一定要看完!使用Nginx要在同一个域名下配置多个项目有两种方式:nginx按不同的目录分发给不同的项目启用二级域名,不同的项...
    99+
    2023-06-14
  • Go Ginrest实现一个RESTful接口
    目录背景特性使用例子实现原理功能列表处理请求处理响应处理错误请求上下文操作请求结构体处理注背景 基于现在微服务或者服务化的思想,我们大部分的业务逻辑处理函数都是长这样的: 比如grp...
    99+
    2024-04-02
  • 详解spring security 配置多个AuthenticationProvider
    前言发现很少关于spring security的文章,基本都是入门级的,配个UserServiceDetails或者配个路由控制就完事了,而且很多还是xml配置,国内通病...so,本文里的配置都是java配置,不涉及xml配置,事实上我也...
    99+
    2023-05-31
    spring security 配置
  • 详解Spring Boot 配置多个RabbitMQ
    闲话好久没有写博客了,6月份毕业,因为工作原因,公司上网受限,一直没能把学到的知识点写下来,工作了半年,其实学到的东西也不少,但是现在回忆起来的东西少之又少,有时甚至能在同个问题中踩了几次,越来越觉得及时记录一下学到的东西很重要。好了,闲话...
    99+
    2023-05-31
    spring boot rabbitmq
  • Spring将一个的类配置成Bean的方式详解
    目录一、说明二、四种方式三、代码示例3.1 @Bean方式3.2 @Bean方式3.3 @Import导入ImportBeanDefinitionRegistrar实现类3.4 Be...
    99+
    2023-03-20
    Spring配置类Bean Spring将类配置成Bean
  • 详解Centos8 配置静态IP的实现
    安装centos 8之后,重启启动网络时,会出现以下报错 报错信息如下: Failed to start network.service: Unit network.service not found. 意思为无法重...
    99+
    2022-06-04
    Centos8 配置静态IP Centos8 静态IP
  • vue3axios实现自动化api配置详解
    目录概述示例约定请求 URL 的约定请求传参的约定分页列表,请求参数约定分页列表 响应示例响应码 code 的约定请求跨域问题解决方案全局配置配置说明coder/config.js模...
    99+
    2024-04-02
  • 详解SpringBoot配置devtools实现热部署
    spring为开发者提供了一个名为spring-boot-devtools的模块来使Spring Boot应用支持热部署,提高开发者的开发效率,无需手动重启Spring Boot应用。devtools的原理深层原理是使用了两个ClassLo...
    99+
    2023-05-31
    spring boot devtools
软考高级职称资格查询
编程网,编程工程师的家园,是目前国内优秀的开源技术社区之一,形成了由开源软件库、代码分享、资讯、协作翻译、讨论区和博客等几大频道内容,为IT开发者提供了一个发现、使用、并交流开源技术的平台。
  • 官方手机版

  • 微信公众号

  • 商务合作