快捷導(dǎo)航

go使用Viper管理配置文件的方法步驟

更新時(shí)間：2024年07月22日 08:38:00 作者：考慮考慮

在項(xiàng)目開(kāi)發(fā)中,需要把一些配置配置提取出來(lái),方便配置和管理,可以使用Viper工具,Viper 是 Go 應(yīng)用程序的完整配置解決方案,也支持從環(huán)境變量中讀取,本文給大家介紹了go使用Viper管理配置文件的方法步驟,需要的朋友可以參考下

前言

在項(xiàng)目開(kāi)發(fā)中，需要把一些配置配置提取出來(lái)，方便配置和管理，可以使用Viper工具，Viper 是 Go 應(yīng)用程序的完整配置解決方案，也支持從環(huán)境變量中讀取

viper使用

viper倉(cāng)庫(kù)為

 https://github.com/spf13/viper?tab=readme-ov-file

viper依賴安裝

使用以下命令安裝viper依賴

 go get github.com/spf13/viper

viper使用

（1）定義一個(gè)yaml配置文件，如

app:
  name: hello
  config: 1

放在config文件下

（2）程序讀取配置文件，使用程序

package main

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

type App struct {
    Name   string
    Config int64
}

type User struct {
    App App
}

func main() {
    viperConfig := viper.New()
    // 查找配置文件所在的路徑
    viperConfig.AddConfigPath("./config")
    // 如果配置文件的名稱(chēng)中沒(méi)有擴(kuò)展名，則需要配置此項(xiàng)
    viperConfig.SetConfigType("yml")
    // 配置文件名稱(chēng)(無(wú)擴(kuò)展名)
    viperConfig.SetConfigName("app")
    if err := viperConfig.ReadInConfig(); err != nil {
       if _, ok := err.(viper.ConfigFileNotFoundError); ok {
          // 配置文件未找到錯(cuò)誤；如果需要可以忽略
          log.Println("配置文件沒(méi)找到")
       } else {
          // 配置文件被找到，但產(chǎn)生了另外的錯(cuò)誤
          log.Println("讀取文件異常:", err)
       }
    }
    var user User
    err := viperConfig.Unmarshal(&user)
    log.Println(user)
    log.Println("解析異常:", err)

}

將配置文件轉(zhuǎn)為對(duì)象，輸出結(jié)果為

（3）也可以不將配置文件轉(zhuǎn)換成類(lèi)，直接使用鍵值取值

package main

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

type App struct {
    Name   string
    Config int64
}

type User struct {
    App App
}

func main() {
    viperConfig := viper.New()
    // 查找配置文件所在的路徑
    viperConfig.AddConfigPath("./config")
    // 如果配置文件的名稱(chēng)中沒(méi)有擴(kuò)展名，則需要配置此項(xiàng)
    viperConfig.SetConfigType("yml")
    // 配置文件名稱(chēng)(無(wú)擴(kuò)展名)
    viperConfig.SetConfigName("app")
    if err := viperConfig.ReadInConfig(); err != nil {
       if _, ok := err.(viper.ConfigFileNotFoundError); ok {
          // 配置文件未找到錯(cuò)誤；如果需要可以忽略
          log.Println("配置文件沒(méi)找到")
       } else {
          // 配置文件被找到，但產(chǎn)生了另外的錯(cuò)誤
          log.Println("讀取文件異常:", err)
       }
    }
    log.Println("值為:", viperConfig.Get("app.name"))
    log.Println("值為:", viperConfig.Get("app.config"))

}

輸出結(jié)果為

viper寫(xiě)入文件

在開(kāi)發(fā)過(guò)程中，我們?nèi)绻胿iper寫(xiě)入文件，可以使用

package main

import "github.com/spf13/viper"


func main() {
    viper.Set("app.test", "aaa1")
    //viper.WriteConfig()
    viper.WriteConfigAs("./config/app.yaml")

}