目錄
- 一、為什么要配置文件
- 二、在go中使用配置文件
- 三、使用結(jié)構(gòu)體的方式讀取
- 四、區(qū)分開發(fā)環(huán)境和生產(chǎn)環(huán)境
- 五、在gin中集成配置文件
一、為什么要配置文件
1、容易編輯，配置比較集中，方便修改，在大業(yè)務量的系統(tǒng)里面，通過配置會方便后人理解整個系統(tǒng)的架構(gòu)
2、做到業(yè)務代碼和環(huán)境解耦，環(huán)境配置變量不侵入到代碼層面
3、不同的環(huán)境切換比較方便
二、在go中使用配置文件
1、viper網(wǎng)站地址
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、在文件的同級下創(chuàng)建一個config.yaml的文件
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"))
}
三、使用結(jié)構(gòu)體的方式讀取
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("解析結(jié)構(gòu)體失敗", err)
}
fmt.Println(serverConfig.Name)
}
2、結(jié)構(gòu)體的嵌套，很常見的是mysql數(shù)據(jù)庫的配置
// 定義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)
四、區(qū)分開發(fā)環(huán)境和生產(chǎn)環(huán)境
1、在mac電腦上配置環(huán)境變量，在.bash_profile中導出一個環(huán)境變量，注意要關(guān)閉goland重新打開
# vim .bash_profile
export IS_DEV= true
source .bash_profile
2、定義方法直接獲取環(huán)境變量
func GetEnvInfo(env string) bool {
viper.AutomaticEnv()
return viper.GetBool(env)
}
func main() {
fmt.Println(GetEnvInfo("IS_DEV"))
}
3、在目錄下創(chuàng)建一個application.dev.yml和application.prod.yml的文件，分別存放不同環(huán)境下的配置
4、使用環(huán)境變量來讀取配置完整代碼
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("解析結(jié)構(gòu)體失敗", err)
}
fmt.Println(serverConfig.MySqlConfig)
}
五、在gin中集成配置文件
1、在和main.go同級的目錄下創(chuàng)建兩個xx.yml的文件
2、目錄下創(chuàng)建一個config、global、initialize的文件夾
3、在config/config.go的文件中書寫使用結(jié)構(gòu)體讀取配置的
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)
}
到此這篇關(guān)于go項目中環(huán)境變量的配置的文章就介紹到這了,更多相關(guān)go 環(huán)境變量配置內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！
