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

一、增删改场景

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指定使用哪个组

。。。。。。。。。。。。。。。。。

版权原因,完整文章,请参考如下:SpringBoot 使用validation数据校验之分组校验怎么玩?·分组还有这么多讲究 - 第408篇

  • 3
    点赞
  • 8
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
Spring Boot提供了很方便的数据校验功能,可以通过注解方式实现。要使用数据校验功能,首先需要在项目的pom.xml文件中添加相关的依赖。其中,我们可以使用spring-boot-starter-validation依赖来引入数据校验功能。 在代码中,我们可以使用javax.validation.constraints包中的注解来对数据进行校验。常用的注解包括@NotNull、@NotEmpty、@Size、@Min、@Max等。例如,使用@NotNull注解来标记一个字段不能为空。 首先,在需要校验的类中,添加注解@Validated,这样Spring Boot会自动校验被注解标记的字段。然后,在需要校验的字段上添加相关的校验注解,如@NotNull。最后,在Controller的方法参数上添加@Valid注解,来触发数据校验。 下面是一个示例代码,展示了如何在Spring Boot中进行数据校验。 ```java import org.springframework.validation.annotation.Validated; import javax.validation.constraints.NotNull; @RestController @Validated public class UserController { @PostMapping("/user") public String addUser(@Valid @RequestBody User user) { // 业务逻辑处理 // ... return "User added successfully"; } public class User { @NotNull private String username; // getters and setters } } ``` 在上述示例中,我们定义了一个UserController类,其中的addUser方法用于添加用户。在User类中,我们使用了@NotNull注解来标记username字段不能为空。在addUser方法的参数中,我们使用了@Valid注解来触发数据校验。 通过以上配置,当我们发送一个POST请求到"/user"的时候,Spring Boot会自动校验请求体中的数据。如果校验失败,会返回相应的错误信息。如果校验通过,会执行业务逻辑并返回成功信息。 总结一下,Spring Boot提供了简单易用的数据校验功能,可以通过注解方式实现。通过添加相应的依赖和配置,我们可以在项目中方便地使用数据校验功能,保证数据的有效性和完整性。 :https://www.jianshu.com/p/2dabf4f0b72e :https://www.baeldung.com/spring-boot-bean-validation

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值