读取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 map面试常考问题合集

    十个Go map面试常考问题合集

    go面试中,map相关知识点问的比较多,这篇文章主要为大家整理归纳了10个常考的问题,文中的示例代码讲解详细,希望对大家有一定的帮助
    2023-07-07
  • Golang合并yaml文件过程逐步讲解

    Golang合并yaml文件过程逐步讲解

    之前一直从事java开发,习惯了使用yaml文件的格式,尤其是清晰的层次结构、注释,下面这篇文章主要给大家介绍了关于Golang合并yaml文件的相关资料,文中通过实例代码介绍的非常详细,需要的朋友可以参考下
    2023-01-01
  • Go 使用xorm操作mysql详情

    Go 使用xorm操作mysql详情

    这篇文章主要介绍了Go 使用xorm操作mysql详情,golang orm 库 xorm 的使用和项目结构。更多详细neural,需要的小伙伴可以参考下面文章内容
    2022-01-01
  • Go 中 time.After 可能导致的内存泄露问题解析

    Go 中 time.After 可能导致的内存泄露问题解析

    这篇文章主要介绍了Go 中 time.After 可能导致的内存泄露,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2023-05-05
  • go语言题解LeetCode1299将每个元素替换为右侧最大元素

    go语言题解LeetCode1299将每个元素替换为右侧最大元素

    这篇文章主要为大家介绍了go语言LeetCode刷题1299将每个元素替换为右侧最大元素示例详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2023-01-01
  • 基于Golang编写一个聊天工具

    基于Golang编写一个聊天工具

    这篇文章主要为大家详细介绍了如何使用 Golang 构建一个简单但功能完善的聊天工具,利用 WebSocket 技术实现即时通讯的功能,需要的小伙伴可以参考下
    2023-11-11
  • Golang设计模式之适配器模式详细讲解

    Golang设计模式之适配器模式详细讲解

    这篇文章主要介绍了使用go实现适配器模式,这个模式就是用来做适配的,它将不兼容的接口转换为可兼容的接口,让原本由于接口不兼容而不能一起工作的类可以一起工作,需要的朋友可以参考下
    2023-01-01
  • Go Excelize API源码阅读SetSheetViewOptions示例解析

    Go Excelize API源码阅读SetSheetViewOptions示例解析

    这篇文章主要为大家介绍了Go-Excelize API源码阅读SetSheetViewOptions示例解析,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2022-08-08
  • golang读取yaml文件的示例代码

    golang读取yaml文件的示例代码

    本文主要介绍了golang读取yaml文件的示例,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2023-09-09
  • Golang实践之Error创建和处理详解

    Golang实践之Error创建和处理详解

    在 C#、Java 等语言中常常使用 try...catch的方式来捕获异常,但是在Golang 对于错误处理有不同的方式,像网上也有很多对 error 处理的最佳实践的文章,其中很多其实就是对 error 的统一封装,使用规范进行约束,本文主要是记录自己对处理 Error 的一些认识和学习
    2023-09-09

最新评论