SpringBoot @GroupSequenceProvider注解实现bean多属性联合校验的示例代码
目录
- 参考资料
- 一. 前期准备
- 二. 需求
- 三. 需求
参考资料
分组序列@GroupSequenceProvider、@GroupSequence控制数据校验顺序，解决多字段联合逻辑校验问题【享学Spring MVC】
Hibernate Validator提供了非标准的
@GroupSequenceProvider注解。针对当前对象实例的状态，动态来决定加载那些校验组进入默认校验组。
需要借助Hibernate Validation提供给我们的DefaultGroupSequenceProvider接口来处理那些属性在什么情况下进入指定的分组。
一. 前期准备
⏹自定义校验数值不能为空的注解
@Documented
@Target({ ElementType.FIELD })
@Retention(RetentionPolicy.RUNTIME)
@Constraint(validatedBy = {ValidateIntegerNotEmpty.StrictIntegerNotEmptyValidator.class})
@ReportAsSingleViolation
public @interface ValidateIntegerNotEmpty {
String msgArgs() default "";
String message() default "{1001E}";
Class<?>[] groups() default {};
Class<? extends Payload>[] payload() default {};
class StrictIntegerNotEmptyValidator implements ConstraintValidator<ValidateIntegerNotEmpty, Integer> {
@Override
public boolean isValid(Integer value, ConstraintValidatorContext context) {
return !ObjectUtils.isEmpty(value);
}
}
}
二. 需求
- 1 当审核状态为2(人工初审拒绝)的时候,审核拒绝原因为必填项,并且范围为1到4
- 当审核状态为2之外(审核中或者人工初审通过)的情况,审核拒绝原因为非必填项
⏹前台
<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
<head>
<script type="text/javascript" th:src="@{/js/public/jquery-3.6.0.min.js}"></script>
<script type="text/javascript" th:src="@{/js/common/common.js}"></script>
<title>test7页面</title>
</head>
<body>
<button id="btn">校验数据</button>
<h1>我是test7的页面</h1>
</body>
<script>
$("#btn").click(() => {
const param1 = {
// 人工初审拒绝
auditStatus: 2,
// 拒绝的原因
auditRejectReason: 5,
};
const url = `http://localhost:8080/test7/groupSequenceProvider`;
doAjax(url, param1, function(data) {
console.log(data);
});
});
</script>
</html>
⏹待校验的form1
import com.example.jmw.common.validation.ValidateIntegerNotEmpty;
import com.example.jmw.form.validation.ValidateTest7FormProvider;
import lombok.Data;
import org.hibernate.validator.constraints.Range;
import org.hibernate.validator.group.GroupSequenceProvider;
@Data
// 通过该注解所对应的自定义Provider来实现多属性联合校验
@GroupSequenceProvider(ValidateTest7FormProvider.class)
public class Test7Form {
/**
* 1: 审核中
* 2: 人工初审拒绝
* 3: 人工初审通过
*/
@ValidateIntegerNotEmpty(msgArgs = "审核状态类型")
@Range(min = 1, max = 3, message = "审核拒绝原因:参数传递错误")
private Integer auditStatus;
/**
* 1: 不符合准入要求
* 2: 三方数据拒贷
* 3: 授信额度为0
* 4: 其他
*/
@ValidateIntegerNotEmpty(msgArgs = "审核拒绝原因", groups = auditGroup.class)
@Range(min = 1, max = 4, message = "审核拒绝原因:参数传递错误", groups = auditGroup.class)
private Integer auditRejectReason;
// 自定义分组
public interface auditGroup {
}
}
⏹校验器
import com.example.jmw.form.Test7Form;
import org.hibernate.validator.spi.group.DefaultGroupSequenceProvider;
import org.springframework.util.ObjectUtils;
import java.util.ArrayList;
import java.util.List;
import java.util.Optional;
public class ValidateTest7FormProvider implements DefaultGroupSequenceProvider<Test7Form> {
@Override
public List<Class<?>> getValidationGroups(Test7Form test7Form) {
List<Class<?>> defaultGroupSequence = new ArrayList<>();
defaultGroupSequence.add(Test7Form.class);
if (ObjectUtils.isEmpty(test7Form)) {
return defaultGroupSequence;
}
// 获取 人工初审 状态
Integer auditStatus = Optional.ofNullable(test7Form.getAuditStatus()).orElse(0) ;
// 如果 人工初审通过的话,审核拒绝原因的auditGroup组就会起作用,就变为必填项目,否则为选填项目
if (auditStatus == 2) {
defaultGroupSequence.add(Test7Form.auditGroup.class);
}
return defaultGroupSequence;
}
}
⏹Controller层进行校验
@Controller
@RequestMapping("/test7")
public class Test7Controller {
@Resource
private LocalValidatorFactoryBean validator;
@GetMapping("/init")
public ModelAndView init() {
ModelAndView modelAndView = new ModelAndView();
modelAndView.setViewName("test7");
return modelAndView;
}
@PostMapping("/groupSequenceProvider")
@ResponseBody
public void groupSequenceProvider(@RequestBody Test7Form form) {
Set<ConstraintViolation<Test7Form>> validate = validator.validate(form);
for (ConstraintViolation<Test7Form> bean : validate) {
// 获取当前的校验信息
String message = bean.getMessage();
System.out.println(message);
}
}
}
当参数auditStatus为2(人工初审拒绝)时,auditRejectReason(审核拒绝原因)超出了1到4的范围,因此显示出校验信息
当参数auditStatus为2(人工初审拒绝)时,auditRejectReason(审核拒绝原因)为必填项,因此显示出校验信息
当参数auditStatus为3(人工初审通过)时,auditRejectReason(审核拒绝原因)为非必填项,因此无校验失败信息
三. 需求
- 2 当游客(1)访问时,最多有2个权限
- 当领导(2)访问时,最多有4个权限
- 当管理员(3)访问时,最多有10个权限
⏹前台
<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
<head>
<script type="text/javascript" th:src="@{/js/public/jquery-3.6.0.min.js}"></script>
<script type="text/javascript" th:src="@{/js/common/common.js}"></script>
<title>test7页面</title>
</head>
<body>
<button id="btn">校验数据</button>
<h1>我是test7的页面</h1>
</body>
<script>
$("#btn").click(() => {
const param2 = {
// 领导(2)访问
role: 2,
// 权限的数量为5
permissionList: [1, 1, 1, 1, 1],
};
const url = `http://localhost:8080/test7/groupSequenceProvider`;
doAjax(url, param2, function(data) {
console.log(data);
});
});
</script>
</html>
⏹待校验的form2
import com.example.jmw.common.validation.ValidateIntegerNotEmpty;
import com.example.jmw.form.validation.ValidateTest7Form1Provider;
import lombok.Data;
import org.hibernate.validator.constraints.Range;
import org.hibernate.validator.group.GroupSequenceProvider;
import javax.validation.constraints.Size;
import java.util.List;
@Data
// 通过该注解所对应的自定义Provider来实现多属性联合校验
@GroupSequenceProvider(ValidateTest7Form1Provider.class)
public class Test7Form1 {
/**
* 1: 访客
* 2: 领导
* 3: 管理员
*/
@ValidateIntegerNotEmpty(msgArgs = "角色类型")
@Range(min = 1, max = 3, message = "错误原因:参数传递错误")
private Integer role;
@Size.List({
// 访客1个权限
@Size(min = 1, max = 2, message = "访客最多拥有2个权限", groups = GuestGroup.class),
// 领导4个权限
@Size(min = 1, max = 4, message = "领导最多拥有4个权限", groups = LeaderGroup.class),
// 管理员10个权限
@Size(min = 1, max = 10, message = "管理员最多拥有10个权限", groups = AdminGroup.class)
})
private List<Integer> permissionList;
// 游客分组
public interface GuestGroup {
}
// 领导分组
public interface LeaderGroup {
}
// 管理员分组
public interface AdminGroup {
}
}
⏹校验器
import com.example.jmw.form.Test7Form1;
import org.hibernate.validator.spi.group.DefaultGroupSequenceProvider;
import org.springframework.util.ObjectUtils;
import java.util.*;
public class ValidateTest7Form1Provider implements DefaultGroupSequenceProvider<Test7Form1> {
/**
* 1: 访客
* 2: 领导
* 3: 管理员
*/
private final static List<Integer> roleList = Arrays.asList(1, 2, 3);
@Override
public List<Class<?>> getValidationGroups(Test7Form1 test7Form1) {
List<Class<?>> defaultGroupSequence = new ArrayList<>();
defaultGroupSequence.add(Test7Form1.class);
if (ObjectUtils.isEmpty(test7Form1)) {
return defaultGroupSequence;
}
// 获取角色code
Integer role = Optional.ofNullable(test7Form1.getRole()).orElse(0) ;
if (!roleList.contains(role)) {
return defaultGroupSequence;
}
// 根据角色code,开启相应的组校验
if (role == 1) {
defaultGroupSequence.add(Test7Form1.GuestGroup.class);
} else if (role == 2) {
defaultGroupSequence.add(Test7Form1.LeaderGroup.class);
} else if (role == 3) {
defaultGroupSequence.add(Test7Form1.AdminGroup.class);
}
return defaultGroupSequence;
}
}
⏹Controller层进行校验
@Controller
@RequestMapping("/test7")
public class Test7Controller {
@Resource
private LocalValidatorFactoryBean validator;
@GetMapping("/init")
public ModelAndView init() {
ModelAndView modelAndView = new ModelAndView();
modelAndView.setViewName("test7");
return modelAndView;
}
@PostMapping("/groupSequenceProvider")
@ResponseBody
public void groupSequenceProvider(@RequestBody Test7Form1 form) {
Set<ConstraintViolation<Test7Form1>> validate = validator.validate(form);
for (ConstraintViolation<Test7Form1> bean : validate) {
// 获取当前的校验信息
String message = bean.getMessage();
System.out.println(message);
}
}
}
当角色为2(领导)时,最多只能有4个权限,因此显示校验信息
当角色为1(访客)时,最多只能有2个权限,因此显示校验信息
当角色为3(管理员)时,最多有10个权限,因此无校验信息
到此这篇关于SpringBoot @GroupSequenceProvider注解实现bean多属性联合校验的文章就介绍到这了,更多相关SpringBoot联合校验内容请搜索我们以前的文章或继续浏览下面的相关文章希望大家以后多多支持我们！
相关推荐
-
SpringBoot中@Pattern注解对时间格式校验方式
目录 SpringBoot @Pattern注解对时间格式校验 1.需求背景 2.实现案例 @Pattern的用法 下面是常用的正则表达式 SpringBoot @Pattern注解对时间格式校验 1.需求背景 有一个需求,在前端传过来的时间格式的字符串进行校验,是否符合"yyyy-MM-dd HH:mm:ss",在SpringBoot中当然可以用@Datetimeformat注解来进行验证,但字段的属性得用Date类型,由于我的项目中该字段用了String类型,需要对类型进行转换不太
-
SpringBoot @Validated注解实现参数分组校验的方法实例
前言 在前后端分离开发的时候我们需要用到参数校验,前端需要进行参数校验,后端接口同样的也需要,以防传入不合法的数据. 1.首先还是先导包,导入pom文件. <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-validation</artifactId> </dependency> 2.解释一下注解的作用 @N
-
SpringBoot常见get/post请求参数处理、参数注解校验及参数自定义注解校验详解
目录 springboot常见httpget,post请求参数处理 PathVaribale获取url路径的数据 RequestParam获取请求参数的值 注意 GET参数校验 POSTJSON参数校验 自定义注解校验 总结 spring boot 常见http get ,post请求参数处理 在定义一个Rest接口时通常会利用GET.POST.PUT.DELETE来实现数据的增删改查:这几种方式有的需要传递参数,后台开发人员必须对接收到的参数进行参数验证来确保程序的健壮性 GET一般用于查询数
-
SpringBoot中自定义注解实现参数非空校验的示例
前言 由于刚写项目不久,在写 web 后台接口时,经常会对前端传入的参数进行一些规则校验,如果入参较少还好,一旦需要校验的参数比较多,那么使用 if 校验会带来大量的重复性工作,并且代码看起来会非常冗余,所以我首先想到能否通过一些手段改进这点,让 Controller 层减少参数校验的冗余代码,提升代码的可阅读性. 经过阅读他人的代码,发现使用 annotation 注解是一个比较方便的手段,SpringBoot 自带的 @RequestParam 注解只会校验请求中该参数是否存在,但是该参数是
-
SpringBoot @GroupSequenceProvider注解实现bean多属性联合校验的示例代码
目录 参考资料 一. 前期准备 二. 需求 三. 需求 参考资料 分组序列@GroupSequenceProvider.@GroupSequence控制数据校验顺序,解决多字段联合逻辑校验问题[享学Spring MVC] Hibernate Validator提供了非标准的@GroupSequenceProvider注解.针对当前对象实例的状态,动态来决定加载那些校验组进入默认校验组.需要借助Hibernate Validation提供给我们的DefaultGroupSequenceProvid
-
Springboot实现根据条件切换注入不同实现类的示例代码
最近有个一需求需要根据外界环境的属性(操作系统 || yml属性 || 其他bean的状态) 来实现启动时注入两套不同的实现类, 实现切换. 实现启动时条件注入分2步: 第一步 使用@Conditional(参数为 True false条件实现类 需要你自己实现)注解 @Conditional(RabbitMqCondition.class) public class RabbitmqSMSMsgServiceImpl extends RabbitmqBasicMsgService { // @
-
SpringBoot中时间类型 序列化、反序列化、格式处理示例代码
[SpringBoot] 中时间类型 序列化.反序列化.格式处理 Date yml全局配置 spring: jackson: time-zone: GMT+8 date-format: yyyy-MM-dd HH:mm:ss #配置POST请求Body中Date时间类型序列化格式处理,并返回 请求参数类型转换 /** * 时间Date转换 * 配置GET请求,Query查询Date时间类型参数转换 */ @Component public class DateConverter implemen
-
SpringBoot+Redis实现后端接口防重复提交校验的示例
目录 1 Maven依赖 2 RepeatedlyRequestWrapper 3 RepeatableFilter 4 RepeatSubmit 5 RepeatSubmitInterceptor 6 RepeatSubmitConfig 7 RepeatSubmitController 1 Maven依赖 <!--redis缓存--> <dependency> <groupId>org.springframework.boot</groupId> <
-
SpringBoot利用限速器RateLimiter实现单机限流的示例代码
目录 一. 概述 二. SpringBootDemo 2.1 依赖 2.2 application.yml 2.3 启动类 2.4 定义一个限流注解 RateLimiter.java 2.5 代理: RateLimiterAspect.java 2.6 使用 一. 概述 参考开源项目https://github.com/xkcoding/spring-boot-demo 在系统运维中, 有时候为了避免用户的恶意刷接口, 会加入一定规则的限流, 本Demo使用速率限制器com.xkcoding.r
-
SpringBoot如何实现一个实时更新的进度条的示例代码
前言 博主近期接到一个任务,大概内容是:导入excel表格批量修改状态,期间如果发生错误则所有数据不成功,为了防止重复提交,做一个类似进度条的东东. 那么下面我会结合实际业务对这个功能进行分析和记录. 正文 思路 前端使用bootstrap,后端使用SpringBoot分布式到注册中心,原先的想法是导入表格后异步调用修改数据状态的方法,然后每次计算修改的进度然后存放在session中,前台jquery写定时任务访问获取session中的进度,更新进度条进度和百分比.但是这存在session在服务
-
SpringBoot结合JSR303对前端数据进行校验的示例代码
一.校验分类 数据的校验一般分为**前端校验.后端校验** 二.前端校验 前端校验是最为明显的,先说一下: ① HTML 非空校验 如 HTML5 新增的属性required="true",一旦没有填写就输入框就显示红色,具体使用如: <input type="text" id="name" name="name" required="true"/> ② JS 同时在提交表单发送 Ajax请求
-
springboot 在xml里读取yml的配置信息的示例代码
YML是什么 YAML (YAML Ain't a Markup Language)YAML不是一种标记语言,通常以.yml为后缀的文件,是一种直观的能够被电脑识别的数据序列化格式,并且容易被人类阅读,容易和脚本语言交互的,可以被支持YAML库的不同的编程语言程序导入,一种专门用来写配置文件的语言.可用于如: Java,C/C++, Ruby, Python, Perl, C#, PHP等. 可以用<springProperty> 标签从Spring中显示属性 以下为在日志配置文件中读取的示例
-
SpringBoot实现接口等幂次校验的示例代码
目录 主流的实现方案如下: 第一步:书写redis工具类 第二步.书写token工具类 第三步:定义注解,使用在方法上,当控制层的方法上被注释时,表示该请求为等幂性请求 第四步:拦截器配置.选择前置拦截器,每次请求都校验到达的方法上是否有等幂性注解,如果有则进行token校验 第五步:对拦截器进行url模式匹配,并注入spring容器 第六步:控制层 接口等幂性通俗的来说就是同一时间内,发起多次请求只有一次请求成功:其目的时防止多次提交,数据重复入库,表单验证网络延迟重复提交等问题. 比如: 订
-
SpringBoot整合screw实现数据库文档自动生成的示例代码
有时候数据库文档需要整理,可是只能手动的复制粘贴,心中一万只草泥马奔腾而过... screw 简洁好用的数据库表结构文档生成工具. 1. 创建项目 1.1 pom.xml <dependency> <groupId>mysql</groupId> <artifactId>mysql-connector-java</artifactId> <scope>runtime</scope> </dependency>