如何在javax.validation注解中使用application配置文件的属性值

Java 注解的入参必须是编译期常量，而 application.yaml 中的配置是运行期才会加载到 Spring 上下文的，因此直接把配置值传入原生 @Max 注解不可行，可行方案是自定义支持动态读取配置的校验注解，具体实现步骤如下：

实现步骤 #

1. 自定义校验注解 #

首先定义一个功能和 @Max 一致，但是支持从配置读取阈值的注解：

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

@Target({ElementType.FIELD, ElementType.PARAMETER})
@Retention(RetentionPolicy.RUNTIME)
@Constraint(validatedBy = ConfigurableMaxValidator.class)
public @interface ConfigurableMax {
    String message() default "数值超过允许的最大值";
    Class<?>[] groups() default {};
    Class<? extends Payload>[] payload() default {};
}

2. 实现校验器逻辑 #

编写对应校验器，直接注入你在 yaml 中定义的配置项：

import org.springframework.beans.factory.annotation.Value;
import javax.validation.ConstraintValidator;
import javax.validation.ConstraintValidatorContext;

public class ConfigurableMaxValidator implements ConstraintValidator<ConfigurableMax, Long> {

    // 直接注入配置值
    @Value("${notification.max-time-to-live}")
    private Long maxTtl;

    @Override
    public boolean isValid(Long value, ConstraintValidatorContext context) {
        // 为空的场景可以交给@NotNull单独校验，这里直接放过
        if (value == null) {
            return true;
        }
        return value <= maxTtl;
    }
}

3. 替换原生注解使用 #

直接在你原本要加@Max的字段/参数上替换成自定义注解即可：

public class NotificationRequest {
    @ConfigurableMax(message = "通知有效期不能超过配置的最大值")
    private Long ttl;
    // 其他字段、getter/setter省略
}

注意事项 #

• Spring Boot 项目默认已经配置了支持 Spring 依赖注入的校验器工厂，上述代码直接可以生效；如果是普通 Spring 项目，需要手动将 ConfigurableMaxValidator 注册为 Spring 管理的 Bean。
• 如果需要适配多个不同的配置项作为最大值，可以给自定义注解加一个配置 key 的属性，在校验器里根据 key 动态从 Environment 里取值，灵活性更高。
• 如需要支持Integer等其他数字类型，可以扩展实现多个对应泛型的校验器。

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