Bean Validation技术实现对Javabean的校验

 概述：在java开发时，由于分层的原因（表现层-控制层-业务层-数据持久层），有时候需要对传入的Javabean进行校验，如果过多的校验会导致比较繁琐，做重复的工作，下面将介绍Bean Validation技术，该技术是利用注解的方式，在javabean代码内部，利用注解实现校验，这样会将繁琐的工作变得简单。

 

注：在阅读如下知识之前，要对注解有一些了解。

 

 

来一个简单的Bean Validation实现 ，热热身：

 

 

package validation;

import java.util.Set;

import javax.validation.ConstraintViolation;
import javax.validation.Validation;
import javax.validation.Validator;
import javax.validation.ValidatorFactory;
import javax.validation.constraints.NotNull;
import javax.xml.bind.ValidationException;

//import validation.vo.Person;

/**
 * @ClassName: Test1
 * @Description: TODO
 * @author zhangyy
 * @date 2015-7-30 上午11:44:15
 */
public class Test1 {

    public static void main(String [] args ){
        Person person = new Person();
        try {
            Test1.validate(person);
        } catch (ValidationException e) {
            System.out.println(e.getMessage());  //输出结果是：用户名不能为空
        }

    }

    public static <T>  void validate(T t) throws ValidationException {
        ValidatorFactory vFactory = Validation.buildDefaultValidatorFactory();
        Validator validator = vFactory.getValidator();
        Set<ConstraintViolation<T>> set =  validator.validate(t);
        if(set.size()>0){
            StringBuilder validateError = new StringBuilder();
            for(ConstraintViolation<T> val : set){
                validateError.append(val.getMessage());
            }
            throw new ValidationException(validateError.toString());
        }

    }
}

class Person{

    @NotNull(message="用户名不能为空")  //此处为校验注解
    private String username;

    public String getUsername() {
        return username;
    }

    public void setUsername(String username) {
        this.username = username;
    }

}

 

 

 上面的代码用到了@NotNull（）注解进行校验，一个完整的校验步骤包括如下四个步骤：

 

1.约束注解的定义

2.约束验证规则（约束验证器）

3.约束注解的声明

4.约束验证流程

 

 

下面用代码来进行详细的解释：

 

1.约束的定义:

Bean Vlidation技术提供了一些内置的约束定义，还可以自定义；下面是内置的：

 

约束注解名称 约束注解说明

@Null	验证对象是否为空
@NotNull	验证对象是否为非空
@AssertTrue	验证 Boolean 对象是否为 true
@AssertFalse	验证 Boolean 对象是否为 false
@Min	验证 Number 和 String 对象是否大等于指定的值
@Max	验证 Number 和 String 对象是否小等于指定的值
@DecimalMin	验证 Number 和 String 对象是否大等于指定的值，小数存在精度
@DecimalMax	验证 Number 和 String 对象是否小等于指定的值，小数存在精度
@Size	验证对象（Array,Collection,Map,String）长度是否在给定的范围之内
@Digits	验证 Number 和 String 的构成是否合法
@Past	验证 Date 和 Calendar 对象是否在当前时间之前
@Future	验证 Date 和 Calendar 对象是否在当前时间之后
@Pattern	验证 String 对象是否符合正则表达式的规则

 

自定义约束的结构如下（其实就是注解的定义）：

 

 

@Target({ })   // 约束注解应用的目标元素类型(METHOD, FIELD, TYPE, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER等)
@Retention()   // 约束注解应用的时机
@Constraint(validatedBy ={})  // 与约束注解关联的验证器
public @interface ConstraintName{
String message() default " ";   // 约束注解验证时的输出消息
Class<?>[] groups() default { };  // 约束注解在验证时所属的组别
Class<? extends Payload>[] payload() default { }; // 约束注解的有效负载
}

 

可以遵循这个格式，去写自己定义的注解（下面有自定义的例子） 

 

2.约束验证规则（约束验证器） 

 

 上面的内容是定义约束，当约束定义好了之后，就需要定义一个约束校验规则，其实就是一个校验器。每一个约束定义要对应一个约束校验器。定义约束校验器必须要实现如下的接口：

 

 

//约束验证器需要实现该接口
public interface ConstraintValidator<A extends Annotation, T> {
    void initialize(A constraintAnnotation);    //初始化验证器
    boolean isValid(T value, ConstraintValidatorContext context);   //约束验证的方法 ，这里面实现校验的具体规则
}

 

 下面会有具体的实现约束校验器

 

3.约束的声明

  声明，其实就是讲自定义的注解或者是内置的注解声明在需要校验的字段/方法等上面，该步骤比较简单，如：

 

 

@NumberVlidator(message= "体重必须为数字")
private String weight;

 

 

 

 4.验证流程

 

 在实际使用中调用 Validator.validate(JavaBeanInstance) 方法后，Bean Validation 会查找在 JavaBeanInstance上所有的约束声明，对每一个约束调用对应的约束验证器进行验证，最后的结果由约束验证器的 isValid 方法产生，如果该方法返回 true，则约束验证成功，否则验证失败。验证失败的约束将产生约束违规对象（ConstraintViolation 的实例）并放到约束违规列表中。验证完成后所有的验证失败信息均能在该列表中查找并输出

 

 

/**
 * @throws ValidationException
 * @throws ValidationException
 * @Description: 校验方法
 * @param t 将要校验的对象
 * @throws ValidationException
 * void
 * @throws
 */
public static <T> void validate(T t) throws ValidationException{
    ValidatorFactory vf = Validation.buildDefaultValidatorFactory();
    Validator  validator = vf.getValidator();
    Set<ConstraintViolation<T>> set =  validator.validate(t);
    if(set.size()>0){
        StringBuilder validateError = new StringBuilder();
        for(ConstraintViolation<T> val : set){
            validateError.append(val.getMessage() + " ;");
        }
        throw new ValidationException(validateError.toString());
    }
}

 

 

 

 至此，一个完整的Bean Validation校验已经完成，是不是很简单，如果还是看不懂的话，下面直接上代码，相信看了代码都会明白的，嘿嘿

 

 

 

完整的Demo

 

 

 1.一个javabean对象

 

 

package validation.vo;

import java.util.Date;

import javax.validation.constraints.NotNull;
import javax.validation.constraints.Size;

import validation.validate.NumberVlidator;


/**
 * @ClassName: Person
 * @Description: TODO
 * @author zhangyy
 * @date 2015-7-30 上午11:46:37
 */
public class Person {

    @NotNull(message = "用户ID不能为空")
    private Integer id;     //应为包装类型，否则不能检测到

    @NotNull(message = "test不能为空")
    private String test;

    @NumberVlidator(message= "体重必须为数字")  //该注解为自定义注解
    private String weight;

    @NotNull(message = "用户姓名不能为空dd")
    @Size(min=1, max=10, message="用户姓名必须是1-10位之间")
    private String username;
    //省略setter和getter方法
}

 

 

 

 2.约束的定义（上面有一个自定义的@NumberVlidator 注解）

 

 

package validation.validate;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

import javax.validation.Constraint;
import javax.validation.Payload;


/**
 * @ClassName: NumberVlidator
 * @Description: 约束定义
 * @author zhangyy
 * @date 2015-7-31 上午10:11:14
 */
@Target({ElementType.ANNOTATION_TYPE,ElementType.METHOD,ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Constraint(validatedBy = {NumberVlidatorImpl.class})
public @interface NumberVlidator {

    boolean isNumber () default false;

    String message() default "该值应该为数字";   // 约束注解验证时的输出消息

    Class<?>[] groups() default { };  // 约束注解在验证时所属的组别

    Class<? extends Payload>[] payload() default { }; // 约束注解的有效负载

}

 

 

 

3.对上一步的自定义约束进行实现校验规则（校验器）

 

 

package validation.validate;

import java.math.BigDecimal;

import javax.validation.ConstraintValidator;
import javax.validation.ConstraintValidatorContext;

/**
 * @ClassName: NumberVlidatorImpl
 * @Description: 约束验证器
 * @author zhangyy
 * @date 2015-7-31 上午10:14:44
 */
public class NumberVlidatorImpl implements ConstraintValidator<NumberVlidator, String> {

    private boolean isNumber;

    /**
    * <p>Title: 对验证器进行实例化</p>
    * @param constraintAnnotation
    */
    @Override
    public void initialize(NumberVlidator constraintAnnotation) {  //初始化
        isNumber = constraintAnnotation.isNumber();
    }

    /**
    * <p>Description: 校验的方法</p>
    * @param value  需要验证的实例
    * @param context 约束执行的上下文环境
    * @return
    */
    @Override
    public boolean isValid(String value, ConstraintValidatorContext context) {
        if(value==null || value.length()<=0){
            return true;
        }else{
            try {
                if(isNumber){
                    Long.parseLong(value);
                }else{
                    new BigDecimal(value);
                }
                return true;
            } catch (NumberFormatException e) {
                return false;
            }
        }
    }

}

 

 

 

 4.具体的校验实现（校验工具）

 

 

 

package validation.util;

import java.util.Set;

import javax.validation.ConstraintViolation;
import javax.validation.Validation;
//import javax.validation.ValidationException;
import javax.validation.Validator;
import javax.validation.ValidatorFactory;
import javax.xml.bind.ValidationException;

/**
 * @ClassName: VlidationUtil
 * @Description: 校验工具类
 * @author zhangyy
 * @date 2015-7-31 上午10:28:48
 */
public class VlidationUtil {

    private static Validator validator;

    static {
        ValidatorFactory vf = Validation.buildDefaultValidatorFactory();
        validator = vf.getValidator();
    }


    /**
     * @throws ValidationException
     * @throws ValidationException
     * @Description: 校验方法
     * @param t 将要校验的对象
     * @throws ValidationException
     * void
     * @throws
     */
    public static <T> void validate(T t) throws ValidationException{
        Set<ConstraintViolation<T>> set =  validator.validate(t);
        if(set.size()>0){
            StringBuilder validateError = new StringBuilder();
            for(ConstraintViolation<T> val : set){
                validateError.append(val.getMessage() + " ;");
            }
            throw new ValidationException(validateError.toString());
        }
    }

}

 

5.注意： 以上的需要依赖其他的类库，下面是maven的依赖（该步骤不能忘记哦）

 

    <dependency>
    <groupId>javax.validation</groupId>
      <artifactId>validation-api</artifactId>
      <version>1.1.0.Final</version>
</dependency>
<dependency>
       <groupId>org.ow2.util.bundles</groupId>
     <artifactId>hibernate-validator-4.3.1.Final</artifactId>
     <version>1.0.0</version>
</dependency>

 

 

6.测试类

 

package validation;


import javax.xml.bind.ValidationException;

import validation.util.VlidationUtil;
import validation.vo.Person;

/**
 * @ClassName: 测试类
 * @Description: TODO
 * @author zhangyy
 * @date 2015-7-30 上午11:44:15
 */
public class Test1 {

    public static void main(String [] args ){
        Person person = new Person();
        try {
            VlidationUtil.validate(person);
        } catch (ValidationException e) {
            System.out.println(e.getMessage());
        }

               //输出结果为：test不能为空 ;用户ID不能为空 ;用户姓名不能为空dd ;
    }

}

 

 

 

 OK，整个流程结束！

 

 

 

 

 总结：Bean Validation技术除了可以校验一般的数据类型，还支持校验复杂的对象类型，组合类型、等，具体的自行查阅相关资料吧，一般的需求都可以满足的！

 

 

最后附加上上面展示的源码，将文件解压缩，执行 mvn eclipse:eclipse 导入到eclipse中运行吧！！