Validation校验

本文主要是介绍Validation校验，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

文章目录

Validation校验
- 作用
- 依赖坐标
- UserController接收客户端注册用户请求的方法
- 请求参数封装实体User的结构
- 校验分组

Validation校验

作用

服务端接收前端传递的请求从参数的时候，可以对请求参数进行自动校验。
场景：通过postman向服务端发送一个注册用户的请求，请求参数包括了userName用户名和password用户密码，并不是所有的用户名和密码都可以被注册进来的，因此我们就可以通过Validation来个请求参数格式的校验，如果格式不正确那么我们直接就会抛出异常。

依赖坐标

如下图：
在这里插入图片描述
代码如下：

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"><modelVersion>4.0.0</modelVersion><groupId>org.example</groupId><artifactId>validated</artifactId><version>1.0-SNAPSHOT</version><packaging>jar</packaging><name>validated</name><url>http://maven.apache.org</url><properties><project.build.sourceEncoding>UTF-8</project.build.sourceEncoding></properties><dependencies><!-- https://mvnrepository.com/artifact/org.springframework.boot/spring-boot-starter-web --><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-web</artifactId><version>2.6.6</version></dependency><!-- https://mvnrepository.com/artifact/org.hibernate.validator/hibernate-validator --><dependency><groupId>org.hibernate.validator</groupId><artifactId>hibernate-validator</artifactId><version>6.1.7.Final</version></dependency><!-- https://mvnrepository.com/artifact/org.projectlombok/lombok --><dependency><groupId>org.projectlombok</groupId><artifactId>lombok</artifactId><version>1.18.12</version></dependency><dependency><groupId>junit</groupId><artifactId>junit</artifactId><version>3.8.1</version><scope>test</scope></dependency><dependency><groupId>org.jetbrains</groupId><artifactId>annotations-java5</artifactId><version>RELEASE</version><scope>compile</scope></dependency></dependencies>
</project>

UserController接收客户端注册用户请求的方法

如下图：
在这里插入图片描述
代码如下：

package org.example.controller;import org.example.entity.User;
import org.example.validate.UserGroup;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RestController;@RestController
public class UserController {@PostMapping("/register")public String register(@Validated(value = {UserGroup.Register.class}) @RequestBody User user) {// 保存用户信息到数据库等操作return "注册成功";}
}

请求参数封装实体User的结构

如下图：
在这里插入图片描述
代码如下：

@Data
public class User {@NotNull(groups = {UserGroup.Update.class}, message = "用户名不能为空")@Size(groups = UserGroup.Update.class, min = 5, max = 20, message = "用户名长度必须在5到20个字符之间")private String username;@NotNull(groups = {UserGroup.Update.class}, message = "密码不能为空")@Size(groups = UserGroup.Update.class, min = 8, max = 20, message = "密码长度必须在8到20个字符之间")private String password;
}

校验分组

什么叫做校验分组？举个例子，

比如有个很傻逼的场景：“注册用户的时候需要全部校验username和password属性，但是更新用户的时候不需要校验username和password属性，那么针对于这个场景，我们就可以使用校验分组的思想来实现”。

因此之所以有校验分组就是为了让我们的业务校验更加的灵活，针对于不同类型的请求，虽然这个请求中的参数都是一样的，但是我们的校验规则却不一样了，可能A类型请求的参数我们校验了5个，B类型请求的参数我们却只校验2个；

看一下我们上面的代码中的校验分组的例子，如下图：
在这里插入图片描述

可以发现我们上面只校验了Register注册分组中的参数；

再来看下UserController控制器中指定的校验分组是哪一个，如下图：
在这里插入图片描述
可以发现我们这里在控制器中指定的校验分组也是Register注册分组，因此User中的所有校验规则都会生效；

接着再来看下UserGroup类的结构，如下图：
在这里插入图片描述
其实也就是接口中套接口的格式；

最后在postman中发送一个注册用户的http请求，如下图：
在这里插入图片描述
因为postman中传递的参数为空字符串，因此校验都不会通过，postman的返回结果如上图；再来看下idea里面的控制台输入信息如下图：

而如果我们把上面的User实体中的校验分组都改变为Update分组，那么我们的校验就可以通过了，也不是可以通过，压根就没有去校验，因为我们UserController中指定的校验分组是Register分组，但是User中根本就没有Register分组，全部是Update分组，如下图：
在这里插入图片描述
再来看下postman中的执行结果，如下图：

一个很好的理解校验分组的视角
在UserController控制器中通过@Validate(value = {一个或多个校验分组})指定我们本次使用的一个或多个校验分组，而在我们的后端接收前端请求参数的实体中比如User实体中给属性配置校验分组；
这样我们就能灵活的去根据业务需求结合Validation去校验前端请求参数了。

这篇关于Validation校验的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！