前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
圈层
工具
发布
首页
学习
活动
专区
圈层
工具
MCP广场
社区首页 >专栏 >Go 配置管理库 Viper 怎么读取结构体嵌套的配置信息?

Go 配置管理库 Viper 怎么读取结构体嵌套的配置信息?

作者头像
frank.
发布于 2023-08-09 05:37:34
发布于 2023-08-09 05:37:34
1.3K00
代码可运行
举报
运行总次数:0
代码可运行

01

介绍

Golang 配置信息管理库 Viper[1],它提供一套完整的管理配置信息的解决方案。

Go 语言中很多知名开源项目也都选择使用 Viper,它功能非常强大,本文介绍 Viper 读取结构体嵌套配置信息的使用方式。

02

读取结构体嵌套配置信息

在实际项目开发中,我们经常会遇到一些比较复杂的配置信息,比如多层嵌套的配置信息,在结构体中嵌套结构体和切片。

代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
user_data:
  uid: 10000
  uname: "frank"
  other_info:
    email: "gopher@email.cn"
    address: "Beijing China"
  language:
    - name: "go"
      score: 90
    - name: "php"
      score: 95
    - name: "JavaScript"
      score: 80

阅读上面 yaml 文件,user_data 是一个多层嵌套的配置信息。

读取该多层嵌套配置信息,如果我们使用 GetXXX 函数获取值,代码会非常繁琐。

Viper 提供了 2 个解析函数,UnmarshalUnmarshalKey,我们可以使用它们非常方便地读取多层嵌套配置信息,可以将所有或指定配置信息解析到 structmap数据结构中。

我们通过示例代码,介绍它们的使用方式。

目录:

代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
├── configs
│   ├── default.yaml
│   └── test.yaml
├── go.mod
├── go.sum
└── main.go

示例代码:

代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
package main

import (
 "fmt"
 "github.com/spf13/viper"
)

func main() {
 v := viper.New()
 //v.SetConfigFile("./configs/test.yaml")
 v.SetConfigFile("./configs/default.yaml")
 err := v.ReadInConfig()
 if err != nil {
  fmt.Println(err)
  return
 }
 //err = v.Unmarshal(&userData)
 err = v.UnmarshalKey("user_data", &userData)
 if err != nil {
  fmt.Println(err)
  return
 }
 fmt.Printf("userData=%+v\n", userData)
}

type UserData struct {
 Uid       int        `json:"uid"`
 Uname     string     `json:"uname"`
 OtherInfo OtherInfo  `json:"other_info" mapstructure:"other_info"`
 Language  []Language `json:"language" mapstructure:"language"`
}

type OtherInfo struct {
 Email   string
 Address string
}

type Language struct {
 Name  string
 Score int
}

var userData UserData

输出结果:

代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
userData={Uid:10000 Uname:frank OtherInfo:{Email:gopher@email.cn Address:Beijing China} Language:[{Name:go Score:90} {Name:php Score:95} {Name:JavaScript Score:80}]}

阅读上面这段代码,结构体 UserData 中嵌套结构体 OtherInfo 和切片 Language,我们使用 Viper 提供的 tag 标签 mapstructure,将读取到的配置信息解析到 struct 中。

需要注意的是,解析指定配置信息使用 UnmarshalKey 函数,解析全部配置信息使用 Unmarshal,二者的 yaml 文件格式也不一样,读者朋友们小心踩“坑”。

03

总结

本文我们通过示例代码,介绍怎么使用 Viper 读取嵌套配置信息,它提供两个函数 UnmarshalUnmarshalKey,分别用于解析全部配置信息,和解析指定配置信息。

需要注意的是,针对结构体中的嵌套结构体类型或切片类型的字段,我们需要使用 Viper 提供的 tag 标签 mapstructure,否则将无法读取到配置信息的内容。

此外,yaml 格式也需要熟练掌握,尽量不要因为 yaml 格式不对,导致解析不出配置信息中的内容。

本文参与 腾讯云自媒体同步曝光计划,分享自微信公众号。
原始发表:2023-06-11,如有侵权请联系 cloudcommunity@tencent.com 删除

本文分享自 Golang语言开发栈 微信公众号,前往查看

如有侵权,请联系 cloudcommunity@tencent.com 删除。

本文参与 腾讯云自媒体同步曝光计划  ,欢迎热爱写作的你一起参与!

评论
登录后参与评论
暂无评论
推荐阅读
编辑精选文章
换一批
Go viper 配置文件读取工具
viper 提供默认 Viper对象, 可直接使用。 也通过 New 方法创建自定义Viper
copy_left
2020/08/11
1.9K0
手把手,带你从零封装Gin框架(二):配置初始化 & 全局变量
配置文件是每个项目必不可少的部分,用来保存应用基本数据、数据库配置等信息,避免要修改一个配置项需要到处找的尴尬。这里我使用 viper 作为配置管理方案,它支持 JSON、TOML、YAML、HCL、envfile、Java properties 等多种格式的配置文件,并且能够监听配置文件的修改,进行热重载,详细介绍大家可以去官方文档查看
用户10002156
2024/01/08
2.3K0
手把手,带你从零封装Gin框架(二):配置初始化 & 全局变量
viper 源码分析
Viper是Go应用程序的完整配置解决方案,包括12-Factor应用程序。它旨在在应用程序中工作,并可以处理所有类型的配置需求和格式。它支持:
golangLeetcode
2022/08/02
1.1K0
Go每日一库之6:viper
上一篇文章介绍 cobra 的时候提到了 viper,今天我们就来介绍一下这个库。
luckpunk
2023/09/13
3830
Go之Viper
Viper是适用于Go应用程序的完整配置解决方案。它被设计用于在应用程序中工作,并且可以处理所有类型的配置需求和格式;
iginkgo18
2021/04/23
6.6K1
Golang-配置管理Viper
Viper 是一个完整的 Go 应用程序配置解决方案,优势就在于开发项目中你不必去操心配置文件的格式而是让你腾出手来专注于项目的开发。其特性如下:
小许code
2023/02/09
1.1K0
Golang-配置管理Viper
Golang 语言怎么使用 Viper 管理配置信息?
Viper 是适用于 Go 应用程序(包括 Twelve-Factor App)的完整配置解决方案。它被设计为在应用程序中工作,并且可以处理所有类型的配置需求和格式。它支持:
frank.
2021/01/08
6.5K0
go语言中的配置管理神器 --viper 二 实战
onenewcode
2024/02/04
2170
Go:配置文件解析库 spf13/viper简介(Go应用程序的完整配置解决方案)
在我们开发过程中,像数据库信息、邮件配置和其他的第三方服务密钥等这些固定的信息都会写在配置文件中,而配置文件又有多种表现形式和格式,有 JSON, TOML, YAML各种格式,而且测试环境,开发环境和生产环境用的配置文件也不是同一份。
Freedom123
2024/03/29
6550
Viper,一个Go语言配置管理神器!
文章链接:https://cloud.tencent.com/developer/article/2466037
南山竹
2024/11/16
1240
Viper,一个Go语言配置管理神器!
基于 Go 语言开发在线论坛增补篇:通过 Viper 读取配置文件并实现热加载
之前我们在论坛项目中使用了单例模式全局加载配置文件,这样做有一个弊端,就是不支持热加载,每次修改配置文件,需要重启应用,不太灵活,所以这篇教程我们引入 Viper 重构配置读取逻辑,并支持配置文件的热加载(所谓热加载指的是配置文件修改后无需重启应用即可生效)。
学院君
2020/05/07
2.1K0
go语言中的配置管理神器 --viper 一
Viper 是 Go 应用程序的完整配置解决方案,包括 12-Factor 应用程序。它旨在在应用程序中工作,并可以处理所有类型的配置需求和格式。它支持:
onenewcode
2024/02/02
4040
go库介绍:Golang中的Viper库
在Golang(Go)的开发中,配置管理是一个不可或缺的部分。一个优雅的配置管理方案不仅能够简化应用程序的配置处理流程,还能提高应用程序的灵活性和可维护性。在这方面,Viper库无疑是Go生态系统中的一颗璀璨明珠。本文将详细介绍Viper库及其使用场景,并通过具体示例展示其强大功能。
每周聚焦
2024/11/08
5990
go库介绍:Golang中的Viper库
Go中级之手把手教你开发一个简易的个人博客网站(二)项目配置独立化
此文是个人学习归纳的记录,腾讯云独家发布,未经允许,严禁转载,如有不对, 还望斧正, 感谢!
言志志
2023/12/24
8971
Go中级之手把手教你开发一个简易的个人博客网站(二)项目配置独立化
使用Viper读取Nacos配置(开源)
目前Viper支持的Remote远程读取配置如 etcd, consul;目前还没有对Nacos进行支持,本文中将开源一个Nacos的Viper支持库, 开源地址在文章的最下方. 实现这个仓库的主要目的是为了,最终集成到我们的yoyogo框架中。
yoyofx
2021/05/06
2.3K0
Go 每日一库之 mapstructure
mapstructure用于将通用的map[string]interface{}解码到对应的 Go 结构体中,或者执行相反的操作。很多时候,解析来自多种源头的数据流时,我们一般事先并不知道他们对应的具体类型。只有读取到一些字段之后才能做出判断。这时,我们可以先使用标准的encoding/json库将数据解码为map[string]interface{}类型,然后根据标识字段利用mapstructure库转为相应的 Go 结构体以便使用。
用户7731323
2020/09/08
2.8K0
知识分享之Golang——和我一起搭建一个快速开发框架(三)
知识分享之Golang篇是我在日常使用Golang时学习到的各种各样的知识的记录,将其整理出来以文章的形式分享给大家,来进行共同学习。
cn華少
2022/01/07
4080
Golang生态:使用viper管理配置
通过配置,我们可以动态地改变程序的行为,常用的方式包括配置文件,命令行参数,环境变量等。我原来一直很欣赏ssh的配置管理方式:
王录华
2019/11/19
5.1K1
Go 语言 viper 库上手实践
在软件开发当中,不可避免需要将配置信息存放于配置文件当中。在 Java 项目当中,Spring 提供了非常强大的配置文件管理能力,这里就不多说了。今天分享一下 Go 语言中的配置文件管理类——viper。
FunTester
2025/01/23
1490
Go 语言 viper 库上手实践
Go:使用Viper和YAML管理配置文件
在软件开发中,配置管理是一项基本但至关重要的任务,它涉及到如何有效地管理应用程序的配置变量,例如数据库连接信息、外部服务的API密钥等。一个好的配置管理工具不仅可以帮助开发人员更容易地管理这些配置,还可以提高应用程序的安全性和灵活性。今天,我们将探讨如何使用Viper库配合YAML配置文件来实现高效的配置管理。
运维开发王义杰
2024/04/15
1.6K0
Go:使用Viper和YAML管理配置文件
相关推荐
Go viper 配置文件读取工具
更多 >
领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档
本文部分代码块支持一键运行,欢迎体验
本文部分代码块支持一键运行,欢迎体验