读取Go项目中的配置文件的方法
来源:脚本之家
时间:2022-12-25 08:42:42 184浏览 收藏
知识点掌握了,还需要不断练习才能熟练运用。下面golang学习网给大家带来一个Golang开发实战,手把手教大家学习《读取Go项目中的配置文件的方法》,在实现功能的过程中也带大家重新温习相关知识点,温故而知新,回头看看说不定又有不一样的感悟!
Go语言提供了很简便的读取json和yaml文件的api,我们可以很轻松将一个json或者yaml文件转换成Go的结构体,但是如果直接在项目中读取配置文件,这种方式并不够好。缺点如下:
实际开发中配置项在不同环境下,配置的值是不同的
上面的问题可以通过不同的配置文件去决定在那个环境读取那个配置文件,但是还有一个问题就是实际开发中,配置项有些是相同的,有些是不同的,如果配置文件有一个主配置文件,里面存放的是不同环境相同的配置项,还有一个跟随环境的配置文件,里面存放的是不同环境的配置项,然后读取两个配置文件后,做一个merge,这样得到的结果就是总共的配置项信息。
有些配置项是必填的,有些配置项的值是一些特殊的值,比如,邮箱,手机号,IP信息等
来看看gonfig是怎么解决这个问题的
- 安装gonfig
go get github.com/xiao-ren-wu/gonfig
- 项目中新建配置目录,并编写对应配置文件,在配置目录同级目录添加读取配置文件的go文件
conf.yaml
文件中存放的是通用的配置,conf-{{active}}.yaml
中存放不同环境不同的配置信息。
conf |-conf.yaml |-conf-dev.yaml |-conf-prod.yaml |config.go
- 利用
go:embed
将配置文件载入到内存,调用gonfig.Unmarshal
读取配置文件
package config import ( "model" "github.com/xiao-ren-wu/gonfig" "embed" ) //go:embed *.yaml var confDir embed.FS // 我们配置文件的配置struct type AppConf struct { AppName string `yaml:"app-name" json:"app-name"` DB DBConf `yaml:"db" json:"db"` } type DBConf struct { Username string `yaml:"username" json:"username"` Password string `yaml:"password" json:"password"` } var conf Conf func Init() { if err := gonfig.Unmarshal(confDir, &conf); err != nil { panic(err) } } func GetConf() *Conf { return &conf }
这样就完成了项目中配置文件的读取,是不是很简单? 此时读到的配置形式是conf-{{profile}}.yaml
和conf.yaml
的总和,如果conf-{{profile}}.yaml
中定义的属性和conf.yaml
相同,那么会以conf-{{profile}}.yaml
为准
约定
gonfig
API的简洁性的原因是因为背后做了很多约束,只有符合约束的配置才能被成功读取,具体的约束条件如下:
gonfig.Unmarshal
会默认读取文件名称有前缀conf
的文件通过环境变量
profile
作为环境名称,如果没有配置,默认dev。程序会寻找
conf.yaml
作为主配置文件,conf-{{profile}}.yaml
作为环境特有配置文件,然后对文件内容进行合并如果
conf-{{profile}}.yaml
中的属性和conf.yaml
中属性都有定义,那么会以conf-{{profile}}.yaml
为准。
根据项目定制化配置文件
gonfig.Unmarshal
的函数签名func Unmarshal(confDir ReadFileDir, v interface{}, ops ...Option) error
提供很多配置项,供用户定制化需求,具体的配置信息如下:
更改配置文件名称前缀
FilePrefix(prefix string)
更改读取配置文件类型
UnmarshalWith(uType UnmarshalType)
更改读取的环境变量名称
ProfileUseEnv(envName, defaultProfile string)
自定义设置profile
ProfileFunc(f func() string)
原理篇
gonfig
的实现也很简单,核心的源码如下:
func Unmarshal(confDir ReadFileDir, v interface{}, ops ...Option) error { if v != nil && reflect.ValueOf(v).Kind() != reflect.Ptr { return gonfig_error.ErrNonPointerArgument } var cs = &confStruct{ confPrefix: "conf", envName: "profile", defaultEnvValue: "dev", unmarshalType: Yaml, } cs.activeProfileFunc = func() string { return getActiveProfile(cs.envName, cs.defaultEnvValue) } for _, op := range ops { op(cs) } cs.profileActive = cs.activeProfileFunc() if err := loadConf(confDir, cs); err != nil { return err } // copy val v1 := reflect.New(reflect.TypeOf(v).Elem()).Interface() if err := fileUnmarshal(cs.activeConfRaw, v1, cs.unmarshalType); err != nil { return err } if len(cs.masterConfRaw) == 0 { return gonfig_error.MasterProfileConfNotSetError } if err := fileUnmarshal(cs.masterConfRaw, v, cs.unmarshalType); err != nil { return err } return mergo.Merge(v, v1, mergo.WithOverride) }
大概的原理就是复制了一份用户传给函数的结构体v1,结构体v1和v分别用于接收conf-{{profile}}.yaml
中的属性和conf.yaml
的配置信息,然后通过调用三方开源库mergo
对两个结构体的属性做一个merge。
这就是关于gonfig
的全部内容啦~~~
github地址是:https://github.com/xiao-ren-wu/gonfig
今天带大家了解了读取、配置文件的相关知识,希望对你有所帮助;关于Golang的技术知识我们会一点点深入介绍,欢迎大家关注golang学习网公众号,一起学习编程~
-
403 收藏
-
133 收藏
-
184 收藏
-
138 收藏
-
326 收藏
-
377 收藏
-
384 收藏
-
246 收藏
-
110 收藏
-
210 收藏
-
108 收藏
-
- 前端进阶之JavaScript设计模式
- 设计模式是开发人员在软件开发过程中面临一般问题时的解决方案,代表了最佳的实践。本课程的主打内容包括JS常见设计模式以及具体应用场景,打造一站式知识长龙服务,适合有JS基础的同学学习。
- 立即学习 542次学习
-
- GO语言核心编程课程
- 本课程采用真实案例,全面具体可落地,从理论到实践,一步一步将GO核心编程技术、编程思想、底层实现融会贯通,使学习者贴近时代脉搏,做IT互联网时代的弄潮儿。
- 立即学习 507次学习
-
- 简单聊聊mysql8与网络通信
- 如有问题加微信:Le-studyg;在课程中,我们将首先介绍MySQL8的新特性,包括性能优化、安全增强、新数据类型等,帮助学生快速熟悉MySQL8的最新功能。接着,我们将深入解析MySQL的网络通信机制,包括协议、连接管理、数据传输等,让
- 立即学习 497次学习
-
- JavaScript正则表达式基础与实战
- 在任何一门编程语言中,正则表达式,都是一项重要的知识,它提供了高效的字符串匹配与捕获机制,可以极大的简化程序设计。
- 立即学习 487次学习
-
- 从零制作响应式网站—Grid布局
- 本系列教程将展示从零制作一个假想的网络科技公司官网,分为导航,轮播,关于我们,成功案例,服务流程,团队介绍,数据部分,公司动态,底部信息等内容区块。网站整体采用CSSGrid布局,支持响应式,有流畅过渡和展现动画。
- 立即学习 484次学习
-
- 等待的大地
- 真优秀,一直没懂这个问题,但其实工作中常常有遇到...不过今天到这,帮助很大,总算是懂了,感谢老哥分享技术文章!
- 2023-04-16 04:28:52
-
- 还单身的摩托
- 受益颇多,一直没懂这个问题,但其实工作中常常有遇到...不过今天到这,帮助很大,总算是懂了,感谢up主分享技术贴!
- 2023-03-03 16:32:59
-
- 顺利的方盒
- 这篇博文真及时,太细致了,很棒,已加入收藏夹了,关注师傅了!希望师傅能多写Golang相关的文章。
- 2023-03-02 12:44:58
-
- 开放的薯片
- 这篇技术贴真及时,博主加油!
- 2023-02-20 12:05:18
-
- 单身的路灯
- 太全面了,码起来,感谢up主的这篇文章内容,我会继续支持!
- 2023-01-25 21:34:42
-
- 爱听歌的大神
- 这篇技术贴真是及时雨啊,太详细了,真优秀,已收藏,关注up主了!希望up主能多写Golang相关的文章。
- 2023-01-23 12:00:20
-
- 隐形的流沙
- 写的不错,一直没懂这个问题,但其实工作中常常有遇到...不过今天到这,看完之后很有帮助,总算是懂了,感谢作者分享文章内容!
- 2023-01-13 00:22:21
-
- 酷酷的野狼
- 这篇文章内容真是及时雨啊,太全面了,很有用,码住,关注博主了!希望博主能多写Golang相关的文章。
- 2022-12-28 17:37:44
-
- 能干的苗条
- 好细啊,码住,感谢师傅的这篇文章,我会继续支持!
- 2022-12-28 03:11:18