如何将同一配置前缀绑定到多个Spring ConfigurationProperties类
报错核心原因
默认情况下@ConfigurationProperties注解的ignoreUnknownFields属性为false,Spring绑定配置时会校验该前缀下的所有配置项是否都被当前配置类接收。你将同一个前缀的配置拆分到多个类后,单个配置类仅包含部分字段,其余字段会被识别为「未绑定项」,最终抛出启动失败错误。
解决方案
方案1:单配置类开启忽略未知字段(最推荐,粒度可控)
给所有使用相同foo前缀的配置类,在@ConfigurationProperties注解中添加ignoreUnknownFields = true属性,让Spring绑定时自动忽略当前类不存在的配置项,不会抛出未绑定错误,同时不影响其他配置类的校验逻辑。
示例代码:
package one下的AProperties:
@Data @Validated @Component @ConfigurationProperties(prefix = "foo", ignoreUnknownFields = true) public class AProperties { @NotBlank private String a; }
package two下的BProperties:
@Data @Validated @Component @ConfigurationProperties(prefix = "foo", ignoreUnknownFields = true) public class BProperties { @NotBlank private String b; }
剩余的C、D对应的配置类也按相同规则修改即可,各配置类的字段校验逻辑互不影响,可正常生效。
方案2:全局关闭未知字段校验(不推荐,影响范围大)
如果项目中大量存在同前缀拆分配置的场景,可以在全局配置中添加以下配置,关闭所有配置类的未知字段校验:
spring: configuration-properties: ignore-unknown-fields: true
该方案会全局关闭校验,无法针对单个配置类做严格校验,可能会漏掉配置拼写错误的问题,非必要不建议使用。
注意事项
- 不同配置类中的字段不要重名,否则会出现绑定值覆盖的问题
- 各配置类仍可以正常使用
@Validated以及相关校验注解做字段合法性校验
内容的提问来源于stack exchange,提问作者CloudSen
相关产品推荐
相关产品推荐

