2016-5-17 java验证框架 Validator的使用

在写实际项目中，对于入参总是需要进行大量的if判断去验证数据的合法性，虽然这是必要的，但是难免对于代码的层次结构和美观程度有着一定的影响。于是，在不堪一个controller中（或者其他类）if大量的判断条件，尝试使用了validator验证框架进行数据的基础验证。

1：配置 在pom中加入依赖

<dependency>
            <groupId>javax.validation</groupId>
            <artifactId>validation-api</artifactId>
            <version>1.1.0.Final</version>
        </dependency>

        <dependency>
<groupId>org.apache.bval</groupId>
<artifactId>bval-jsr303</artifactId>
<version>0.5</version>
</dependency>

其中缺少第二个jsr303的依赖不会在编写代码时出现错误，但是会在获得Validator时报以下错误：

javax.validation.ValidationException: Unable to create a Configuration, because no Bean Validation provider could be found

因为JSR 303 – Bean Validation 是一个数据验证的规范,2009 年 11 月确定最终方案。 所以需要加入这个规范才能正常的使用这个框架。

2：使用步骤

     2.1 给具体的字段加上注解

public class Brand {

    @NotNull(message = "不能为空")
    private Long brandId;
    @Max(value = 1000)
    private Long parentId;
    private String name;

}

在需要被验证的类中的具体字段上加上具体的注解以及注解的值，其中注解的种类和使用方法参考这篇文章

Bean Validation 中的 constraint

表 1. Bean Validation 中内置的 constraint

Constraint	详细信息
@Null	被注释的元素必须为 null
@NotNull	被注释的元素必须不为 null
@AssertTrue	被注释的元素必须为 true
@AssertFalse	被注释的元素必须为 false
@Min(value)	被注释的元素必须是一个数字，其值必须大于等于指定的最小值
@Max(value)	被注释的元素必须是一个数字，其值必须小于等于指定的最大值
@DecimalMin(value)	被注释的元素必须是一个数字，其值必须大于等于指定的最小值
@DecimalMax(value)	被注释的元素必须是一个数字，其值必须小于等于指定的最大值
@Size(max, min)	被注释的元素的大小必须在指定的范围内
@Digits (integer, fraction)	被注释的元素必须是一个数字，其值必须在可接受的范围内
@Past	被注释的元素必须是一个过去的日期
@Future	被注释的元素必须是一个将来的日期
@Pattern(value)	被注释的元素必须符合指定的正则表达式

表 2. Hibernate Validator 附加的 constraint

Constraint	详细信息
@Email	被注释的元素必须是电子邮箱地址
@Length	被注释的字符串的大小必须在指定的范围内
@NotEmpty	被注释的字符串的必须非空
@Range	被注释的元素必须在合适的范围内

http://www.ibm.com/developerworks/cn/java/j-lo-jsr303/

    2.2 在具体方法中校验注解规范的字段是否符合

  public static void main(String[] args) {
        Brand brand = new Brand();
        brand.setName("123");
        brand.setBrandId(1l);
        Validator validator = Validation.buildDefaultValidatorFactory().getValidator();
        Set<ConstraintViolation<Brand>> validations = validator.validate(brand);
        if (validations.isEmpty()) {
            System.out.println("true");
        }

    }

此时系统打印 true

当将brand.setBrandId(1l); 注释之后 单步调试可以看到validations 为具体的验证失败的字段值以及当时填写的message内容 如

[ConstraintViolationImpl{rootBean=com.ihomefnt.bean.Brand@6f195bc3, propertyPath='brandId', message='不能为空', leafBean=com.ihomefnt.bean.Brand@6f195bc3, value=null}]

由此可以减少大量的if判断 

（完）