@Max 最大值验证

使用该注释约束字段的值必须小于或等于指定的最大值,并且字段的类型必须是数字类型。支持的类型有:

  • BigDecimal

  • BigInteger

  • byte, short, int, long, 和它们的包装类型

注意,由于四舍五入存在误差,因此不支持 double 和 float(某些提供商可能会提供近似支持)。如果字段的值为 null,也将被认为是有效的值。

@Max 注解源码如下:

@Target({ METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER })
@Retention(RUNTIME)
@Documented
@Constraint(validatedBy = { })
public @interface Max {
    String message() default "{javax.validation.constraints.Max.message}";
    Class<?>[] groups() default { };
    Class<? extends Payload>[] payload() default { };
    // 指定约束值
    long value();
    // 在同一元素上定义多个 @Max 注解
    @Target({ METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER })
    @Retention(RUNTIME)
    @Documented
    @interface List {
        Max[] value();
    }
}

注意:message、groups、payload 属性用法参考 @NotNull 注解。

示例:使用 @Max 注解约束 age 字段不能大于 100,如下:

package com.hxstrive.validation;

import lombok.Builder;
import lombok.Data;
import org.hibernate.validator.HibernateValidator;
import javax.validation.ConstraintViolation;
import javax.validation.Validation;
import javax.validation.Validator;
import javax.validation.constraints.Max;
import java.util.Set;

/**
 * 注解的元素必须为数字,且小于等于最大值
 * @author hxstrive.com
 */
@Data
@Builder
public class MaxDemo {
    
    @Max(value = 100, message = "年龄必须小于等于100")
    private Integer age;
    
    public static void main(String[] args) {
        MaxDemo.builder().age(null).build().validator("case1"); // OK
        MaxDemo.builder().age(0).build().validator("case2"); // OK
        MaxDemo.builder().age(100).build().validator("case3"); // OK
        MaxDemo.builder().age(101).build().validator("case4"); // Fail
        MaxDemo.builder().age(-10).build().validator("case5"); // OK
    }
    
    private void validator(String caseName) {
        validator(caseName, this);
    }
    
    private <T> void validator(String caseName, T obj) {
        // 手动调用 API 对定义了注解的字段进行校验
        Validator validator = Validation.byProvider(HibernateValidator.class).configure()
                .failFast(true).buildValidatorFactory().getValidator();
        Set<ConstraintViolation<T>> set = validator.validate(obj);
        if (set.size() > 0) {
            // 校验失败
            System.out.println(caseName + " :: Fail :: " + set.iterator().next().getMessage());
        } else {
            // 校验通过
            System.out.println(caseName + " :: Succeed");
        }
    }
}

运行示例,输出如下:

case1 :: Succeed
case2 :: Succeed
case3 :: Succeed
case4 :: Fail :: 年龄必须小于等于100
case5 :: Succeed
说说我的看法
全部评论(
没有评论
关于
本网站属于个人的非赢利性网站,转载的文章遵循原作者的版权声明,如果原文没有版权声明,请来信告知:hxstrive@outlook.com
公众号