读取Go项目中的配置文件的方法

 更新时间:2022年06月17日 15:05:11   作者:范闲  
本文主要介绍了读取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}}.yamlconf.yaml的总和,如果conf-{{profile}}.yaml中定义的属性和conf.yaml相同,那么会以conf-{{profile}}.yaml为准

约定

gonfigAPI的简洁性的原因是因为背后做了很多约束,只有符合约束的配置才能被成功读取,具体的约束条件如下:

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

  • 自定义设置profileProfileFunc(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

到此这篇关于读取Go项目中的配置文件的方法的文章就介绍到这了,更多相关Go读取配置文件内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • Go设计模式之模板方法模式讲解和代码示例

    Go设计模式之模板方法模式讲解和代码示例

    模版方法是一种行为设计模式, 它在基类中定义了一个算法的框架, 允许子类在不修改结构的情况下重写算法的特定步骤,本文将通过代码示例给大家详细的介绍一下Go模板方法模式,需要的朋友可以参考下
    2023-08-08
  • Go项目在linux服务器的部署详细步骤

    Go项目在linux服务器的部署详细步骤

    在今天的软件开发中,使用Linux作为操作系统的比例越来越高,而Golang语言则因为其高效、简洁和并发性能等特点,也被越来越多的开发者所青睐,这篇文章主要给大家介绍了关于Go项目在linux服务器的部署详细步骤,需要的朋友可以参考下
    2023-09-09
  • Go方法接收者值接收者与指针接收者详解

    Go方法接收者值接收者与指针接收者详解

    这篇文章主要为大家介绍了Go方法接收者值接收者与指针接收者详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2022-11-11
  • Go语言利用泛型封装常见的Map操作

    Go语言利用泛型封装常见的Map操作

    Go 语言在 1.18 版本中引入了泛型,这是 Go 语言发展的一个重要里程碑,它极大地增强了语言的表达能力和灵活性,本文将通过泛型实现封装常见的Map操作,感兴趣的可以了解下
    2025-02-02
  • Go语言的方法接受者类型用值类型还是指针类型?

    Go语言的方法接受者类型用值类型还是指针类型?

    这篇文章主要介绍了Go语言的方法接受者类型用值类型还是指针类型?本文还同时讲解了关于接受者的命名方式,需要的朋友可以参考下
    2014-10-10
  • Go 自定义package包设置与导入操作

    Go 自定义package包设置与导入操作

    这篇文章主要介绍了Go 自定义package包设置与导入操作,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2021-05-05
  • Go语言编译时为exe添加图标和属性信息的方法

    Go语言编译时为exe添加图标和属性信息的方法

    在使用Go语言开发应用程序时,有个非常方便的地方就是编译得到的可执行文件可以不依赖任何动态链接库、并且不需要任何运行环境即可运行,本文给大家介绍Go编译时为exe添加图标和属性信息的方法,需要的朋友可以参考下
    2023-09-09
  • Go通过goroutine实现多协程文件上传的基本流程

    Go通过goroutine实现多协程文件上传的基本流程

    多协程文件上传是指利用多线程或多协程技术,同时上传一个或多个文件,以提高上传效率和速度,本文给大家介绍了Go通过goroutine实现多协程文件上传的基本流程,需要的朋友可以参考下
    2024-05-05
  • Go并发编程中sync/errGroup的使用

    Go并发编程中sync/errGroup的使用

    本文主要介绍了Go并发编程中sync/errGroup的使用,文中通过示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2021-12-12
  • Golang接口的定义与空接口及断言的使用示例

    Golang接口的定义与空接口及断言的使用示例

    在 Golang 中,接口是一种类型,它是由一组方法签名组成的抽象集合。这篇文章主要为大家介绍了Golang接口的具体使用,希望对大家有所帮助,空接口是特殊形式的接口类型,普通的接口都有方法,而空接口没有定义任何方法口,也因此,我们可以说所有类型都至少实现了空接口
    2023-04-04

最新评论