🪴 Obsidian Publish

SpringMVC-7 数据校验

12分钟阅读

Validation

在 Web 应用 MVC 三层架构体系中，表述层负责接收浏览器提交的数据，业务逻辑层负责数据的处理。为了能够让业务逻辑层基于正确的数据进行处理，我们需要在表述层对数据进行检查，将错误的数据隔绝在业务逻辑层之外。在实际的项目中，一般会有两种校验数据的方式：客户端校验和服务端校验

  • 客户端校验：这种校验一般是在前端页面使用 JS 代码进行校验，主要是验证输入数据的合法性，不合法的数据则没有必要再发送至服务端了，前端校验可以有效的提高用户体验，但是无法确保数据完整性，因为前端用户可以方便的拿到请求地址，然后直接发送请求，传递非法参数。
  • 服务端校验：可以有效的保证数据安全与完整性，但是用户体验要差一点，所以客户端校验和服务端校验通常两者结合使用。

本文是服务端的校验。Spring MVC 提供了多种校验机制，其中有 Bean Validation 及 Spring Validator 接口校验。在 Spring 4.0 之后，支持 Bean Validation 1.0（JRS-303）和 Bean Validation 1.1（JRS-349）校验，可以单独集成 Hibernate 的 validation 校验框架，用于服务端的数据校验。

1 校验概述

JSR 303 是 Java 为 Bean 数据合法性校验提供的标准框架，它已经包含在 JavaEE 6.0 标准中。JSR 303 通过在 Bean 属性上标注类似于@NotNull、@Max 等标准的注解指定校验规则，并通过标准的验证接口对 Bean 进行验证。

注解作用
@Null标注的属性必须为 null
@NotNull标注的属性必须不为 null
@AssertTrue标注的属性必须为 true
@AssertFalse标注的属性必须为 false
@Min(value)标注的属性必须是一个数字，并且其值必须大于或等于 value
@Max(value)标注的属性必须是一个数字，并且其值必须小于或等于 value
@DecimalMin(value)必须大于或等于 value
@DecimalMax(value)必须小于或等于 value
@Size(max,min)大小必须在 max 和 min 限定的范围内
@Digits(integer,fratction)值必须是一个数字，且必须在可接受的范围内
@Past只能用于日期型，且必须是过去的日期
@Future只能用于日期型，且必须是将来的日期
@Pattern(value)必须符合指定的正则表达式

JSR 303 只是一套标准，需要提供其实现才可以使用。而 Hibernate Validator 是 JSR 303 的一个参考实现，除支持所有标准的校验注解外，它还支持以下的扩展注解：

注解作用
@Email必须是格式正确的 Email 地址
@Length被注释的字符串大小必须在指定的范围内
@NotEmpty被注释的字符串不能是空字符串
@Range被注释的元素必须在指定的范围内
@URL被注释的字符为 URL

特别注意：@NotEmpty、@NotNull 和@NotBlank 三种的区别：

  • @NotNull：一般用在基本数据类型上（包括包装类），对象不能为 null，但可以为 empty，即为空集（size = 0）。
  • @NotEmpty：可以作用在 String、List、Map 和 Array 等，对象不能为 null，而且长度必须大于 0 (size > 0)
  • @NotBlank：只能作用在 String 上，不能为 null，而且调用 trim()后，长度必须大于 0 ，即：必须有实际字符

2 普通校验

[1]、导入校验相关的依赖

<dependency>
    <groupId>org.hibernate.validator</groupId>
    <artifactId>hibernate-validator</artifactId>
    <version>6.2.0.Final</version>
</dependency>
 
<!-- springboot 导入-->
<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-validation</artifactId>
</dependency>

[2]、在 springmvc.xml 配置文件中配置校验器（springboot 不需要再进行配置）

    <!-- 配置校验器 -->
    <bean id="validator" class="org.springframework.validation.beanvalidation.LocalValidatorFactoryBean">
        <!-- 校验器-->
        <property name="providerClass" value="org.hibernate.validator.HibernateValidator"/>
        <!-- 指定校验使用的资源文件，如果不指定则默认使用classpath下的ValidationMessages.properties -->
        <property name="validationMessageSource" ref="messageSource"/>
    </bean>
    <!-- 校验错误信息配置文件 -->
    <bean id="messageSource"
          class="org.springframework.context.support.ReloadableResourceBundleMessageSource">
        <!-- 资源文件名-->
        <property name="basenames">
            <list>
                <value>classpath:CustomValidationMessages</value>
            </list>
        </property>
        <!-- 资源文件编码格式 -->
        <property name="defaultEncoding" value="utf-8"/>
        <!-- 对资源文件内容缓存时间，单位秒 -->
        <property name="cacheSeconds" value="120"/>
    </bean>

[3]、将配置的校验器注入到处理器适配器中（springboot 不需要再进行配置）

<!-- 配置MVC注解驱动,配置注入校验器 -->
<mvc:annotation-driven validator="validator"/>

[4]、创建校验错误的信息，在项目中创建一个名称为 CustomValidationMessages.properties 的文件(因为上面的配置文件中叫这个名字)：

#添加校验错误提示信息
user.id.isEmpty="用户的ID不能为空！"
user.userName.isEmpty="用户名不能为空！"
user.userName.length="用户名为1~6个字符！"
user.userPwd.isEmpty="密码不能为空！"
user.userPwd.length="密码的长度为5~15个字符！"
user.userEmail.isEmpty="邮箱不能为空！"
user.userEmail.format="输入的邮箱格式不正确！"

[5]、在 pojo 实体类中添加校验规则

public class User {
 
    @NotNull(message = "{user.id.isEmpty}")
    private Integer id;
 
    @NotEmpty(message = "{user.userName.isEmpty}")
    @Length(min = 1, max = 6, message = "{user.userName.length}")
    private String userName;
 
    @NotEmpty(message = "{user.userPwd.isEmpty}")
    @Length(min = 5, max = 15, message = "{user.userPwd.length}")
    private String userPwd;
 
    @NotEmpty(message = "{user.userEmail.isEmpty}")
    @Email(message = "{user.userEmail.format}")
    private String userEmail;
 
    // getter setter 构造器 toString省略...
}

[6]、捕获校验错误信息 Controller 代码

注意：@Validated 注解和 BindingResult 是配对出现的，中间不能穿插其它的形参，否则会报 400 错误，你要进入其它形参可以在它两的后面写。

@Controller
public class ValidateController {
 
    @ResponseBody
    @RequestMapping("/validate")
    // 形参前面加上@Validated注解表示这个实体类需要进行数据校验
    // BindingResult 封装数据绑定的结果
    public void validate(@Validated User user, BindingResult bindingResult) {
        if (bindingResult.hasErrors()) {
            //校验未通过，获取所有的异常信息并展示出来
            List<ObjectError> allErrors = bindingResult.getAllErrors();
            for (ObjectError allError : allErrors) {
                System.out.println(allError.getObjectName() + ":" + allError.getDefaultMessage());
            }
        }
    }
}

[7]、测试结果如下所示：

①、页面上什么也不输入

image image

②、输入部分错误格式的内容（密码长度小于 5，邮箱格式错误！）

image image

3 分组校验

在进行校验的时候，校验的规则一般都是写在实体类上面的，而有时一个实体类会被多处使用，例如不同的 Controller 中需要使用同一个实体，当不同的 Controller 方法对同一个实体对象进行校验时，每个 Controller 方法需要不同的校验，所以对于这种情况，就需要使用分组校验。

[1]、首先定义校验组，所谓的校验组，它其实就是空接口：

注意：分组接口中不需要编写任何的方法定义，该接口仅仅作为分组校验的一个标识接口。

// 分组检验接口1
public interface ValidationGroup1 {
}
 
// 分组检验接口2
public interface ValidationGroup2 {
}

[2]、在实体类中为每一个校验的规则设置所属组：

public class User {
 
    // groups属性表示校验属于哪个组，可以定义多个
    @NotNull(message = "{user.id.isEmpty}", groups = {ValidationGroup2.class})
    private Integer id;
 
    @NotEmpty(message = "{user.userName.isEmpty}", groups = {ValidationGroup1.class, ValidationGroup2.class})
    @Length(min = 1, max = 6, message = "{user.userName.length}", groups = {ValidationGroup1.class, ValidationGroup2.class})
    private String userName;
 
    @NotEmpty(message = "{user.userPwd.isEmpty}", groups = {ValidationGroup1.class})
    @Length(min = 5, max = 15, message = "{user.userPwd.length}", groups = {ValidationGroup1.class})
    private String userPwd;
 
    @NotEmpty(message = "{user.userEmail.isEmpty}", groups = {ValidationGroup2.class})
    @Email(message = "{user.userEmail.format}", groups = {ValidationGroup2.class})
    private String userEmail;
 
    // getter setter 构造器 toString 省略...
}

[1] 和 [2] 步骤可以合并为如下所示：

@Data
public class ArticleVO {
  //新增组
  public static interface AddArticleGroup { };
  //编辑修改组
  public static interface EditArticleGroup { };
 
  //文章主键
  @NotNull(message = "文章ID不能为空", groups = { EditArticleGroup.class } )
  @Min(value = 1, message = "文章ID从1开始",
       groups = { EditArticleGroup.class } )
  private Integer id;
 
  @NotNull(message = "必须有作者",
           groups = {AddArticleGroup.class, EditArticleGroup.class})
  private Integer userId;
 
  //同一个属性可以指定多个注解
  @NotBlank(message = "文章必须有标题",
            groups = {AddArticleGroup.class, EditArticleGroup.class})
  //@Size中null 认为是有效值.所以需要@NotBlank
  @Size(min = 3, max = 30, message = "标题必须3个字以上",
      groups = {AddArticleGroup.class,EditArticleGroup.class})
  private String title;
 
  @NotBlank(message = "文章必须副标题",
           groups = {AddArticleGroup.class, EditArticleGroup.class})
  @Size(min = 8, max = 60, message = "副标题必须30个字以上",
       groups = {AddArticleGroup.class,EditArticleGroup.class})
  private String summary;
 
  @DecimalMin(value = "0", message = "已读最小是0",
              groups = {AddArticleGroup.class,EditArticleGroup.class})
  private Integer readCount;
 
  //可为null，有值必须符合邮箱要求
  @Email(message = "邮箱格式不正确",
         groups = {AddArticleGroup.class, EditArticleGroup.class})
  private String email;
}

[3]、然后在接收参数的地方，指定校验组（配置完成后，属于 ValidationGroup2 这个组的校验规则，才会生效。）：

@Controller
public class ValidateController {
 
    @ResponseBody
    @RequestMapping("/validate")
    // @Validated 注解 value 参数为：ValidationGroup2.class，表示只有这个组内的校验规则会生效，其它都不会生效
    public void validate(@Validated(value = {ValidationGroup2.class}) User user, BindingResult bindingResult) {
        if (bindingResult.hasErrors()) {
            //校验未通过，获取所有的异常信息并展示出来
            List<ObjectError> allErrors = bindingResult.getAllErrors();
            for (ObjectError allError : allErrors) {
                System.out.println(allError.getObjectName() + ":" + allError.getDefaultMessage());
            }
        }
    }
}

[4]、最后测试一下效果有没有：

前面指定的校验组为 ValidationGroup2 组，而实体中只有 userPwd 属性只属于 ValidationGroup1 组，所以可以看到控制台打印的信息中，关于密码的校验信息是没有打印的，说明是校验的 ValidationGroup2 组。

image image

4 ValidationAutoConfiguration

spring-boot-starter-validation 引入了 jakarta.validation:jakarta.validation-api:3.0.2 约束接口，org.hibernate.validator:hibernate-validator:8.0.0.Final 约束注解的功能实现

ValidationAutoConfiguration 自动配置类，创建了 LocalValidatorFactoryBean 对象，当有 class 路径中有 hibernate.validator。能够创建 hiberate 的约束验证实现对象。

@ConditionalOnResource(resources = “classpath:META-INF/services/jakarta.validation.spi.ValidationProvider”)

SpringMVC-7 数据校验.png

反向链接