Micronaut如何正确绑定YAML列表到不可变配置接口

问题原因 #

Micronaut默认不会自动识别配置接口中集合元素的嵌套配置类型，没有显式声明的情况下框架会跳过子属性的绑定逻辑，导致最终得到的instances列表为空。

解决方法 #

你可以任选下面两种方案的一种即可修复绑定问题：

方案1：添加嵌套配置注解

在getInstances()方法上添加@NestedConfiguration注解，显式告诉Micronaut该属性是嵌套配置类型，需要递归绑定子属性：

import io.micronaut.context.annotation.ConfigurationProperties;
import io.micronaut.context.annotation.NestedConfiguration;
import java.net.URL;
import java.util.List;

@ConfigurationProperties("a.b")
public interface MyConfig {

  @NestedConfiguration
  List<Instance> getInstances();

  interface Instance {
    String getName();
    URL getEndpoint();
    String getVersion();
    int getReadTimeout();
  }
}

方案2：使用Record类定义不可变配置

Micronaut 2.5+版本已经支持Java Record类型的配置绑定，不可变特性更明确，绑定成功率更高：

import io.micronaut.context.annotation.ConfigurationProperties;
import java.net.URL;
import java.util.List;

@ConfigurationProperties("a.b")
public record MyConfig(List<Instance> instances) {
  public record Instance(
    String name,
    URL endpoint,
    String version,
    int readTimeout
  ){}
}

额外检查项 #

如果修改后仍然绑定失败，请确认以下两点：

• 项目已经正确引入Micronaut注解处理器依赖，Maven/Gradle配置中包含micronaut-inject-java的注解处理器声明，否则配置绑定的实现类无法正常生成。
• YAML配置文件存放路径正确：测试用配置放在src/test/resources/application.yml，生产配置放在src/main/resources/application.yml，YAML的缩进格式没有错误。

内容的提问来源于stack exchange，提问作者saw303