马克社区,马克吐温社区,马克java社区SpringBoot 使用validation数据校验之分组校验怎么玩？·分组还有这么多讲究

SpringBoot 使用validation数据校验之分组校验怎么玩？·分组还有这么多讲究 - 第408篇

分组校验：我们可以把校验注解配置group属性，从而通过分组来满足不同场景下的需求。

我们还是直接看些例子来有一个更加直观的感受。

Spring Boot validation系列：

（1）✅《SpringBoot 使用validation数据校验-超级详细超级多干货》

（2）✅《SpringBoot 使用validation数据校验之分组校验怎么玩？·分组还有这么多的讲究》

（3）《SpringBoot 使用validation数据校验之自定义校验注解·源码分析+实例》

（4）《SpringBoot 使用validation数据校验之国际化问题怎么搞？》满满的干货

这一节我们先来看看《SpringBoot 使用validation数据校验之分组校验怎么玩？》。

一、增删改场景

1.1场景描述

在实际开发中经常会遇到这种情况：添加用户时，id是由后端生成的，不需要校验id是否为空，但是修改用户时就需要校验id是否为空。如果在接收参数的User实体类的id属性上添加NotNull，显然无法实现。这时候就可以定义分组，在需要校验id的时候校验，不需要的时候不校验。

1.2 定义分组

定义分组，接口就行：

import javax.validation.GroupSequence;/** * 分组校验 - 定义分组 * * @author 悟纤「公众号SpringBoot」 * @date 2021-10-14 * @slogan 大道至简 悟在天成 */public class ValidGroup {    // 新增使用(配合spring的@Validated功能分组使用)    public interface Insert{}    // 更新使用(配合spring的@Validated功能分组使用)    public interface Update{}    // 删除使用(配合spring的@Validated功能分组使用)    public interface Delete{}    // 属性必须有这两个分组的才验证(配合spring的@Validated功能分组使用)    @GroupSequence({Insert.class, Update.class,Delete.class})    public interface All{}}

1.3在实体类的注解中标记id使用上面定义的组

在每个注解中有一个属性groups，添加此属性就行：

//只能在Delete和Update的时候才能够进行生效.@Min(value = 1,message = "ID不能小于1",groups = {ValidGroup.Delete.class,ValidGroup.Update.class})private int id;@NotBlank(message = "用户名不能为空",groups = {ValidGroup.Update.class,ValidGroup.Insert.class})private String username;@NotBlank(message = "密码不能为空",groups = {ValidGroup.Update.class,ValidGroup.Insert.class})@Length(min = 6,max = 20,message = "密码长度在6-20之间")private String password;@NotBlank(message = "邮箱不能为空")@Email(message = "邮箱格式不合理")private String email;

1.4在controller中使用@Validated指定使用哪个组

在controller中使用@Validated指定使用哪个组：

@RequestMapping("/saveUserInfo")public UserInfo saveUserInfo(@Validated() UserInfo userInfo){    //save userInfo:将userInfo进行保存    //userInfoService.save(userInfo);    return userInfo;}@RequestMapping("/updateUserInfo")public UserInfo updateUserInfo(@Validated({ValidGroup.Update.class}) UserInfo userInfo){    //save userInfo:将userInfo进行保存    //userInfoService.update(userInfo);    return userInfo;}@RequestMapping("/deleteUserInfo")public UserInfo deleteUserInfo(@Validated({ValidGroup.Delete.class}) UserInfo userInfo){    //save userInfo:将userInfo进行保存    //userInfoService.delete(userInfo);    return userInfo;}

1.5 测试

保存数据：

http://127.0.0.1:8080/userInfo/saveUserInfo?username=wuqian&password=1234456&email=aa@qq.com

说明：保存的方法上并没有指定具体的分组，所以生效的配置只有email，所以在保存的时候以下的链接就能保存成功了。

http://127.0.0.1:8080/userInfo/saveUserInfo?email=aa@qq.com

这里是举例了个错误的例子，大家自行进行修改哦。

修改数据：

http://127.0.0.1:8080/userInfo/updateUserInfo?username=wuqian&password=1234456&id=1

说明：这里的核心是id必须配置，由于email没有在分组内，所以根本不会进行生效。

删除数据：

http://127.0.0.1:8080/userInfo/deleteUserInfo?id=1

说明：删除只需要id。

二、同一个字段不同分组

1.1场景描述

场景：对同一个对象例如User(nickname) 在不同的接口时需要的校验规则不同。例如，访问一个接口需要 nickname不为空；访问另一个接口需要 nickname参数的长度在 [1,3]之间。

1.2 定义分组

这里直接使用上面例子中的ValidGroup

1.3在实体类的注解中使用上面定义的组

@NotBlank(message = "昵称不为空")@Size(message = "昵称长度 [1-3] ", min = 1, max = 3,groups = ValidGroup.Update.class)private String nickname;

1.4在controller中使用@Validated指定使用哪个组

@RequestMapping("/testNikname1")public UserInfo testNikname1(@Validated() UserInfo userInfo){    //save userInfo:将userInfo进行保存    //userInfoService.update(userInfo);    return userInfo;}@RequestMapping("/testNikname2")public UserInfo testNikname2(@Validated({ValidGroup.Update.class}) UserInfo userInfo){    //save userInfo:将userInfo进行保存    //userInfoService.update(userInfo);    return userInfo;}

1.5 测试

访问：/userInfo/testNikname1

如果没有设置参数nickname是会报错的：defaultmessage [昵称不为空]]

如果带了参数nickname，

/userInfo/testNikname1?nickname=good，那么@Size校验是不会生效的，因为设置了分组了。

访问：/userInfo/testNikname，不设置参数nickname的时候是不会报错的，如果设置了参数nickname，那么就要满足@Size定义的规则了。

当然上面的编码方式，并没有明确指定@NotBlank的分组，你也是可以进行指定的：

@NotBlank(message = "昵称不为空",groups = ValidGroup.Insert.class)@Size(message = "昵称长度 [1-3] ", min = 1, max = 3,groups = ValidGroup.Update.class)private String nickname;

这就实现了同一个字段，不同分组不同校验规则。

购买完整视频，请前往：http://www.mark-to-win.com/TeacherV2.html?id=287

框架