golang读取yaml配置文件的方法实现

更新时间：2024年10月25日 09:45:26 作者：code:404-not-found

本文主要介绍了golang读取yaml配置文件的方法实现,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧

Viper

Viper是适用于Go应用程序的完整配置解决方案。它被设计用于在应用程序中工作，并且可以处理所有类型的配置需求和格式。它支持以下特性:

设置默认值
从JSON、TOML、YAML、HCL、envfile和Java properties 格式的配置文件读取配置信息
实时监控和重新读取配置文件(可选)
从环境变量中读取
从远程配置系统(etcd或Consul)读取并监控配置变化
从命令行参数读取配置
从buffer读取配置
显式配置值

安装

go get github.com/spf13/viper

使用

在项目根目录创建config文件夹，在文件夹中创建local.yaml

servername: 'myserver'

mysql:
  name: 'mysql'

在main.go中读取配置文件的信息

package main

import (
	"log"

	"github.com/spf13/viper"
)

func main() {
	v := viper.New()

	// 设置文件名称
	v.SetConfigFile("./config/local.yaml")

	if err := v.ReadInConfig(); err != nil {
		log.Panicln("读取配置文件失败")
	}

	servername := v.Get("servername")
	mysql := v.Get("mysql.name")
	log.Println(servername, mysql)
}

使用结构体映射yaml

修改配置文件

name: '服务名'
port: 8080

使用

package main

import (
	"log"

	"github.com/spf13/viper"
)

type ServerConfig struct {
	Name string `mapstructure:"name"`
	Port int    `mapstructure:"port"`
}

func main() {

	cfg := ServerConfig{}
	v := viper.New()

	// 设置文件名称
	v.SetConfigFile("./config/local.yaml")

	if err := v.ReadInConfig(); err != nil {
		log.Panicln("读取配置文件失败")
	}

	if err := v.Unmarshal(&cfg); err != nil {
		log.Panicln(err)
	}

	log.Println(cfg)
}

输出

{服务名 8080}

结构体嵌套读取配置

配置文件

name: '服务名'
port: 8080
mysql: 
  host: '127.0.0.1'
  port: 3306

读取配置

package main

import (
	"log"

	"github.com/spf13/viper"
)

type ServerConfig struct {
	Name        string      `mapstructure:"name"`
	Port        int         `mapstructure:"port"`
	MysqlConfig MysqlConfig `mapstructure:"mysql"` // 嵌套的配置
}

type MysqlConfig struct {
	Host string `mapstructure:"host"`
	Port int    `mapstructure:"port"`
}

func main() {

	cfg := ServerConfig{}
	v := viper.New()

	// 设置文件名称
	v.SetConfigFile("./config/local.yaml")

	if err := v.ReadInConfig(); err != nil {
		log.Panicln("读取配置文件失败")
	}

	if err := v.Unmarshal(&cfg); err != nil {
		log.Panicln(err)
	}

	log.Println(cfg)
}

输出

{服务名 8080 {127.0.0.1 3306}}

根据不同环境读取不同配置文件

在实际开发工作中，一般有不同的开发环境，会涉及到读取不同的配置文件

这会运用的golang的flag包

package main

import (
	"flag"
	"log"
)


func main() {

	env := flag.String("env", "local", "运行环境请输入local dev test prod")
	flag.Parse()

	log.Println("当前环境是" + *env)

}

运行

go run .\main.go -help

输出

-env string
运行环境请输入local dev test prod (default "local")

这样的话运行

go run .\main.go -env dev

输出

当前环境是dev

利用flag读取不同环境的配置文件

在项目更目录新建config文件夹

并创建4个配置文件 local.yaml dev.yaml test.yaml prod.yaml

其中dev.yaml中

name: 'dev服务名'
port: 8080
mysql: 
  host: '127.0.0.1'
  port: 3306

在main.go中

package main

import (
	"flag"
	"fmt"
	"log"

	"github.com/spf13/viper"
)

type ServerConfig struct {
	Name        string      `mapstructure:"name"`
	Port        int         `mapstructure:"port"`
	MysqlConfig MysqlConfig `mapstructure:"mysql"` // 嵌套的配置
}

type MysqlConfig struct {
	Host string `mapstructure:"host"`
	Port int    `mapstructure:"port"`
}

func main() {

	env := flag.String("env", "local", "运行环境请输入local dev test prod")
	flag.Parse()

	log.Println("当前环境是" + *env)

	cfg := ServerConfig{}
	v := viper.New()
	var path string = fmt.Sprintf("./config/%s.yaml", *env)
	// 设置文件名称
	v.SetConfigFile(path)

	if err := v.ReadInConfig(); err != nil {
		log.Panicln("读取配置文件失败")
	}

	if err := v.Unmarshal(&cfg); err != nil {
		log.Panicln(err)
	}

	log.Println(cfg)
}

运行

go run .\main.go -env dev

输出

当前环境是dev
{dev服务名 8080 {127.0.0.1 3306}}

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

您可能感兴趣的文章:

golang监听文件变化的实例
这篇文章主要介绍了golang监听文件变化的实例，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧
2021-03-03
golang如何用type-switch判断interface变量的实际存储类型
这篇文章主要介绍了golang如何用type-switch判断interface变量的实际存储类型，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2022-04-04
goland 设置project gopath的操作
这篇文章主要介绍了goland 设置project gopath的操作，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧
2021-05-05
利用ChatGPT编写一个Golang图像压缩函数
这篇文章主要为大家详细介绍了如何利用ChatGPT帮我们写了一个Golang图像压缩函数，文中的示例代码简洁易懂，感兴趣的小伙伴可以尝试一下
2023-04-04
Go1.21新增maps包的用法详解
maps 包提供了几个非常有用的用于操作 map 类型（任何类型的 map）的函数,本文为大家整理了部分函数的具体用法,感兴趣的小伙伴可以了解一下
2023-08-08
GO中的条件变量sync.Cond详解
条件变量是基于互斥锁的，它必须基于互斥锁才能发挥作用，条件变量的初始化离不开互斥锁，并且它的方法有点也是基于互斥锁的，这篇文章主要介绍了GO的条件变量sync.Cond,需要的朋友可以参考下
2023-01-01
一文带你轻松理解Go中的内存逃逸问题
这篇文章主要给大家介绍Go中的内存逃逸问题，文中通过代码示例讲解的非常详细，对我们的学习或工作有一定的参考价值，感兴趣的同学可以跟着小编一起来学习
2023-06-06
Go 语言结构实例分析
在本篇文章里小编给大家整理的是一篇关于Go 语言结构实例分析的相关知识点，有兴趣的朋友们可以学习下。
2021-07-07
go语言制作分页器实例探究
这篇文章主要为大家介绍了go语言制作分页器实例探究,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
2024-01-01
golang中byte和rune用法及新手易错点总结
golang内置类型有rune类型和byte类型,下面这篇文章主要给大家介绍了关于golang中byte和rune用法及新手易错点总结的相关资料,文中通过代码介绍的非常详细,需要的朋友可以参考下
2024-03-03