springMVC数据校验

阿甲
215 阅读4分钟

持续创作，加速成长！这是我参与「掘金日新计划 · 6 月更文挑战」的第15天，点击查看活动详情 ​ ​

介绍

一般情况下，用户的输入是随意的，为了保证数据的合法性，数据验证是所有 Web 应用必须处理的问题。

Spring MVC 有以下两种方法可以验证输入：

  • 利用 Spring 自带的验证框架
  • 利用 JSR 303 实现

数据验证分为客户端验证和服务器端验证，客户端验证主要是过滤正常用户的误操作，通过 JavaScript 代码完成。服务器端验证是整个应用阻止非法数据的最后防线，通过在应用中编程实现。

本节使用 JSR 303 实现服务器端的数据验证。

关于JSR

JSR是Java Specification Requests的缩写，意思是Java 规范提案。是指向JCP(Java Community Process)提出新增一个标准化技术规范的正式请求。任何人都可以提交JSR，以向Java平台增添新的API和服务。JSR已成为Java界的一个重要标准。

关于 JSR-303

JSR-303 是JAVA EE 6 中的一项子规范，叫做Bean Validation，Hibernate Validator 是 Bean Validation 的参考实现 . Hibernate Validator 提供了 JSR 303 规范中所有内置 constraint 的实现，除此之外还有一些附加的 constraint。

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

校验注解

JSR 303 不需要编写验证器，它定义了一套可标注在成员变量、属性方法上的校验注解，如下表所示。

名称说明
@Null被标注的元素必须为 null
@NotNull被标注的元素必须不为 null
@NotEmpty被标注的元素不能为空1. 没有传递参数 不允许
  1. 空字符串"" 不允许
  2. null 值不允许
  3. " " 有空格的字符串允许注解在字符串属性上 | | @NotBlank | 被标注的元素不能为空1. 没有传递参数 不允许
  4. 空字符串"" 不允许
  5. null 值不允许
  6. " " 有空格 的空字符串 不允许注解在字符串属性上 | | @AssertTrue | 被标注的元素必须为 true | | @AssertFalse | 被标注的元素必须为 false | | @Min(value) | 被标注的元素必须是一个数字，其值必须大于等于指定的最小值 | | @Max(value) | 被标注的元素必须是一个数字，其值必须小于等于指定的最大值 | | @DecimalMax(value) | 被标注的元素必须是一个数字，其值必须大于等于指定的最大值 | | @DecimalMin(value) | 被标注的元素必须是一个数字，其值必须小于等于指定的最小值 | | @size | 被标注的元素的大小必须在指定的范围内 限制字符串长度 | | @Length | hibernate注解 被标注的元素的大小必须在指定的范围内 限制字符串长度 | | @Digits（integer，fraction） | 被标注的元素必须是一个数字，其值必须在可接受的范围内；integer 指定整数精度，fraction 指定小数精度 | | @Past | 被标注的元素必须是一个过去的日期 | | @Future | 被标注的元素必须是一个将来的日期 | | @Pattern(value) | 被标注的元素必须符合指定的正则表达式，与@NotNull 并用 ，限制内容必须输入且 符合正则表达式 (否则，只有传递参数才会有效 ) | | @Email | 验证邮箱格式 |

Spring MVC 支持 JSR 303 标准的校验框架，Spring 的 DataBinder 在进行数据绑定时，可同时调用校验框架来完成数据校验工作，非常简单方便。在 Spring MVC 中，可以直接通过注解驱动的方式来进行数据校验。

Spring 本身没有提供 JSR 303 的实现，Hibernate Validator 实现了 JSR 303，所以必须在项目中加入来自 Hibernate Validator 库的 jar 文件

开始使用

1、maven引入

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

2、javabean注解验证

public class Dept {

    @Min(value = 100)
    int deptNo;
    @NotEmpty(message = "不能为空")
    @Size(min  =6)
    String deptName;
}

3、控制类

@Valid注解用于校验，所属包为：javax.validation.Valid。

controller层的方法的要校验的参数上添加@Valid注解，并且需要传入BindingResult对象，用于获取校验失败情况下的反馈信息，如下代码：

@PostMapping("/dept")
public String save(@Valid Dept dept, BindingResult result){
    // 如果有异常信息
    if (result.hasErrors()) {
        // 获取异常信息对象
        List<ObjectError> errors = result.getAllErrors();
        // 将异常信息输出
        for (ObjectError error : errors) {
            System.out.println(error.getDefaultMessage());
        }
    }
    return "dept";
}

@Validated

@Valid是javax.validation里的。

@Validated是@Valid 的一次封装，是Spring提供的校验机制使用。@Valid不提供分组功能

分组验证

当一个实体类需要多种验证方式时，例：对于一个实体类的id来说，新增的时候是不需要的，对于更新时是必须的。

可以通过groups对验证进行分组

1.分组接口类

（通过向groups分配不同类的class对象，达到分组目的）：


/**
 * 更新部门分组类
 */
public interface UpdateDept {
}

实体类

public class Dept {

    //在更新时 部门id不能为空
    @NotEmpty(groups ={UpdateDept.class} ,message = "部门id不能为空")
    String id;
    @NotEmpty(message = "部门编号不能为空！")
    String deptNo;
    @NotEmpty(message = "部门名称不能为空")
    String deptName;
}

对一个参数需要多种验证方式时，也可通过分配不同的组达到目的。

3、控制类

注：

@Validated没有添加groups属性时，默认验证没有分组的验证属性

@Validated没有添加groups属性时，所有参数的验证类型都有分组,则不验证任何参数

​​

avatar
文章
阅读
粉丝