AI 助理
备案控制台
开发者社区 开发与运维 文章 正文

SpringMVC进阶-校验框架

2023-09-10 68
版权
版权声明：
本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《 阿里云开发者社区用户服务协议》和 《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写 侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。
简介： SpringMVC进阶-校验框架

1 校验框架入门

1.1 表单校验的重要性

  • 表单校验保障了数据有效性、安全性

98bba2faddb435338e6110a57a64652f.png

数据可以随意输入，导致错误的结果。后端表单校验的重要性。

1.2 表单校验分类

  • 校验位置：
  • 客户端校验
  • 服务端校验

校验内容与对应方式：

  • 格式校验
  • 客户端：使用Js技术，利用正则表达式校验
  • 服务端：使用校验框架
  • 逻辑校验
  • 客户端：使用ajax发送要校验的数据，在服务端完成逻辑校验，返回校验结果
  • 服务端：接收到完整的请求后，在执行业务操作前，完成逻辑校验


1.3 表单校验规则

  • 长度：例如用户名长度，评论字符数量
  • 非法字符：例如用户名组成
  • 数据格式：例如Email格式、 IP地址格式
  • 边界值：例如转账金额上限，年龄上下限
  • 重复性：例如用户名是否重复

1.4 表单校验框架

  • JSR（Java Specification Requests）：Java 规范提案
  • 303：提供bean属性相关校验规则
  • JSR规范列表
  • 企业应用技术

企业应用技术

Contexts and Dependency Injection for Java (Web Beans 1.0) (JSR 299)

Dependency Injection for Java 1.0 (JSR 330)@postConstruct, @PreDestroy

Bean Validation 1.0 (JSR 303)

Enterprise JavaBeans 3.1 (includes Interceptors 1.1) (JSR 318)

Java EE Connector Architecture 1.6 (JSR 322)

Java Persistence 2.0 (JSR 317)

Common Annotations for the Java Platform 1.1 (JSR 250)

Java Message Service API 1.1 (JSR 914)

  • Java Transaction API (JTA) 1.1 (JSR 907)
    JavaMail 1.4 (JSR 919)
  • Web应用技术

Java Servlet 3.0 (JSR 315)

JavaServer Faces 2.0 (JSR 314)

JavaServer Pages 2.2/Expression Language 2.2 (JSR 245)

Standard Tag Library for JavaServer Pages (JSTL) 1.2 (JSR 52)

Debugging Support for Other Languages 1.0 (JSR 45)

模块化 (JSR 294)

Swing应用框架 (JSR 296)

JavaBeans Activation Framework (JAF) 1.1 (JSR 925)

Streaming API for XML (StAX) 1.0 (JSR 173)

管理与安全技术

Java Authentication Service Provider Interface for Containers (JSR 196)

Java Authorization Contract for Containers 1.3 (JSR 115)

Java EE Application Deployment 1.2 (JSR 88)

J2EE Management 1.1 (JSR 77)

 Java SE中与Java EE有关的规范

JCache API (JSR 107)

Java Memory Model (JSR 133)

Concurrency Utilitie (JSR 166)

Java API for XML Processing (JAXP) 1.3 (JSR 206)

Java Database Connectivity 4.0 (JSR 221)

Java Management Extensions (JMX) 2.0 (JSR 255)

Java Portlet API (JSR 286)

Web Service技术

Java Date与Time API (JSR 310)

Java API for RESTful Web Services (JAX-RS) 1.1 (JSR 311)

Implementing Enterprise Web Services 1.3 (JSR 109)

Java API for XML-Based Web Services (JAX-WS) 2.2 (JSR 224)

Java Architecture for XML Binding (JAXB) 2.2 (JSR 222)

Web Services Metadata for the Java Platform (JSR 181)

Java API for XML-Based RPC (JAX-RPC) 1.1 (JSR 101)

Java APIs for XML Messaging 1.3 (JSR 67)

  • Java API for XML Registries (JAXR) 1.0 (JSR 93)
  • JCP（Java Community Process）：Java社区
  • Hibernate框架中包含一套独立的校验框架hibernate-validator
    导入坐标

20201210135046462.png

  <!--支持tomcat8.5以上-->
  <dependency>
      <groupId>org.hibernate</groupId>
      <artifactId>hibernate-validator</artifactId>
      <version>6.1.0.Final</version>
  </dependency>
<!--支持tomcat7-->
<dependency>
    <groupId>org.hibernate</groupId>
    <artifactId>hibernate-validator</artifactId>
    <version>5.2.1.Final</version>
</dependency>

注意：

tomcat7 ：搭配hibernate-validator版本5...Final

tomcat8.5↑ ：搭配hibernate-validator版本6...Final

2 快速使用

1.编写实体类，存放表单数据。并且设置校验规则

package cn.oldlu.domain;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import org.hibernate.validator.constraints.NotBlank;
import org.springframework.format.annotation.DateTimeFormat;
import javax.validation.constraints.Max;
import javax.validation.constraints.Min;
import javax.validation.constraints.NotNull;
import java.util.Date;
@Data
@NoArgsConstructor
@AllArgsConstructor
public class User {
    @NotBlank(message = "姓名不能为空")
    private String name;
    @NotNull(message = "年龄不能为空")//此处不能用NotBlank,因为该注解只能校验字符串，而age是数字
    @Max(message = "年龄不能超过100",value = 100)
    @Min(message = "年龄不能小于1",value = 1)
    private Integer age;
}

2.编写处理器，接受表单数据，并且启用校验

package cn.oldlu.controller;
import cn.oldlu.domain.User;
import org.springframework.stereotype.Controller;
import org.springframework.validation.Errors;
import org.springframework.validation.FieldError;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.*;
import javax.validation.Valid;
import java.util.HashMap;
import java.util.Map;
@Controller
@RequestMapping("/user")
@CrossOrigin
public class UserController {
    @RequestMapping("/reg")
    @ResponseBody
    public Map method(@Validated User user, Errors errors){//errors中存放校验失败的提示信息
        HashMap<Object, Object> map = new HashMap<>();
        HashMap<Object, Object> errorInfo = new HashMap<>();//存放字段名对应的错误提示
        //判断是否有错误信息
        if(errors.hasErrors()){
            for (FieldError e : errors.getFieldErrors()) {//errors.getFieldErrors()获取所有的错误信息
                //e.getField()表示获取属性名，e.getDefaultMessage()获取错误提示信息
                errorInfo.put(e.getField(),e.getDefaultMessage());
            }
        }
        if(errorInfo.size()==0){//没有错误数据
            map.put("status",true);
        }else{
            map.put("status",false);
            map.put("errorInfos",errorInfo);
        }
        return map;
    }
}

3.测试，访问 http://localhost/user/reg?name&age 结果如下

注意：测试的时候必须写清楚发送给服务器哪些字段，如果不写，服务器可能不校验。

{
    "errorInfos": {
        "name": "姓名不能为空",
        "age": "请输入年龄"
    },
    "status": false
}

3542790f9dfa3454380f13f2a36dd7d0.png

3 多规则校验

  • 同一个属性可以添加多个校验器
@NotNull(message = "请输入您的年龄")
@Max(value = 60,message = "年龄最大值不允许超过60岁")
@Min(value = 18,message = "年龄最小值不允许低于18岁")
private Integer age;//员工年龄
  • 3种判定空校验器的区别

17c08495681563b23f9c8bddaa5a64a3.png

@Null 限制只能为null

@NotNull 限制必须不为null @AssertFalse 限制必须为false @AssertTrue 限制必须为true @DecimalMax(value) 限制必须为一个不大于指定值的数字 @DecimalMin(value)

限制必须为一个不小于指定值的数字 @Digits(integer,fraction)

限制必须为一个小数，且整数部分的位数不能超过integer，小数部分的位数不能超过fraction @Future 限制必须是一个将来的日期

@Max(value) 限制必须为一个不大于指定值的数字 @Min(value) 限制必须为一个不小于指定值的数字 @Past

限制必须是一个过去的日期 @Pattern(value) 限制必须符合指定的正则表达式 @Size(max,min)

限制字符长度必须在min到max之间 @Past 验证注解的元素值（日期类型）比当前时间早

@NotEmpty 验证注解的元素值不为null且不为空（字符串长度不为0、集合大小不为0）

@NotBlank 验证注解的元素值不为空（不为null、去除首位空格后长度为0），不同于@NotEmpty，*@NotBlank只应用于字符串

且在比较时会去除字符串的空格*

@Email 验证注解的元素值是Email，也可以通过正则表达式和flag指定自定义的email格式

需要注意每个注解对应的数据类型

4 嵌套校验

名称：@Valid

类型：属性注解

位置：实体类中的引用类型属性上方

作用：设定当前应用类型属性中的属性开启校验

范例：

package cn.oldlu.domain;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import org.hibernate.validator.constraints.NotBlank;
@Data
@NoArgsConstructor
@AllArgsConstructor
public class Address {
    @NotBlank(message = "省名不能为空")
    /**省的名字*/
    private String province;
    @NotBlank(message = "城市名不能为空")
    /**城市的名字*/
    private String city;
}
package cn.oldlu.domain;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import org.hibernate.validator.constraints.NotBlank;
import org.springframework.format.annotation.DateTimeFormat;
import javax.validation.Valid;
import javax.validation.constraints.Max;
import javax.validation.constraints.Min;
import javax.validation.constraints.NotNull;
import javax.validation.constraints.Pattern;
import java.util.Date;
@Data
@NoArgsConstructor
@AllArgsConstructor
public class User {
    @NotBlank(message = "姓名不能为空")
    @Pattern(regexp = "^[A-Za-z_@.]{6,10}$",message = "用户名必须是6-10位之间的字母、下划线、@、.")
    private String name;
    @NotNull(message = "年龄不能为空")//此处不能用NotBlank,因为该注解只能校验字符串，而age是数字
    @Max(message = "年龄不能超过100",value = 100)
    @Min(message = "年龄不能小于1",value = 1)
    private Integer age;
    @Valid
    private  Address address;
}

注意：

注意：开启嵌套校验后，被校验对象内部需要添加对应的校验规则 之后需要对象.属性要加@Value={}就行传值

7436f07f70a61027d590aa8d8af5dccb.png

5 分组校验

20201210135202251.png

  • 同一个模块，根据执行的业务不同，需要校验的属性会有不同
  • 新增用户
  • 修改用户
  • 对不同种类的属性进行分组，在校验时可以指定参与校验的字段所属的组类别
  • 定义组（通用）
  • 为属性设置所属组，可以设置多个
  • 开启组校验

下图是简易版步骤图

ef37a6e7426937f3962160921e8581f4.png

第一步：定义了两个组，一个是注册的时候校验，一个是修改的时候校验

package cn.oldlu.group;
public interface RegGroup {
}
package cn.oldlu.group;
public interface UpdateUserGroup {
}

第二步：定义User\Address实体类，指定校验规则，并分组校验

规则：注册的时候校验帐号和密码，修改的时候校验密码和地址

Address

package cn.oldlu.domain;
import cn.oldlu.group.RegGroup;
import cn.oldlu.group.UpdateUserGroup;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import org.hibernate.validator.constraints.NotBlank;
@Data
@NoArgsConstructor
@AllArgsConstructor
public class Address {
    @NotBlank(message = "省名不能为空",groups = {UpdateUserGroup.class})
    /**省的名字*/
    private String province;
    @NotBlank(message = "城市名不能为空",groups = {UpdateUserGroup.class})
    /**城市的名字*/
    private String city;
}

User

package cn.oldlu.domain;
import cn.oldlu.group.RegGroup;
import cn.oldlu.group.UpdateUserGroup;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import org.hibernate.validator.constraints.NotBlank;
import org.springframework.format.annotation.DateTimeFormat;
import javax.validation.Valid;
import javax.validation.constraints.Max;
import javax.validation.constraints.Min;
import javax.validation.constraints.NotNull;
import javax.validation.constraints.Pattern;
import java.util.Date;
@Data
@NoArgsConstructor
@AllArgsConstructor
public class User {
    @NotBlank(message = "用户名不能为空",groups = RegGroup.class)
    @Pattern(regexp = "^[A-Za-z_@.]{6,10}$",message = "用户名必须是6-10位之间的字母、下划线、@、.",groups = RegGroup.class)
    private String username;
    @NotBlank(message = "密码不能为空",groups = {RegGroup.class, UpdateUserGroup.class})
    @Pattern(regexp = "^[A-Za-z_@.]{6,10}$",message = "密码必须是6-10位之间的字母、下划线、@、.",groups = {RegGroup.class, UpdateUserGroup.class})
    private String password;
    @Valid()
    private Address address;
}

第三步 在controller层，分别定义两个接口，一个是注册接口，使用注册的校验规则，另一个是修改接口，使用修改的校验规则

package cn.oldlu.controller;
import cn.oldlu.domain.User;
import cn.oldlu.group.RegGroup;
import cn.oldlu.group.UpdateUserGroup;
import org.springframework.stereotype.Controller;
import org.springframework.validation.Errors;
import org.springframework.validation.FieldError;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.*;
import javax.validation.Valid;
import java.util.HashMap;
import java.util.Map;
@Controller
@RequestMapping("/user")
@CrossOrigin
public class UserController {
    @RequestMapping("/reg")
    @ResponseBody
    public Map reg(@Validated(RegGroup.class) User user, Errors errors){//errors中存放校验失败的提示信息
        HashMap<Object, Object> map = new HashMap<>();
        HashMap<Object, Object> errorInfo = new HashMap<>();//存放字段名对应的错误提示
        //判断是否有错误信息
        if(errors.hasErrors()){
            for (FieldError e : errors.getFieldErrors()) {//errors.getFieldErrors()获取所有的错误信息
                //e.getField()表示获取属性名，e.getDefaultMessage()获取错误提示信息
                errorInfo.put(e.getField(),e.getDefaultMessage());
            }
        }
        if(errorInfo.size()==0){//没有错误数据
            map.put("status",true);
        }else{
            map.put("status",false);
            map.put("errorInfos",errorInfo);
        }
        return map;
    }
    @RequestMapping("/update")
    @ResponseBody
    public Map update(@Validated(UpdateUserGroup.class) User user, Errors errors){//errors中存放校验失败的提示信息
        HashMap<Object, Object> map = new HashMap<>();
        HashMap<Object, Object> errorInfo = new HashMap<>();//存放字段名对应的错误提示
        //判断是否有错误信息
        if(errors.hasErrors()){
            for (FieldError e : errors.getFieldErrors()) {//errors.getFieldErrors()获取所有的错误信息
                //e.getField()表示获取属性名，e.getDefaultMessage()获取错误提示信息
                errorInfo.put(e.getField(),e.getDefaultMessage());
            }
        }
        if(errorInfo.size()==0){//没有错误数据
            map.put("status",true);
        }else{
            map.put("status",false);
            map.put("errorInfos",errorInfo);
        }
        return map;
    }
}

测试结果

注册:没有校验地址

525fec3692a7ca4e90bceb0270e16f70.png

修改：没有校验帐号

b14f157cc3b732dbb50446f2aa04c18a.png

文章标签：
Java
API
数据格式
XML
数据安全/隐私保护
关键词：
Spring MVC校验
赵广陆
目录
相关文章
瑶大头*^_^*
|
JSON 前端开发 Java
springmvc-JSR303进行服务端校验&分组验证&SpringMVC定义Restfull接口&异常处理流程&RestController异常处理
springmvc-JSR303进行服务端校验&分组验证&SpringMVC定义Restfull接口&异常处理流程&RestController异常处理
瑶大头*^_^*
72 0
Leader_TBlog
|
前端开发 JavaScript Java
SpringMVC--服务器表单校验
SpringMVC--服务器表单校验
Leader_TBlog
66 0
小小工匠
|
前端开发 Java Spring
Spring MVC-02循序渐进之解耦控制器和校验器
Spring MVC-02循序渐进之解耦控制器和校验器
小小工匠
81 0
pffkzc2qcmn6c
|
前端开发 Java 数据库连接
spring mvc控制层@Validated参数校验
spring mvc控制层@Validated参数校验
pffkzc2qcmn6c
226 0
spring mvc控制层@Validated参数校验
云祁
|
前端开发 JavaScript Java
【Spring MVC】（五）页面在 WEB-INF 下的处理方式（jsp页面、html页面）、SpringMVC 参数校验
【Spring MVC】（五）页面在 WEB-INF 下的处理方式（jsp页面、html页面）、SpringMVC 参数校验
云祁
798 0
【Spring MVC】（五）页面在 WEB-INF 下的处理方式（jsp页面、html页面）、SpringMVC 参数校验
游客xl2p7nx4x3c7g
|
前端开发 Java API
让Controller支持对平铺参数执行数据校验（默认Spring MVC使用@Valid只能对JavaBean进行校验）【享学Spring】
让Controller支持对平铺参数执行数据校验（默认Spring MVC使用@Valid只能对JavaBean进行校验）【享学Spring】
游客xl2p7nx4x3c7g
201 0
让Controller支持对平铺参数执行数据校验（默认Spring MVC使用@Valid只能对JavaBean进行校验）【享学Spring】
java3y
|
Java 网络架构 Spring
SpringMVC【校验器、统一处理异常、RESTful、拦截器】（下）
本博文主要讲解的知识点如下： 校验器 统一处理异常 RESTful 拦截器
java3y
217 0
SpringMVC【校验器、统一处理异常、RESTful、拦截器】（下）
java3y
|
XML 前端开发 Java
SpringMVC【校验器、统一处理异常、RESTful、拦截器】（上）
本博文主要讲解的知识点如下： 校验器 统一处理异常 RESTful 拦截器
java3y
186 0
SpringMVC【校验器、统一处理异常、RESTful、拦截器】（上）
游客a74jvhcp7vclg
|
前端开发 JavaScript Java
SpringMVC教程4[服务器端校验]
SpringMVC教程4[服务器端校验]
游客a74jvhcp7vclg
117 0
SpringMVC教程4[服务器端校验]
donfaquir
|
Web App开发 Java
springMVC对jsp页面的数据进行校验
一. 使用注解校验 a) 引入校验依赖包 javax.validation validation-api 2.0.0.Final org.
donfaquir
1578 0

热门文章

最新文章

  • 1
    SpringMvc+Spring+MyBatis 基于注解整合
  • 2
    配置springmvc在其他类中（spring容器外）获取注入bean
  • 3
    第7章—SpringMVC高级技术—处理异常
  • 4
    SpringMVC标签用法
  • 5
    SpringMVC介绍之视图解析器ViewResolver
  • 6
    02springmvc架构原理分析
  • 7
    Dubbo与Zookeeper、SpringMVC整合和使用（负载均衡、容错）（转）
  • 8
    SpringMVC多视图技术
  • 9
    springMVC学习笔记--知识点总结1
  • 10
    Spring MVC 参数的绑定方法
  • 1
    Spring Boot与Spring MVC的区别和联系
    82
  • 2
    序-Servlet和SpringMVC的联系和区别-配置路径先想好使用的使用的方法，然后匹配的需要的技术
    41
  • 3
    技术笔记：SpringMVC常用注解
    24
  • 4
    SpringMVC的数据响应-直接回写json字符串
    33
  • 5
    SpringMVC的数据响应-19
    28
  • 6
    SpringMVC的XML配置解析-spring18
    36
  • 7
    从代码角度戳一下springMVC的运行过程-spring16
    29
  • 8
    SpringMVC的架构有什么优势？——异常处理与文件上传（五）
    34
  • 9
    SpringMVC的架构有什么优势？——控制器（三）
    38
  • 10
    SpringMVC的架构有什么优势？——表单和数据校验（四）
    40

    • 相关课程

    更多
  • SpringMVC框架入门
  • SpringBoot快速掌握 - 高级应用
  • 使用Spring Data Redis+zTree实现授权模型的设计与思考
  • Java Web开发系列课程 - Spring框架入门

    • 相关电子书

    更多
  • Java Spring Boot开发实战系列课程【第7讲】：Spring Boot 2.0安全机制与MVC身份验证实战(Java面试题)
  • Java Spring Boot开发实战系列课程【第15讲】：Spring Boot 2.0 API与Spring REST Docs实战
  • Spring框架入门
    • 下一篇
    阿里云OSS设置跨域访问