Go 语言读取 YAML 配置文件教程

小锟哥哥

发布于 2023-11-27 18:31:34

1.1K0

发布于 2023-11-27 18:31:34

文章被收录于专栏：GoLang全栈GoLang全栈

在 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 文件，并通过环境变量覆盖配置。