数据校验validation

概述

form表单传输到后端的数据，需要经过校验，前端的JS校验虽然可以涵盖大部分的校验职责，如生日格式，邮箱格式校验等。但是为了避免用户绕过浏览器，使用http/curl等工具直接向后端请求一些违法数据，造成安全事故，故服务端的数据校验显得更为重要。

JSR303/JSR349/JSR380

JSR303是专家组成员向JCP提交的第一版Bean Validation，即针对bean数据校验提出的一个规范，使用注解方式实现数据校验。后面有升级版本JSR349及JSR380。各个版本的规范对应关系如下：

• ​​JSR 380​​(Bean Validation 2.0)
• ​​JSR 349​​(Bean Validation 1.1)
• ​​JSR 303​​(Bean Validation 1.0)

JSR303伴随着JAVAEE 6在2009年发布，Hibernate实现版本4.3.1.Final，Apache BVal实现版本0.5
JSR349伴随着JAVAEE 7在2013年发布，Hibernate实现版本5.1.1.Final，Apache BVal实现版本1.1.2
JSR380伴随着JAVAEE 8在2017年发布，完全兼容低版本的JAVASE，Hibernate实现版本6.0.1.Final，Apache BVal实现版本2.0.3(不太确定)

主流Bean Validation使用Hibernate的实现。

所以如果使用2.0规范，hibernate必须选择6.0.1以上版本

JSR规定一些校验规范即校验注解，如@Null，@NotNull，@Pattern，位于javax.validation.constraints包下，只提供规范不提供实现。

而hibernate validation是对这个规范的实践，提供相应的实现，并增加一些其他校验注解，如@Email，@Length，@Range等等，位于org.hibernate.validator.constraints包下。spring对hibernate validation进行二次封装，显示校验validated bean时，可以使用spring validation或hibernate validation，而spring validation另一个特性，便是其在springmvc模块中添加自动校验，并将校验信息封装进特定的类中。

JSR349

每一个注解都包含message字段，用于校验失败时作为提示信息，特殊的校验注解，如Pattern（正则校验），还可以自己添加正则表达式。

​​https://github.com/beanvalidation/beanvalidation-api​​

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

和API组织结构几乎一模一样（没有一一去对比），建议使用新版本

Maven Repository: Search/Browse/Explore

​​https://mvnrepository.com/​​

使用搜索​​Maven Central Repository​​​搜索​​jakarta.validation-api​​​，得到如下：
​​​ https://search.maven.org/artifact/jakarta.validation/jakarta.validation-api​​​ 可知其​​官网​​​、​​GitHub​​

搜索可知，2018年才发布第一个可用版本，最新版本是3.0.0

<dependency>
  <groupId>jakarta.validation</groupId>
  <artifactId>jakarta.validation-api</artifactId>
  <version>3.0.0</version>
  <scope>compile</scope>
</dependency>

故而在此之前，一般选择使用

Hibernate Validator Engine
Hibernate’s Jakarta Bean Validation reference implementation.

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

不要使用下面这个GAV：

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

实例

@Data
public class ErrorMsg {
    private String field;
    private String objectName;
    private String message;
}

全局异常配置类：

@ControllerAdvice
public class ExceptionAdvice extends DefaultExceptionAdvice {

    @ExceptionHandler(MethodArgumentNotValidException.class)
    @ResponseBody
    public List<ErrorMsg> exception(MethodArgumentNotValidException e) {
        BindingResult bindingResult = e.getBindingResult();
        List<ObjectError> allErrors = bindingResult.getAllErrors();
        List<ErrorMsg> errorMsgs = new ArrayList<>();

        allErrors.forEach(objectError -> {
            ErrorMsg errorMsg = new ErrorMsg();
            FieldError fieldError = (FieldError) objectError;
            errorMsg.setField(fieldError.getField());
            errorMsg.setObjectName(fieldError.getObjectName());
            errorMsg.setMessage(fieldError.getDefaultMessage());
            errorMsgs.add(errorMsg);
        });
        return errorMsgs;
    }

}

实体POJO：

import lombok.Data;
import javax.validation.constraints.Min;
import javax.validation.constraints.NotEmpty;
import javax.validation.constraints.NotNull;

@Data
public class SetMealConfigVO {
    /**
     * 解读信息
     */
    @NotEmpty(message = "解读信息不能为空")
    private String unscrambleType;

    /**
     * 套餐有效时长
     */
    @NotNull(message = "套餐有效时长不能为空")
    @Min(value = 1, message = "不能为负数")
    private Integer useDays;
}

@PostMapping("/addOrEdit")
public Result<String> addOrEdit(@RequestBody @Valid SetMealConfigVO configVO, @LoginUser SysUser user) {
}

2.0.2和3.0.0版本提供的注解一模一样：

Hibernate Validator

Hibernate Validator提供的校验注解，未包括标注为@Deprecated的：

分组校验

自定义校验

参考

@valid与@validated

​

​​SpringMVC中实现Bean Validation(JSR 303 JSR 349 JSR 380)​​

​