在 Golang 中读取 YAML 配置文件,可以使用第三方库如 gopkg.in/yaml.v2
或 gopkg.in/yaml.v3
(推荐使用 v3)。以下是详细步骤和示例代码:
1. 安装 YAML 库
go get gopkg.in/yaml.v3
2. 示例 YAML 文件
假设有一个配置文件 config.yml
:
server:
port: 8080
host: "0.0.0.0"
database:
username: "admin"
password: "secret"
3. Go 代码解析 YAML
(1) 定义结构体
结构体字段需要与 YAML 的键名匹配(支持嵌套):
type Config struct {
Server struct {
Port int `yaml:"port"`
Host string `yaml:"host"`
} `yaml:"server"`
Database struct {
Username string `yaml:"username"`
Password string `yaml:"password"`
} `yaml:"database"`
}
(2) 读取并解析文件
package main
import (
"fmt"
"os"
"gopkg.in/yaml.v3"
)
func main() {
// 读取文件
data, err := os.ReadFile("config.yml")
if err != nil {
panic(err)
}
// 解析到结构体
var config Config
err = yaml.Unmarshal(data, &config)
if err != nil {
panic(err)
}
// 打印配置
fmt.Printf("Server: %+v\n", config.Server)
fmt.Printf("Database: %+v\n", config.Database)
}
输出结果:
Server: {Port:8080 Host:0.0.0.0}
Database: {Username:admin Password:secret}
4. 动态读取(无结构体)
如果需要动态解析为 map
:
var config map[string]interface{}
err = yaml.Unmarshal(data, &config)
fmt.Println(config["server"].(map[string]interface{})["port"]) // 8080
5. Viper(高级配置管理)
如果需要支持多格式(YAML/JSON/ENV等),推荐使用 Viper:
import "github.com/spf13/viper"
func main() {
v := viper.New()
v.SetConfigFile("config.yml")
err := v.ReadInConfig()
if err != nil {
panic(err)
}
fmt.Println(v.GetInt("server.port")) // 8080
}
常见问题
- 字段不匹配:确保结构体的
yaml
tag 与文件中的键名一致。 - 缩进错误:YAML 对缩进敏感,需用空格(不能混用 Tab)。
- 默认值:可以通过结构体的字段初始化设置默认值。
如果有更复杂的需求(如环境变量覆盖),可以结合 Viper + YAML。
内容由零声教学AI助手提供,问题来源于学员提问