使用 go-ssm-config 从 AWS SSM 参数存储加载配置

go-ssm-config 是一个方便的 Go 库，用于从 AWS Systems Manager (SSM) 参数存储中加载配置参数。下面我将详细介绍如何使用这个库。

安装

首先安装 go-ssm-config 库：

go get github.com/ianlopshire/go-ssm-config

基本用法

1. 定义配置结构

首先定义一个结构体来映射你的配置参数：

type Config struct {
    DatabaseURL      string `ssm:"/myapp/database_url"`
    APIKey           string `ssm:"/myapp/api_key,required"`
    MaxConnections   int    `ssm:"/myapp/max_connections"`
    DebugMode        bool   `ssm:"/myapp/debug_mode"`
    FeatureFlags     string `ssm:"/myapp/feature_flags,default=stable"`
}

标签说明：

• ssm:"path" - 指定 SSM 中的参数路径
• required - 表示该参数是必需的
• default=value - 设置默认值（当参数不存在时使用）

2. 加载配置

package main

import (
    "fmt"
    "log"

    "github.com/aws/aws-sdk-go/aws/session"
    "github.com/ianlopshire/go-ssm-config"
)

func main() {
    // 创建 AWS 会话
    sess := session.Must(session.NewSessionWithOptions(session.Options{
        SharedConfigState: session.SharedConfigEnable,
    }))

    // 初始化配置
    var cfg Config
    err := ssmconfig.Load(sess, &cfg)
    if err != nil {
        log.Fatalf("failed to load config: %v", err)
    }

    fmt.Printf("Loaded config: %+v\n", cfg)
}

高级用法

1. 使用前缀

如果你的所有参数都有共同的前缀，可以使用 WithPrefix 选项：

err := ssmconfig.Load(sess, &cfg, 
    ssmconfig.WithPrefix("/myapp/production/"))

这样结构体标签中的路径会自动添加此前缀。

2. 自定义参数名称转换

默认情况下，结构体字段名会转换为小写加下划线的形式。你可以自定义这个行为：

err := ssmconfig.Load(sess, &cfg,
    ssmconfig.WithFieldNameFn(func(fieldName string) string {
        // 自定义转换逻辑
        return strings.ToLower(fieldName)
    }))

3. 从环境变量覆盖

你可以设置优先从环境变量读取值：

err := ssmconfig.Load(sess, &cfg,
    ssmconfig.WithEnvOverride(true))

4. 解密安全字符串

对于 SecureString 类型的参数，库会自动解密：

type Config struct {
    SecretToken string `ssm:"/myapp/secret_token,secure"`
}

完整示例

package main

import (
    "fmt"
    "log"

    "github.com/aws/aws-sdk-go/aws/session"
    "github.com/ianlopshire/go-ssm-config"
)

type AppConfig struct {
    DBHost     string `ssm:"/app/db_host,required"`
    DBPort     int    `ssm:"/app/db_port,default=5432"`
    DBUser     string `ssm:"/app/db_user"`
    DBPassword string `ssm:"/app/db_password,secure"`
    Debug      bool   `ssm:"/app/debug_mode,default=false"`
}

func main() {
    // 初始化 AWS 会话
    sess, err := session.NewSession()
    if err != nil {
        log.Fatalf("failed to create AWS session: %v", err)
    }

    // 加载配置
    var cfg AppConfig
    err = ssmconfig.Load(sess, &cfg, 
        ssmconfig.WithPrefix("/production/"),
        ssmconfig.WithEnvOverride(true))
    
    if err != nil {
        log.Fatalf("failed to load config: %v", err)
    }

    fmt.Printf("Database configuration:\n")
    fmt.Printf("Host: %s\n", cfg.DBHost)
    fmt.Printf("Port: %d\n", cfg.DBPort)
    fmt.Printf("User: %s\n", cfg.DBUser)
    fmt.Printf("Debug mode: %v\n", cfg.Debug)
}

最佳实践

1. 错误处理：总是检查 Load 方法的错误返回
2. 敏感信息：使用 secure 标签标记敏感参数
3. 环境分离：使用前缀区分不同环境（开发/测试/生产）
4. 默认值：为可选参数设置合理的默认值
5. IAM 权限：确保执行代码的 IAM 角色有 ssm:GetParameters 权限

注意事项

1. 参数存储有 API 调用限制，考虑批量获取参数
2. 对于大量参数，考虑使用缓存策略
3. 在 Lambda 等无服务器环境中，可以利用 SSM 参数缓存

go-ssm-config 提供了一种简洁的方式来管理 AWS 环境中的配置，避免了将敏感信息硬编码在代码或配置文件中。