Spring Boot不同环境下如何按需绑定@ConfigurationProperties类

针对你遇到的test2环境因未配置app.cash.conn属性组导致配置绑定校验失败的问题，除了移除@NotNull注解外，还有以下几种更合理的解决方案：

方案一：通过@Profile限制配置类仅在指定环境生效 #

直接给CashBoxConnectionProperties类添加@Profile注解，指定它仅在需要的Profile（比如test1）下被Spring加载。这样test2环境启动时，这个配置类不会被实例化，自然不会触发校验逻辑。

修改后的代码示例：

@Getter
@Validated
@ConstructorBinding
@ConfigurationProperties(value = "app.cash.conn")
@RequiredArgsConstructor
@Profile("test1") // 仅在test1环境下加载该配置类
public class CashBoxConnectionProperties {

    @NotNull
    @Positive
    private final Integer connectionTimeout;

    @NotNull
    @Positive
    private final Integer responseTimeout;

    @NotNull
    @PositiveOrZero
    private final Integer retryMaxAttempts;

    @NotNull
    @Positive
    private final Integer retryMaxDelay;

}

注意：如果你的配置类是通过@EnableConfigurationProperties手动注册的，确保该注解所在的配置类没有全局生效的Profile限制，或者也给它加上对应的@Profile。

方案二：使用@ConditionalOnProperty根据配置存在性加载类 #

通过@ConditionalOnProperty注解，只有当app.cash.conn前缀下存在配置属性时，才加载这个配置类。这种方式比@Profile更灵活，不局限于固定的Profile名称，只要有对应配置就生效。

修改后的代码示例：

@Getter
@Validated
@ConstructorBinding
@ConfigurationProperties(value = "app.cash.conn")
@RequiredArgsConstructor
// 当app.cash.conn前缀下有任意属性存在时才加载
@ConditionalOnProperty(prefix = "app.cash.conn", name = "*", matchIfMissing = false)
public class CashBoxConnectionProperties {

    // 原有属性和注解保持不变...

}

如果你想更精准，可以指定具体的必填属性（比如connection-timeout），确保只有该属性存在时才加载：

@ConditionalOnProperty(prefix = "app.cash.conn", name = "connection-timeout")

方案三：分组校验控制校验生效的环境 #

如果你的场景是test2环境下仍需要加载这个配置类，但不需要校验属性非空，可以通过校验分组来实现：

1. 定义一个校验分组接口：

public interface Test1ValidationGroup {}

2. 修改配置类，将@NotNull等校验注解绑定到该分组：

@Getter
@Validated(Test1ValidationGroup.class)
@ConstructorBinding
@ConfigurationProperties(value = "app.cash.conn")
@RequiredArgsConstructor
public class CashBoxConnectionProperties {

    @NotNull(groups = Test1ValidationGroup.class)
    @Positive(groups = Test1ValidationGroup.class)
    private final Integer connectionTimeout;

    // 其他属性同理，将校验注解的groups指定为Test1ValidationGroup...

}

3. 仅在test1环境下启用该分组校验：可以通过给注册配置类的@Configuration类添加@Profile("test1")，或者结合@Conditional注解实现。

这种方式适合配置类需要跨环境存在，但仅在特定环境下需要严格校验的场景。

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