JSR 303 - Bean Validation 简单介绍及用法

一、JSR-303简单介绍

JSR-303 是 JAVA EE 6 中的一项子规范。叫做 Bean Validation，官方參考实现是Hibernate Validator。

此实现与 Hibernate ORM 没有不论什么关系。 JSR 303 用于对 Java Bean 中的字段的值进行验证。

Spring MVC 3.x 之中也大力支持 JSR-303，能够在控制器中对表单提交的数据方便地验证。

注:能够使用注解的方式进行验证

二、准备校验时使用的JAR

validation-api-1.0.0.GA.jar：JDK的接口；

hibernate-validator-4.2.0.Final.jar是对上述接口的实现；

log4j、slf4j、slf4j-log4j

三、JSR 303 主要的校验规则

空检查

@Null 验证对象是否为null

@NotNull 验证对象是否不为null, 无法查检长度为0的字符串

@NotBlank 检查约束字符串是不是Null还有被Trim的长度是否大于0,仅仅对字符串,且会去掉前后空格.

@NotEmpty 检查约束元素是否为NULL或者是EMPTY.

Booelan检查

@AssertTrue 验证 Boolean 对象是否为 true

@AssertFalse 验证 Boolean 对象是否为 false

长度检查

@Size(min=, max=) 验证对象（Array,Collection,Map,String）长度是否在给定的范围之内

@Length(min=, max=) Validates that the annotated string is between min and max included.

日期检查

@Past 验证 Date 和 Calendar 对象是否在当前时间之前，验证成立的话被凝视的元素一定是一个过去的日期

@Future 验证 Date 和 Calendar 对象是否在当前时间之后 ，验证成立的话被凝视的元素一定是一个将来的日期

@Pattern 验证 String 对象是否符合正則表達式的规则。被凝视的元素符合制定的正則表達式，regexp:正則表達式 flags: 指定 Pattern.Flag 的数组，表示正則表達式的相关选项。

数值检查

建议使用在Stirng,Integer类型。不建议使用在int类型上，由于表单值为“”时无法转换为int，但能够转换为Stirng为”“,Integer为null

@Min 验证 Number 和 String 对象是否大等于指定的值

@Max 验证 Number 和 String 对象是否小等于指定的值

@DecimalMax 被标注的值必须不大于约束中指定的最大值. 这个约束的參数是一个通过BigDecimal定义的最大值的字符串表示.小数存在精度

@DecimalMin 被标注的值必须不小于约束中指定的最小值. 这个约束的參数是一个通过BigDecimal定义的最小值的字符串表示.小数存在精度

@Digits 验证 Number 和 String 的构成是否合法

@Digits(integer=,fraction=) 验证字符串是否是符合指定格式的数字，interger指定整数精度。fraction指定小数精度。

@Range(min=, max=) 被指定的元素必须在合适的范围内

@Range(min=10000,max=50000,message=”range.bean.wage”)

@Valid 递归的对关联对象进行校验, 假设关联对象是个集合或者数组,那么对当中的元素进行递归校验,假设是一个map,则对当中的值部分进行校验.(是否进行递归验证)

@CreditCardNumber信用卡验证

@Email 验证是否是邮件地址，假设为null,不进行验证。算通过验证。

@ScriptAssert(lang= ,script=, alias=)

@URL(protocol=,host=, port=,regexp=, flags=)

四、案例分析

在使用的时候直接对JavaBean进行注解既能够实现对属性的验证

public class Order {
    // 必须不为 null, 大小是 10
    @NotNull
    @Size(min = 10, max = 10)
    private String orderId;
    // 必须不为空
    @NotEmpty
    private String customer;
    // 必须是一个电子信箱地址
    @Email
    private String email;
    // 必须不为空
    @NotEmpty
    private String address;
    // 必须不为 null, 必须是以下四个字符串'created', 'paid', 'shipped', 'closed'当中之中的一个
    // @Status 是一个定制化的 contraint
    @NotNull
    @Status
    private String status;
    // 必须不为 null
    @NotNull
    private Date createDate;
    // 嵌套验证
    @Valid
    private Product product;

   // getter 和setter方法
}

又例：

    @NotNull(message = "adultTax不能为空")
    private Integer adultTax;

    @NotNull(message = "adultTaxType不能为空")
    @Min(value = 0, message = "adultTaxType 的最小值为0")
    @Max(value = 1, message = "adultTaxType 的最大值为1")
    private Integer adultTaxType;

    @NotNull(message = "reason信息不能够为空")
    @Pattern(regexp = "[1-7]{1}", message = "reason的类型值为1-7中的一个类型")
    private String reason;//订单取消原因

五、下边是一个完整的样例：

public class ValidateTestClass{

    @NotNull(message = "reason信息不能够为空")
    @Pattern(regexp = "[1-7]{1}", message = "reason的类型值为1-7中的一个类型")
    private String reason;//订单取消原因

    //get、set方法、有參构造方法、无參构造方法、toString方法省略

    /**
     * 验证參数：就是验证上述注解的完整方法
     * @return
     */
    public void validateParams() {
        //调用JSR303验证工具，校验參数
        Validator validator = Validation.buildDefaultValidatorFactory().getValidator();
        Set<ConstraintViolation<ValidateTestClass>> violations = validator.validate(this);
        Iterator<ConstraintViolation<ValidateTestClass>> iter = violations.iterator();
        if (iter.hasNext()) {
            String errMessage = iter.next().getMessage();
            throw new ValidationException(errMessage);
        }
    }
}

我们能够写一个測试类进行验证：

public class ValidateTestClassValidateTest{

    @Test
    public void validateParam(){
        ValidateTestClass validateTestClass = new ValidateTestClass();
        validateTestClass .setReason(12);

        validateTestClass .validateParams(); //调用验证的方法
    }
}

ok！

这样就能够进行測试。

而且我们在使用的时候一定要注意，对于某一种验证规则是适用于一种数据类型的，简单说来。正则则表达式的验证对象能够为String类型的，可是不能够为Integer类型的数据，那么当我们使用正則表達式进行验证的时候就会出现错误。

相似于：

javax.validation.UnexpectedTypeException: HV000030: No validator could be found for type: java.lang.Integer.
at org.hibernate.validator.internal.engine.constraintvalidation.ConstraintValidatorManager.verifyResolveWasUnique(ConstraintValidatorManager.java:218)

意思就是你这个验证的注解不应该对该类型进行注解。

到此OK。