Go 語言讀取 YAML 配置文件教程

在 Go 語言項目中，處理配置文件是一項常見的任務。

YAML 是一種易讀易寫的配置文件格式，本教程將指導你如何在 Go 中讀取和解析 YAML 文件。

我們將按照章節的形式逐步介紹相關的概念和示例代碼。

第一章：引入依賴

在開始之前，我們需要引入一個 YAML 解析的第三方庫。推薦使用 gopkg.in/yaml.v2。

go get gopkg.in/yaml.v2

第二章：創建 YAML 文件

首先，我們創建一個簡單的 YAML 文件作爲示例。假設我們有一個配置文件 config.yaml，內容如下：

app:
  name: MyGoApp
  version: 1.0
database:
  host: localhost
  port: 3306
  username: root
  password: mypassword

第三章：編寫代碼讀取 YAML 文件

接下來，我們將編寫 Go 代碼來讀取和解析上述 YAML 文件。

package main

import (
 "fmt"
 "io/ioutil"
 "log"
 "os"

 "gopkg.in/yaml.v2"
)

// Configuration 結構體用於映射 YAML 文件的結構
type Configuration struct {
 App      AppConfiguration      `yaml:"app"`
 Database DatabaseConfiguration `yaml:"database"`
}

// AppConfiguration 結構體映射 YAML 文件中的 app 部分
type AppConfiguration struct {
 Name    string `yaml:"name"`
 Version string `yaml:"version"`
}

// DatabaseConfiguration 結構體映射 YAML 文件中的 database 部分
type DatabaseConfiguration struct {
 Host     string `yaml:"host"`
 Port     int    `yaml:"port"`
 Username string `yaml:"username"`
 Password string `yaml:"password"`
}

func main() {
 // 讀取 YAML 文件內容
 yamlFile, err := ioutil.ReadFile("config.yaml")
 if err != nil {
  log.Fatalf("無法讀取 YAML 文件: %v", err)
 }

 // 解析 YAML 文件到 Configuration 結構體
 var config Configuration
 err = yaml.Unmarshal(yamlFile, &config)
 if err != nil {
  log.Fatalf("無法解析 YAML 文件: %v", err)
 }

 // 打印解析後的配置信息
 fmt.Printf("應用名稱: %s\n", config.App.Name)
 fmt.Printf("應用版本: %s\n", config.App.Version)
 fmt.Printf("數據庫主機: %s\n", config.Database.Host)
 fmt.Printf("數據庫端口: %d\n", config.Database.Port)
 fmt.Printf("數據庫用戶名: %s\n", config.Database.Username)
 fmt.Printf("數據庫密碼: %s\n", config.Database.Password)
}

第四章：運行示例

現在，我們可以運行示例代碼來讀取和解析 config.yaml 文件。

go run main.go

如果一切順利，你將看到輸出的應用和數據庫配置信息。

第五章：環境變量覆蓋值

有些時候我們可能需要從環境變量裏面去獲取配置參數，那麼我們可以使用os.Getenv 方法從系統環境變量中獲取參數。

代碼可以調整下：

func main() {
 // 讀取 YAML 文件內容
 yamlFile, err := ioutil.ReadFile("config.yaml")
 if err != nil {
  log.Fatalf("無法讀取 YAML 文件: %v", err)
 }

 // 解析 YAML 文件到 Configuration 結構體
 var config Configuration
 err = yaml.Unmarshal(yamlFile, &config)
 if err != nil {
  log.Fatalf("無法解析 YAML 文件: %v", err)
 }

 // 從系統環境變量中獲取參數，如果存在則覆蓋對應的配置
 if envName := os.Getenv("APP_NAME"); envName != "" {
  config.App.Name = envName
 }

 // 打印解析後的配置信息
 fmt.Printf("應用名稱: %s\n", config.App.Name)
 fmt.Printf("應用版本: %s\n", config.App.Version)
 fmt.Printf("數據庫主機: %s\n", config.Database.Host)
 fmt.Printf("數據庫端口: %d\n", config.Database.Port)
 fmt.Printf("數據庫用戶名: %s\n", config.Database.Username)
 fmt.Printf("數據庫密碼: %s\n", config.Database.Password)
}

現在，我們可以運行示例代碼來讀取和解析 config.yaml 文件，並通過環境變量覆蓋配置。

APP_NAME=CustomAppName go run main.go

應用名稱將被環境變量中的值覆蓋。

通過這個簡單的示例，你已經學會了如何從系統環境變量中獲取參數，並整合到讀取和解析 YAML 文件的代碼中。這使得你的應用更加靈活，能夠根據不同的運行環境進行配置。

本文由 Readfog 進行 AMP 轉碼，版權歸原作者所有。
來源：https://mp.weixin.qq.com/s/kkUIFgFVeKWx-7gA0hR2LQ

猜你喜歡