go项目中环境变量的配置

更新时间：2021年07月13日 11:17:16 作者：水痕001

本文主要介绍了go项目中环境变量的配置，文中通过示例代码介绍的非常详细，需要的朋友们下面随着小编来一起学习学习吧

一、为什么要配置文件

1、容易编辑，配置比较集中，方便修改，在大业务量的系统里面，通过配置会方便后人理解整个系统的架构
2、做到业务代码和环境解耦，环境配置变量不侵入到代码层面
3、不同的环境切换比较方便

二、在go中使用配置文件

2、本地安装

go get github.com/spf13/viper

3、简单的读取配置文件

package main

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

func main() {
 v := viper.New()
 v.SetConfigFile("config.yaml")
 if err := v.ReadInConfig(); err != nil {
  fmt.Println("读取配置文件失败", err)
 }
 fmt.Println(v.Get("name"))
}

4、在文件的同级下创建一个config.yaml的文件

name: "test"

5、使用go run 文件名运行文件，这样直接运行会报错找不到文件

6、建议配置后可以使用右键运行项目

package main

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

func main() {
 // 获取项目目录
 workDir, _ := os.Getwd()
 v := viper.New()
  // 直接拼接文件目录读取
 v.SetConfigFile(path.Join(workDir, "test/config.yaml"))
 if err := v.ReadInConfig(); err != nil {
  fmt.Println("读取配置文件失败", err)
 }
 fmt.Println(v.Get("name"))
}

三、使用结构体的方式读取

1、简单的使用

package main

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

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

func main() {
 // 获取项目目录
 workDir, _ := os.Getwd()
 v := viper.New()
 v.SetConfigFile(path.Join(workDir, "test/config.yaml"))
 if err := v.ReadInConfig(); err != nil {
  fmt.Println("读取配置文件失败", err)
 }
 serverConfig := ServerConfig{}
 if err := v.Unmarshal(&serverConfig); err != nil {
  fmt.Println("解析结构体失败", err)
 }
 fmt.Println(serverConfig.Name)
}

2、结构体的嵌套，很常见的是mysql数据库的配置

// 定义mysql的
type MySQLConfig struct {
 Host string `mapstructure:"host"`
 Port int `mapstructure:"port"`
 Username string `mapstructure:"username"`
 Password string `mapstructure:"password"`
}
type ServerConfig struct {
 Name string `mapstructure:"name"`
 // 嵌套使用,注意这个地方要和yaml中一样
 MySqlConfig MySQLConfig `mapstructure:"mysql"`
}

// 直接使用
fmt.Println(serverConfig.MySqlConfig)

四、区分开发环境和生产环境

1、在mac电脑上配置环境变量，在.bash_profile中导出一个环境变量，注意要关闭goland重新打开

# vim .bash_profile
export IS_DEV= true
source .bash_profile

2、定义方法直接获取环境变量

func GetEnvInfo(env string) bool {
 viper.AutomaticEnv()
 return viper.GetBool(env)
}
func main() {
 fmt.Println(GetEnvInfo("IS_DEV"))
}

3、在目录下创建一个application.dev.yml和application.prod.yml的文件，分别存放不同环境下的配置

4、使用环境变量来读取配置完整代码

func GetEnvInfo1(env string) bool {
 viper.AutomaticEnv()
 return viper.GetBool(env)
}

// 定义mysql的
type MySQLConfig struct {
 Host string `mapstructure:"host"`
 Port int `mapstructure:"port"`
 Username string `mapstructure:"username"`
 Password string `mapstructure:"password"`
}
type ServerConfig struct {
 Name string `mapstructure:"name"`
 // 嵌套使用,注意这个地方要和yaml中一样
 MySqlConfig MySQLConfig `mapstructure:"mysql"`
}

func main() {
 // 获取项目目录
 workDir, _ := os.Getwd()
 isDev := GetEnvInfo1("IS_DEV")
 configFileName := path.Join(workDir, "11.config/application.prod.yml")
 if isDev {
  configFileName = path.Join(workDir, "11.config/application.dev.yml")
 }
 v := viper.New()
 v.SetConfigFile(configFileName)
 if err := v.ReadInConfig(); err != nil {
  fmt.Println("读取配置文件失败", err)
 }
 serverConfig := ServerConfig{}
 if err := v.Unmarshal(&serverConfig); err != nil {
  fmt.Println("解析结构体失败", err)
 }
 fmt.Println(serverConfig.MySqlConfig)
}

五、在gin中集成配置文件

1、在和main.go同级的目录下创建两个xx.yml的文件

2、目录下创建一个config、global、initialize的文件夹

3、在config/config.go的文件中书写使用结构体读取配置的

package config

// 定义mysql的
type MySQLConfig struct {
 Host string `mapstructure:"host"`
 Port int `mapstructure:"port"`
 Username string `mapstructure:"username"`
 Password string `mapstructure:"password"`
}
type ServerConfig struct {
 Name string `mapstructure:"name"`
 // 嵌套使用,注意这个地方要和yaml中一样
 MySqlConfig MySQLConfig `mapstructure:"mysql"`
}

4、在global/global.go文件中定义全局变量(可能在全项目中某一个文件中需要获取配置)

var (
 ServerConfig *config.ServerConfig = &config.ServerConfig{}
)

5、在initialize/config目录初始化配置

func GetEnvInfo(env string) bool {
 viper.AutomaticEnv()
 return viper.GetBool(env)
}

func InitConfig() {
 workDir, _ := os.Getwd()
 isDev := GetEnvInfo("IS_DEV")
 configFileName := path.Join(workDir, "11.config/application.prod.yml")
 if isDev {
  configFileName = path.Join(workDir, "11.config/application.dev.yml")
 }
 v := viper.New()
 //文件的路径如何设置
 v.SetConfigFile(configFileName)
 if err := v.ReadInConfig(); err != nil {
  panic(err)
 }
 err := v.Unmarshal(&global.ServerConfig)
 if err != nil {
  fmt.Println("读取配置失败")
 }
 fmt.Println(&global.ServerConfig)
}

6、在mian.go中初始化配置文件并且打印出信息

func main() {
 // 初始化配置
 initialize.InitConfig()
 fmt.Println(global.ServerConfig.MySqlConfig)
}

到此这篇关于go项目中环境变量的配置的文章就介绍到这了,更多相关go 环境变量配置内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

gorm+gin实现restful分页接口的实践
本文主要介绍了gorm+gin实现restful分页接口的实践，文中通过示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2021-12-12
深入探究Go语言中for range语句
为了更加便捷地遍历这些数据类型，Go语言引入了for...range语句，本文将以数组遍历为起点，逐步介绍for...range语句在不同数据类型中的应用，希望对大家有所帮助
2023-06-06
Go语言内建函数cap的实现示例
cap 是一个常用的内建函数,它用于获取某些数据结构的容量,本文主要介绍了Go语言内建函数cap的实现示例,具有一定的参考价值,感兴趣的可以了解一下
2024-08-08
go语言检测文件是否存在的方法
这篇文章主要介绍了go语言检测文件是否存在的方法,实例分析了Go语言文件操作的相关技巧,需要的朋友可以参考下
2015-03-03
Go标准库常见错误分析和解决办法
Go语言的标准库为开发者提供了丰富且高效的工具,涵盖了从网络编程到文件操作等各个方面,然而,标准库虽好,使用不当却可能适得其反,正所谓"工欲善其事,必先利其器",本文将深入剖析Go标准库使用中的常见错误,帮助开发者避开这些坑,写出更加健壮的代码
2025-04-04
详解如何利用Golang泛型提高编码效率
Golang的泛型已经出来有一段时间了，大家应该或多或少对它有所了解。虽然Golang的泛型在功能上确实比较简单，而且确实可能会增加代码的复杂度，过度使用可能还会降低代码可读性。本文就来介绍一下Golang泛型的相关知识吧
2023-04-04
Go切片扩容机制详细说明和举例
Go 语言中的切片是一种动态数组,它可以自动扩容和缩容以适应不同的数据量,这篇文章主要给大家介绍了关于Go切片扩容机制详细说明和举例的相关资料,文中通过代码介绍的非常详细,需要的朋友可以参考下
2024-03-03
在Go中编写测试代码的方法总结
在程序开发过程中，测试是非常重要的一环，甚至有一种开发模式叫 TDD，先编写测试，再编写功能代码，通过测试来推动整个开发的进行，可见测试在开发中的重要程度，为此，Go提供了testing框架来方便我们编写测试，本文将向大家介绍在Go中如何编写测试代码
2023-07-07
go实现base64编码的四种方式
本文主要介绍了go实现base64编码的四种方式，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2023-03-03
golang使用mapstructure解析json
mapstructure 是一个 Go 库,用于将通用映射值解码为结构,这篇文章主要来和大家介绍一下golang如何使用mapstructure解析json,需要的可以参考下
2023-12-12