hibernate validate基本示例即自定义验证使用

我们平时写代码时对于某个实体需要做判空校验，平时我们可能会在代码中一行行判断，如果不符合就抛出异常，例如User类有userName、password等字段，现在业务要求每个字段必填，此时我们经常会if(user.getUserName==null)…若判断字段较多的话可能就会比较麻烦，并且造成了代码的不简洁。我们可以借助于hibernate validate解决，下面是相关示例。
首先pom中引入所需要的包

<dependency>
     <groupId>org.hibernate</groupId>
     <artifactId>hibernate-validator</artifactId>
     <version>4.3.1.Final</version>
 </dependency>

package com.yh.tbb.hibernate.validate.domain;
import com.yh.tbb.hibernate.validate.annotation.ListGtOne;
import org.hibernate.validator.constraints.Email;
import org.hibernate.validator.constraints.NotBlank;
import javax.validation.Valid;
import javax.validation.constraints.Max;
import javax.validation.constraints.Min;
import javax.validation.constraints.NotNull;
import javax.validation.constraints.Size;
import java.util.List;
public class User {
    @NotBlank(message = "用户名不能为空")
    private String userName;
    @NotBlank(message = "密码不能为空")
    @Size(min = 6, max = 16)
    private String password;
    @Min(1)
    @Max(120)
    private Integer age;
    @Email(regexp = "^[a-zA-Z0-9_.-]+@[a-zA-Z0-9-]+(\\.[a-zA-Z0-9-]+)*\\.[a-zA-Z0-9]{2,6}$", message =  "邮件格式错误")
    private String email;
    @Size(min = 11, max = 11)
    private String mobile;
    //是否VIP 0否 1是 空默认否
    private Integer vipFlag;
    //VIP授权码 vipFlag为是必填
    private String vipLicenseKey;
    //学习科目
    @NotEmpty(message = "用户学习科目不能为空")
    List<Subject> subjectList;
    
           /**对应get、set方法**/
}

上面@NotBlank、@Size等注解就是表示当前字段满足要求,具体注释可以网上查找,此处仅仅展示怎么使用，ValidateUtil为校验工具类

package com.yh.tbb.hibernate.validate.util;

import org.hibernate.validator.HibernateValidator;

import javax.validation.ConstraintViolation;
import javax.validation.Validation;
import javax.validation.Validator;
import java.util.Set;

public class ValidateUtil<T> {

    private static Validator validator;

    static {
        /**
         * 使用hibernate的注解来进行验证 failFast true仅仅返回第一条错误信息 false返回所有错误
         */
        validator = Validation
                .byProvider(HibernateValidator.class).configure().failFast(false).buildValidatorFactory().getValidator();

    }

    /**
     * @param obj 校验的对象
     * @param <T>
     * @return
     */
    public static <T> Set<ConstraintViolation<T>> validate(T obj,Class... groupClasses) {
         Set<ConstraintViolation<T>> constraintViolations;
        if(groupClasses != null && groupClasses.length>0){
             constraintViolations = validator.validate(obj,groupClasses);
        }else {
            constraintViolations = validator.validate(obj);
        }
        return constraintViolations;
    }
}

测试工具类:

package com.yh.tbb.hibernate.validate;

import com.yh.tbb.hibernate.validate.domain.Subject;
import com.yh.tbb.hibernate.validate.domain.User;
import com.yh.tbb.hibernate.validate.util.ValidateUtil;
import javax.validation.ConstraintViolation;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;
import java.util.Set;

public class Test {
    public static void main(String args[]) {
        User user = new User();
        user.setUserName("zhao");
        user.setPassword("123");
        user.setEmail("123456@qq.@com");
        List<Subject> subjectList = new ArrayList<Subject>();
        Subject subject = new Subject();
        subject.setSubjectCode("A001");
        subjectList.add(subject);
        user.setSubjectList(subjectList);
        Set<ConstraintViolation<User>> result = ValidateUtil.validate(user);
        // 抛出检验异常
        if (result.size() > 0) {
            Iterator<ConstraintViolation<User>> it = result.iterator();
            while (it.hasNext()) {
                ConstraintViolation<User> str = it.next();
                System.out.println(str.getMessage() + "\n");
            }
        }
    }
}

返回结果:
由于上面截图failFast设置为false所以将所有错误都返回，如果设置true只返回第一条。

在List subjectList中subjectList为空可以校验，那Subject里属性如果有标识如何级联校验呢?

package com.yh.tbb.hibernate.validate.domain;

import com.yh.tbb.hibernate.validate.group.SecondGroup;
import org.hibernate.validator.constraints.NotBlank;

import javax.validation.constraints.NotNull;

public class Subject {
    @NotBlank(message = "科目编码不能为空")
    private String subjectCode;
    @NotNull(message = "科目名称不能为空")
    private String subjectName;
                  /**对应get、set方法**/
}

如上截图subjectCode，subjectName都不能为空，那上面是否生效呢？经过测试是发现是不生效的，需要加另外个注释@Valid才能生效；

接下来又有个新的需求，用户科目列表里需要需至少两个，即subjectList.size()>2,
发现当前注释无法满足需求，因此我们要自定义一个自己的注释，使之和@NotBlank等
起到一样的效果。

package com.yh.tbb.hibernate.validate.annotation;

import com.yh.tbb.hibernate.validate.validateImpl.ListNotEmptyValidator;

import javax.validation.Constraint;
import javax.validation.Payload;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
//**ListNotEmptyValidator为对应ListGtOne的实现**
@Constraint(
        validatedBy = {ListNotEmptyValidator.class}
)
public @interface ListGtOne {
    /**
     *以下方法仿照@NotBlank注释
     */
    String message() default "列表数据为空！";
    Class<?>[] groups() default {};
    Class<? extends Payload>[] payload() default {};
}

接下来就是ListGtOne对应的实现，只需要继承ConstraintValidator既可:

package com.yh.tbb.hibernate.validate.validateImpl;

import com.yh.tbb.hibernate.validate.annotation.ListGtOne;

import javax.validation.ConstraintValidator;
import javax.validation.ConstraintValidatorContext;
import java.util.Collection;

public class ListNotEmptyValidator implements ConstraintValidator<ListGtOne, Collection> {


    public void initialize(ListGtOne listNotEmpty) {

    }

    public boolean isValid(Collection collection, ConstraintValidatorContext constraintValidatorContext) {
       if(collection == null || collection.size()<2){
         return false;
       }
       return true;
    }
}

ConstraintValidator完成后修改subjectList为@ListGtOne,当subjectList.size()<2 ConstraintValidator.isValid就会返回false,进而返回报错信息。

                    上面如果不对之处欢迎留言赐教,谢谢!

最后给大家推荐下hibernate validate中文文档:
http://docs.jboss.org/hibernate/validator/4.2/reference/zh-CN/html_single/