如何按需抑制并记录Spring Boot自定义配置属性约束校验违规？

1. 完整实现方案 #

推荐结合配置属性绑定+自定义校验器+Spring扩展校验上下文来实现，核心是让校验器同时获取配置开关和属性路径，实现条件化的告警/失败逻辑：

步骤1：完善自定义注解与校验器 #

给校验器注入配置开关，同时通过Spring扩展的校验上下文获取完整属性路径：

// DeprecatedField.java
@Target({METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE})
@Retention(RUNTIME)
@Documented
@Constraint(validatedBy = DeprecatedFieldValidator.class)
public @interface DeprecatedField {
    String message() default "该属性已废弃，请移除";
    Class<?>[] groups() default {};
    Class<? extends Payload>[] payload() default {};
}

// DeprecatedFieldValidator.java
@Slf4j
public class DeprecatedFieldValidator implements ConstraintValidator<DeprecatedField, Object> {

    @Value("${my.props.fail-on-deprecation:true}")
    private boolean failOnDeprecation;

    @Override
    public void initialize(DeprecatedField annotation) {}

    @Override
    public boolean isValid(Object value, ConstraintValidatorContext context) {
        if (value == null) {
            return true;
        }

        // 从Spring扩展上下文提取完整属性路径
        String propertyPath = context.unwrap(SpringConstraintValidatorContext.class)
                .getConstraintDescriptor()
                .getElementContext()
                .getPropertyPath()
                .toString();

        if (failOnDeprecation) {
            // 启动失败模式：返回false触发约束异常
            return false;
        } else {
            // 告警模式：记录日志并返回true跳过失败
            log.warn("已废弃属性 [{}] 仍在使用，值为: {}", propertyPath, value);
            return true;
        }
    }
}

步骤2：确保配置类校验生效 #

你的CustomConfig类无需修改，但要在启动类上添加@ConfigurationPropertiesScan以激活配置属性扫描：

@SpringBootApplication
@ConfigurationPropertiesScan
public class YourApplication {
    public static void main(String[] args) {
        SpringApplication.run(YourApplication.class, args);
    }
}

步骤3：验证效果 #

• 当my.props.fail-on-deprecation=true且my.custom.props.bar有值时，应用启动会抛出ConstraintViolationException导致失败
• 当my.props.fail-on-deprecation=false时，校验器会输出包含完整属性路径的警告日志，应用正常启动

2. 方案1中获取完整属性路径的方法 #

可以通过ConstraintValidatorContext的unwrap方法获取SpringConstraintValidatorContext——这是Spring对标准校验上下文的扩展，内置了属性路径信息：

String propertyPath = context.unwrap(SpringConstraintValidatorContext.class)
        .getConstraintDescriptor()
        .getElementContext()
        .getPropertyPath()
        .toString();

获取到的路径会包含完整配置前缀（比如my.custom.props.bar），完全满足日志需求。

3. Spring Boot推荐的实现模式 #

Spring Boot官方推荐使用自定义约束注解+Spring扩展校验上下文的方式处理配置属性的复杂校验，这种方案无需替换核心Bean（避免方案2的冲突风险），同时能灵活结合配置开关实现条件逻辑。

如果需要全局控制，也可以实现ConfigurationPropertiesValidator接口，但针对废弃属性这类场景，上述校验器扩展方案是最简洁、符合官方设计的模式。

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