Hibernate-validator数据验证

前言

　　数据效验工作在开发工作中，是非常重要的，保证数据的正确性，可靠性，安全性。不仅在前端进行效验，还要在后台继续进行效验。

　　前端做验证只是为了用户体验，比如控制按钮的显示隐藏，单页应用的路由跳转等等。后端才是最终的保障。总之，一切用户的输入都是不可信的。

常见的验证方式

　　前端的校验是必须的，这个很简单，因为客户体验。后台的校验更是必须的，关键在于如何与目前我们的分层思想（控制层、业务层、持久层）综合起来考虑。

　　在每层都要进行校验吗？还是只在是某个特定层做就可以了？ 是否有好的校验框架（如前端的jquery校验框架、springmvc校验框架）？

　　总之校验框架还是有很多的，原理不就是对后端接收的数据进行特定规则的判断，那我们怎么制定规则，有怎么去检验呢？

1、表现层验证：SpringMVC提供对JSR-303的表现层验证； 
2、业务逻辑层验证：Spring3.1提供对业务逻辑层的方法验证（当然方法验证可以出现在其他层，但笔者觉得方法验证应该验证业务逻辑）； 
3、DAO层验证：Hibernate提供DAO层的模型数据的验证（可参考hibernate validator参考文档的7.3. ORM集成）。 
4、数据库端的验证：通过数据库约束来进行； 
5、客户端验证支持：JSR-303也提供编程式验证支持。

Hibernate-validator

　　本章主要介绍一下hibernate-validator，下面就一起共同的去学习吧。

what?

注意：hibernate-validator 与 持久层框架 hibernate 没有什么关系，hibernate-validator 是 hibernate 组织下的一个开源项目。

hibernate-validator 是 JSR 380（Bean Validation 2.0）、JSR 303（Bean Validation 1.0）规范的实现。

JSR 380 - Bean Validation 2.0 定义了一个实体和方法验证的元数据模型和 API。

JavaEE（改名为：Jakarta EE）中制定了 validation 规范，即：javax.validation-api（现为 jakarta.validation-api，jar 包的名字改变，包里面的包名、类名未变，因此使用方式不变）包，

spring-boot-starter-web、spring-boot-starter-webflux 包都已引入此依赖，直接使用即可。

有点类似于 slf4j 与 logback（log4j2）的关系，使用的时候，代码中使用 javax.validate 提供的接口规范功能，加载的时候，根据 SPI 规范加载对应的规范实现类。

它和 hibernate 没什么关系，放心大胆的使用吧。

使用的注解

标识注解

1. @Vaild()

　　标记用于验证级联的属性、方法参数或方法返回类型。在验证属性、方法参数或方法返回类型时，将验证在对象及其属性上定义的约束。此行为是递归应用的。

2.@Validated()

　　spring 提供的扩展注解，可以方便的用于分组校验.

约束注解

下面除了列出的参数，每个约束都有参数 message，groups 和 payload。这是 Bean Validation 规范的要求。

其中，message 是提示消息，groups 可以根据情况来分组。

以下每一个注解都可以在相同元素上定义多个。

3. @AssertFalse:  检查元素是否为 false，【支持数据类型：boolean、Boolean】

---

4. @AssertTrue:  检查元素是否为 true，【支持数据类型：boolean、Boolean】

---

5. @DecimalMax(value=, inclusive=)：【支持数据类型：BigDecimal、BigInteger、CharSequence、（byte、short、int、long 和其封装类）】

　　inclusive： boolean，默认 true，表示是否包含，是否等于。
　　value：① 当 inclusive=false ，检查带注解的值是否小于指定的最大值。② 当 inclusive=true 检查该值是否小于或等于指定的最大值。参数值是根据 bigdecimal 字符串表示的最大值。

---

6. @DecimalMin(value=, inclusive=)：【支持数据类型：BigDecimal、BigInteger、CharSequence、（byte、short、int、long 和其封装类）】

　　inclusive： boolean，默认 true，表示是否包含，是否等于
　　value： ① 当 inclusive=false 时，检查带注解的值是否大于指定的最大值。② 当 inclusive=true 检查该值是否大于或等于指定的最大值。参数值是根据 bigdecimal 字符串表示的最小值。

---

7. @Digits(integer=, fraction=)：【支持的数据类型： BigDecimal, BigInteger, CharSequence, byte, short, int, long 、原生类型的封装类、任何 Number 子类。】

　　检查值是否为最多包含 integer 位整数和 fraction 位小数的数字

---

8. @Email ("regexp")【支持的数据类型：CharSequence】

　　检查指定的字符序列是否为有效的电子邮件地址。可选参数 regexp 和 flags 允许指定电子邮件必须匹配的附加正则表达式（包括正则表达式标志）。

---

9. @Max(value=)：【支持的数据类型： BigDecimal, BigInteger, byte, short, int, long, 原生类型的封装类, CharSequence 的任意子类（字符序列表示的数字）, Number 的任意子类,

　　　　　　　　　　 javax.money.MonetaryAmount 的任意子类】

　　检查值是否 小于或等于 指定的 最大值

---

10. @Min(value=)：【支持的数据类型： BigDecimal, BigInteger, byte, short, int, long, 原生类型的封装类, CharSequence 的任意子类（字符序列表示的数字）, Number 的任意子类,

　　　　　　　　　　  javax.money.MonetaryAmount 的任意子类】

　　检查值是否 大于或等于 指定的 最大值

---

11. @NotBlank：【支持数据类型：CharSequence】

　　检查字符序列 是否为空，以及去空格后的长度是否大于 0。  与@NotEmpty 的不同之处在于，此约束只能应用于字符序列，并且忽略尾随空格。

---

12. @NotNull：【支持数据类型：任何类型】

　　检查值是否 不为null

---

13. @NotEmpty：【支持数据类型：CharSequence, Collection, Map, arrays】

　　检查元素是否为 null 或 空

---

14. @Size(min=, max=)和：@Length(min=, max=)【支持数据类型：CharSequence，Collection，Map, arrays】

　　检查元素个数是否在  min（含）和 max（含）  之间

---

15. @Negative：【支持数据类型： BigDecimal, BigInteger, byte, short, int, long, 原生类型的封装类, CharSequence 的任意子类（字符序列表示的数字）, Number 的任意子类,

　　　　　　　　　 javax.money.MonetaryAmount 的任意子类】

　　检查元素是否 严格 为负数。零值被认为无效。

---

16. @NegativeOrZero：【支持数据类型：BigDecimal, BigInteger, byte, short, int, long, 原生类型的封装类, CharSequence 的任意子类（字符序列表示的数字）, Number 的任意子类,

　　　　　　　　　　　　 javax.money.MonetaryAmount 的任意子类】

　　检查元素是否为 负或零。

---

17. @Positive：【支持数据类型： BigDecimal, BigInteger, byte, short, int, long, 原生类型的封装类, CharSequence 的任意子类（字符序列表示的数字）, Number 的任意子类,

　　　　　　　　 javax.money.MonetaryAmount 的任意子类】

　　检查元素是否 严格 为正。零值被视为无效。

---

18. @PositiveOrZero：【支持数据类型： BigDecimal, BigInteger, byte, short, int, long, 原生类型的封装类, CharSequence 的任意子类（字符序列表示的数字）, Number 的任意子类,

　　　　　　　　　　　　javax.money.MonetaryAmount 的任意子类】

　　检查元素是否 为正或零。

---

19.@Null：【支持数据类型：任何类型】

　　检查值是否为 null

---

20.@Future：【支持的数据类型：java.util.D

检查日期是否在 未来。就是大于当前日期。

---

21. @FutureOrPresent：【支持数据类型：同@Future】

　　检查日期是现在或将来，大于等于当前日期

---

22. @Past：【支持数据类型：同@Future】

　　检查日期是否在过去，小于当前日期

---

23.@PastOrPresent：【支持数据类型：同@Future】

　　检查日期是否在过去或现在，小于等于当前日期。

---

24. @Pattern(regex=, flags=)：【支持数据类型：CharSequence】

　　根据给定的 flag 匹配，检查字符串是否与正则表达式 regex 匹配

---

25. @CreditCardNumber：【支持数据类型：String】
　　校验信用卡号码

---

26. @NotEmptyPattern(regex=)：【支持数据类型：String】

　　在字符串不为空的情况下，验证是否匹配正则表达式

---

27. @ListStringPattern(regex=)：【支持数据类型：List<String>】

　　验证集合中的字符串是否满足正则表达式

---

28. @DateValidator(regex=)：【支持数据类型：String】

　　验证日期格式是否满足正则表达式，Local为ENGLISH

---

29. @DateFormatCheckPattern(regex=)：【支持数据类型：String】

　　验证日期格式是否满足正则表达式，Local为自己手动指定

---

Hibernate-validator的使用

一、导入maven依赖

<dependency> 

      <groupId>javax.validation</groupId>
      <artifactId>validation-api</artifactId>
      <version>1.1.0.Final</version>
    </dependency>
    <dependency>
      <groupId>org.hibernate</groupId>
      <artifactId>hibernate-validator</artifactId>
      <version>5.2.0.Final</version>
</dependency> 

二、通用的效验工具

import com.google.common.base.Preconditions;
import com.google.common.collect.Lists;
import com.google.common.collect.Maps;
import com.wj.exception.ParamException;
import org.apache.commons.collections.MapUtils;
import javax.validation.*;
import javax.validation.groups.Default;
import java.util.*;

public class BeanValidator {
    private static Validator validator=null;
    //获取Validator对象
    static{
        ValidatorFactory validatorFactory = Validation.buildDefaultValidatorFactory();
        validator = validatorFactory.getValidator();
    }

    /**
     * 通过参数，判断是那种效验：对象  集合
     * @param obj  效验的bean
     * @param objects 效验的集合
     * @return
     */
    public static Map<String,String> validate(Object obj, Object... objects){
        if (objects != null && objects.length > 0){
            return validateList(Lists.asList(obj, objects));
        }else {
            return validateObject(obj, new Class[0]);
        }
    }

    /**
     * 对象数据效验
     * 使用指定分组
     * @param t 被效验的bean
     * @param groups 分组
     * @param <T>
     * @return 返回错误信息
     */
    public static <T>Map<String,String> validateObject(T t, Class... groups){
        //如果分组为空，使用默认的分组
        if (groups == null){
            groups = new Class[]{Default.class};
        }
        //获取实体类验证后的信息，存放在Set集合。
        //ConstraintViolation类封装着实体类的每个属性的效验之后的信息
        Set<ConstraintViolation<T>> validateResult = validator.validate(t, groups);
        if (validateResult.isEmpty()){
            //如果属性都符合要求，没有错误信息，返回一个空集合
            return Collections.emptyMap();
        }else {
            HashMap errors = Maps.newHashMap();
            //遍历集合
            Iterator iterator = validateResult.iterator();
            while (iterator.hasNext()){
                ConstraintViolation violation = (ConstraintViolation) iterator.next();
                //将每个属性的错误信息，添加到HashMap集合中
                errors.put(violation.getPropertyPath().toString(), violation.getMessage());
            }
            return errors;
        }
    }

    /**
     * 检查集合中的bean
     * @param collection 被效验的集合
     * @return
     */
    public static Map<String, String> validateList(Collection<?> collection){
        //检查集合是否为空
        Preconditions.checkNotNull(collection);
        Map errors = null;
        Iterator iterator = collection.iterator();
        //当集合中没有数据，返回空集合
        if (!iterator.hasNext()){
            return Collections.emptyMap();
        }
        //遍历集合
        while (iterator.hasNext()){
            Object object = iterator.next();
            //Collection集合中每个对象的效验信息 赋值给Map
            errors = validate(object, new Class[0]);
        }
        return errors;
    }
}