如何基于配置属性实现SpringBoot请求字段的可开关验证？

要实现基于配置开关的字段验证，需要自定义校验注解和对应的校验器，结合Spring的配置读取能力动态控制验证逻辑，具体步骤如下：

1. 创建自定义条件校验注解 #

新建@ConditionalNotEmpty注解，标记需要根据配置开关验证的字段，注解中定义配置属性的key，供校验器读取开关状态：

import jakarta.validation.Constraint;
import jakarta.validation.Payload;
import java.lang.annotation.*;

@Target({ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
@Constraint(validatedBy = ConditionalNotEmptyValidator.class)
public @interface ConditionalNotEmpty {
    String message() default "字段不能为空";
    
    Class<?>[] groups() default {};
    
    Class<? extends Payload>[] payload() default {};
    
    // 指定读取开关状态的配置属性key
    String configKey();
}

2. 实现自定义校验器 #

编写ConditionalNotEmptyValidator实现ConstraintValidator接口，注入Environment读取配置，根据开关状态决定是否执行验证：

import jakarta.validation.ConstraintValidator;
import jakarta.validation.ConstraintValidatorContext;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.core.env.Environment;

public class ConditionalNotEmptyValidator implements ConstraintValidator<ConditionalNotEmpty, String> {

    @Autowired
    private Environment environment;
    
    private String configKey;

    @Override
    public void initialize(ConditionalNotEmpty constraintAnnotation) {
        this.configKey = constraintAnnotation.configKey();
    }

    @Override
    public boolean isValid(String value, ConstraintValidatorContext context) {
        // 读取配置开关，默认关闭验证
        boolean validateEnabled = Boolean.parseBoolean(environment.getProperty(configKey, "false"));
        
        if (!validateEnabled) {
            return true;
        }
        
        // 开关开启时执行非空校验
        return value != null && !value.trim().isEmpty();
    }
}

3. 修改请求实体类 #

将目标字段替换为自定义注解，指定对应的配置属性key：

import jakarta.validation.constraints.NotEmpty;

record SomeRequest(

    @NotEmpty
    String alwaysValidateMe,
    
    @ConditionalNotEmpty(
        message = "仅当配置开启时此字段不能为空",
        configKey = "validate.field.onlyValidateMeIfConfigured"
    )
    String onlyValidateMeIfConfigured

) {
}

4. 验证效果 #

• 当application.properties中validate.field.onlyValidateMeIfConfigured=true时，若onlyValidateMeIfConfigured为空，会触发校验失败，返回400错误。
• 当配置值为false时，无论该字段是否为空，校验都会直接通过。

注意事项 #

• 自定义校验器放在Spring Boot主类的包或子包下即可被自动扫描识别，无需额外注解。
• 若需支持其他类型字段（如Integer），可扩展校验器的泛型类型，或创建新的自定义注解和校验器。

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