go项目中环境变量的配置

一、为什么要配置文件

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

二、在go中使用配置文件

• 1、viper网站地址

• 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)
  }
  复制代码