SpringMVC进阶-校验框架-阿里云开发者社区

1 校验框架入门

1.1 表单校验的重要性

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

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

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
导入坐标

  <!--支持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
}

3 多规则校验

同一个属性可以添加多个校验器

@NotNull(message = "请输入您的年龄")
@Max(value = 60,message = "年龄最大值不允许超过60岁")
@Min(value = 18,message = "年龄最小值不允许低于18岁")
private Integer age;//员工年龄

3种判定空校验器的区别

@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={}就行传值

5 分组校验

同一个模块，根据执行的业务不同，需要校验的属性会有不同

新增用户
修改用户

对不同种类的属性进行分组，在校验时可以指定参与校验的字段所属的组类别

定义组（通用）
为属性设置所属组，可以设置多个
开启组校验

下图是简易版步骤图

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

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;
    }
}

测试结果

修改：没有校验帐号

SpringMVC进阶-校验框架

1 校验框架入门

1.1 表单校验的重要性

1.2 表单校验分类

1.3 表单校验规则

1.4 表单校验框架

2 快速使用

3 多规则校验

4 嵌套校验

5 分组校验

热门文章

最新文章

相关课程

相关电子书

热门

活动广场

任务中心

开发者评测

高校计划

乘风者计划

训练营

阿里云MVP

话题

直播

下载

镜像站

技术资料

插件

SpringMVC进阶-校验框架

1 校验框架入门

1.1 表单校验的重要性

1.2 表单校验分类

1.3 表单校验规则

1.4 表单校验框架

2 快速使用

3 多规则校验

4 嵌套校验

5 分组校验

热门文章

最新文章

相关课程

相关电子书