@DecimalMax 浮点数最大值验证

该注解用于验证数据的注解之一。它用于验证一个数字是否小于或等于指定的最大值。具体来说,@DecimalMax 注解可以用于验证浮点数、双精度数或它们的包装类是否小于或等于指定的最大值。

在使用 @DecimalMax 注解时,你需要指定一个 value 参数,表示所需的最大值。你还可以选择指定一个 inclusive 参数,来指定验证时是否包含等于最大值的情况。默认情况下,inclusive 参数为 true,表示包含等于最大值的情况。

支持的类型有:

  • BigDecimal

  • BigInteger

  • CharSequence

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

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

@Target({ METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER })
@Retention(RUNTIME)
@Documented
@Constraint(validatedBy = { })
public @interface DecimalMax {
    String message() default "{javax.validation.constraints.DecimalMax.message}";
    Class<?>[] groups() default { };
    Class<? extends Payload>[] payload() default { };
    
    // 根据 BigDecimal 字符串表示法,最大值的字符串表示。
    String value();
    
    // 指定最大值是包含型还是排除型。默认为包含型。
    // true 字段的值必须小于等于指定的最大值
    // false 字段的值必须小于指定的最大值
    boolean inclusive() default true;
    
    // 在同一元素上定义多个 @DecimalMax 注解。
    @Target({ METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER })
    @Retention(RUNTIME)
    @Documented
    @interface List {
        DecimalMax[] value();
    }
}

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

示例:

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.DecimalMax;
import java.util.Set;

/**
 * 注解元素必须是一个数字,且小于等于最大值
 * @author hxstrive.com
 */
@Data
@Builder
public class DecimalMaxDemo {

    @DecimalMax(value = "100.1", message = "年龄必须小于等于100.1")
    private Float age;
    
    public static void main(String[] args) {
        DecimalMaxDemo.builder().age(null).build().validator("case1"); // OK
        DecimalMaxDemo.builder().age(0f).build().validator("case2"); // OK
        DecimalMaxDemo.builder().age(100.1f).build().validator("case3"); // OK
        DecimalMaxDemo.builder().age(100.2f).build().validator("case4"); // Fail
        DecimalMaxDemo.builder().age(-10f).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.1
case5 :: Succeed
说说我的看法
全部评论(
没有评论
关于
本网站属于个人的非赢利性网站,转载的文章遵循原作者的版权声明,如果原文没有版权声明,请来信告知:hxstrive@outlook.com
公众号