Micronaut Core项目中自定义AWS SSM配置加载的实现与问题解析

2025-06-03 00:30:30作者：凤尚柏Louis

背景介绍

在Micronaut框架中，配置管理是一个核心功能，开发者经常需要从各种来源加载配置信息。AWS Systems Manager Parameter Store(SSM)是AWS提供的一种安全存储配置数据和密钥的服务。本文探讨在Micronaut 4.2.x版本中实现自定义AWS SSM配置加载时遇到的问题及其解决方案。

问题现象

开发者尝试通过自定义AbstractPropertySourceLoader实现从AWS SSM加载JSON格式的配置到Micronaut环境变量中。配置格式如下：

{
  "MCA_DOWNSTREAM_URL": "<Some URL>",
  "MCA_DOWNSTREAM_TIMEZONE": "<Some Timezone>"
}

虽然自定义加载器逻辑看似正确，但配置值并未按预期加载到环境变量中。

初始解决方案分析

开发者最初尝试了两种实现方式：

自定义PropertySourceLoader：继承EnvJsonPropertySourceLoader并实现processInput方法，通过AWS SDK获取参数值
服务注册：在META-INF/services/io.micronaut.context.env.PropertySourceLoader中注册自定义加载器

然而这两种方式都未能成功加载配置，主要原因是：

PropertySourceLoader实现类不能作为Bean被Micronaut管理
加载时机可能不正确，导致配置未被及时加载

正确实现方案

经过社区讨论，正确的实现方式应该是使用ConfigurationClient接口而非PropertySourceLoader。以下是关键实现要点：

1. 自定义ConfigurationClient实现

@Singleton
@Requires(env = Environment.AMAZON_EC2)
@BootstrapContextCompatible
public class CustomSSMConfigClient implements ConfigurationClient {
    
    private final CustomSSMConfiguration config;
    private final SsmAsyncClient client;
    private final ObjectMapper jsonMapper;

    @Override
    public Publisher<PropertySource> getPropertySources(Environment env) {
        if (!config.isEnabled()) {
            return Flux.empty();
        }

        return Mono.fromFuture(this::loadConfiguration)
                .map(configMap -> PropertySource.of(config.getParameterStorePath(), configMap))
                .flux();
    }

    private CompletableFuture<Map<String, Object>> loadConfiguration() {
        GetParameterRequest request = GetParameterRequest.builder()
                .name(config.getParameterStorePath())
                .withDecryption(config.getUseSecureParameters())
                .build();

        return client.getParameter(request)
                .thenApply(response -> {
                    try {
                        return jsonMapper.readValue(response.parameter().value(), Map.class);
                    } catch (Exception e) {
                        throw new RuntimeException("Error parsing JSON", e);
                    }
                });
    }
}

2. 配置类设计

@ConfigurationProperties("custom.ssm.parameterstore")
@Requires(env = Environment.AMAZON_EC2)
public class CustomSSMConfiguration implements Toggleable {
    
    private boolean enabled;
    private boolean useSecureParameters;
    private String parameterStorePath;
    
    // getters and setters
}