Spring Boot读取application.yml中is-enabled布尔字段始终为默认false问题

问题场景 #

在Spring Boot项目中，尝试在application.yml中定义is-enabled: true，但通过@ConfigurationProperties绑定到Java类的boolean isEnabled字段时，始终读取到默认值false；将yaml中的键改为enabled: true后，就能正常读取到true。

相关代码 #

application.yml（绑定失败的配置）

name: test-YAML
environment: testing
is-enabled: true

配置类

@Configuration
@EnableConfigurationProperties
@ConfigurationProperties
@Data
public class YAMLConfig {
    private String name;
    private String environment;
    private boolean isEnabled;
    // 其他字段省略
}

主应用代码

@SpringBootApplication
public class MyApplication implements CommandLineRunner {

    @Autowired
    private YAMLConfig myConfig;

    public static void main(String[] args) {
        SpringApplication.run(MyApplication.class, args);
    }

    @Override
    public void run(String... args) throws Exception {
        System.out.println("name:" + myConfig.getName());
        System.out.println("enabled:" + myConfig.isEnabled()); // 输出enabled: false
    }
}

原因分析 #

这不是YAML文件的命名限制，而是Spring Boot的@ConfigurationProperties绑定规则遵循JavaBean规范导致的特殊处理：

• 对于布尔类型的字段，如果字段名以is开头（如isEnabled），JavaBean规范会将其对应的属性名认定为去掉is后的部分（即enabled），而非原字段名的kebab-case形式（is-enabled）。
• Spring Boot在处理属性绑定时，会按照这个规则匹配外部配置键：当yaml中写is-enabled时，转换为camelCase是isEnabled，但Spring期望的属性名是enabled，因此无法匹配，最终使用字段的默认值false；当yaml中写enabled: true时，刚好匹配到isEnabled字段对应的属性名，就能正常绑定值。

解决方案 #

方案1：遵循JavaBean规范修改配置键（推荐） #

将application.yml中的is-enabled改为enabled，保持Java类字段不变：

name: test-YAML
environment: testing
enabled: true

此时Spring会自动将enabled的值绑定到isEnabled字段，输出结果为enabled: true。

方案2：通过注解指定属性名（Spring Boot 2.2+支持） #

如果需要保留yaml中的is-enabled键，可以在字段上添加@PropertyName注解，强制指定绑定的配置键：

@Configuration
@EnableConfigurationProperties
@ConfigurationProperties
@Data
public class YAMLConfig {
    private String name;
    private String environment;
    @PropertyName("is-enabled")
    private boolean isEnabled;
    // 其他字段省略
}

这样yaml中的is-enabled: true就能正确绑定到isEnabled字段。

总结 #

Spring Boot的属性绑定逻辑严格遵循JavaBean规范，对于布尔类型的isXXX字段，对应的外部配置键应为xxx（kebab-case为xxx）而非is-xxx。按照规范调整配置或通过注解显式指定，即可解决绑定失败的问题。

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