element form自定义校验_SpringBoot分组校验及自定义校验注解
前言
在日常的开发中,参数校验是非常重要的一个环节,严格参数校验会减少很多出bug的概率,增加接口的安全性。在此之前写过一篇SpringBoot统一参数校验主要介绍了一些简单的校验方法。而这篇则是介绍一些进阶的校验方式。比如说:在某个接口编写的过程中肯定会遇到,当xxType值为A,paramA值必传。xxType值为B,paramB值必须传。对于这样的,通常的做法就是在controller加上各种if判断。显然这样的代码是不够优雅的,而分组校验及自定义参数校验,就是来解决这个问题的。
PathVariable参数校验
Restful的接口,在现在来讲应该是比较常见的了,常用的地址栏的参数,我们都是这样校验的。
/** * 获取电话号码信息 */@GetMapping("/phoneInfo/{phone}")public ResultVo phoneInfo(@PathVariable("phone") String phone){ // 验证电话号码是否有效 String pattern = "^[1][3,4,5,7,8][0-9]{9}$"; boolean isValid = Pattern.matches(pattern, phone); if(isValid){ // 执行相应逻辑 return ResultVoUtil.success(phone); } else { // 返回错误信息 return ResultVoUtil.error("手机号码无效"); }}
很显然上面的代码不够优雅,所以我们可以在参数后面,添加对应的正则表达式phone:正则表达式
来进行验证。这样就省去了在controller编写校验代码了。
/** * 获取电话号码信息 */@GetMapping("/phoneInfo/{phone:^[1][3,4,5,7,8][0-9]{9}$}")public ResultVo phoneInfo(@PathVariable("phone") String phone){ return ResultVoUtil.success(phone);}
虽然这样处理后代码更精简了。但是如果传入的手机号码,不符合规则会直接返回404。而不是提示手机号码错误。错误信息如下:
自定义校验注解
我们以校验手机号码为例,虽然validation
提供了@Pattern
这个注解来使用正则表达式进行校验。如果被使用在多处,一旦正则表达式发生更改,则需要一个一个的进行修改。很显然为了避免做这样的无用功,自定义校验注解
就是你的好帮手。
@Datapublic class PhoneForm {
/** * 电话号码 */ @Pattern(regexp = "^[1][3,4,5,7,8][0-9]{9}$" , message = "电话号码有误") private String phone;
}
要实现一个自定义校验注解,主要是有两步。一是注解本身,二是校验逻辑实现类。
PhoneVerify 校验注解
@Target({ElementType.FIELD})@Retention(RetentionPolicy.RUNTIME)@Constraint(validatedBy = PhoneValidator.class)public @interface Phone {
String message() default "手机号码格式有误";
Class>[] groups() default {};
Class extends Payload>[] payload() default {};
}
PhoneValidator 校验实现类
public class PhoneValidator implements ConstraintValidator<Phone, Object> {
@Override public boolean isValid(Object telephone, ConstraintValidatorContext constraintValidatorContext) { String pattern = "^1[3|4|5|7|8]\\d{9}$"; return Pattern.matches(pattern, telephone.toString()); }}
CustomForm 表单数据
@Datapublic class CustomForm {
/** * 电话号码 */ @Phone private String phone;
}
测试接口
@PostMapping("/customTest")public ResultVo customTest(@RequestBody @Validated CustomForm form){ return ResultVoUtil.success(form.getPhone());}
注解的含义
@Target({ElementType.FIELD})
注解是指定当前自定义注解可以使用在哪些地方,这里仅仅让他可以使用属性上。但还可以使用在更多的地方,比如说方法上、构造器上等等。
- TYPE - 类,接口(包括注解类型)或枚举
- FIELD - 字段(包括枚举常量)
- METHOD - 方法
- PARAMETER - 参数
- CONSTRUCTOR - 构造函数
- LOCAL_VARIABLE - 局部变量
- ANNOTATION_TYPE -注解类型
- PACKAGE - 包
- TYPE_PARAMETER - 类型参数
- TYPE_USE - 使用类型
@Retention(RetentionPolicy.RUNTIME)
指定当前注解保留到运行时。保留策略有下面三种:
- SOURCE - 注解只保留在源文件,当Java文件编译成class文件的时候,注解被遗弃。
- CLASS - 注解被保留到class文件,但jvm加载class文件时候被遗弃,这是默认的生命周期。
- RUNTIME - 注解不仅被保存到class文件中,jvm加载class文件之后,仍然存在。
@Constraint(validatedBy = PhoneValidator.class)
指定了当前注解使用哪个校验类来进行校验。
分组校验
UserForm
@Datapublic class UserForm {
/** * id */ @Null(message = "新增时id必须为空", groups = {Insert.class}) @NotNull(message = "更新时id不能为空", groups = {Update.class}) private String id;
/** * 类型 */ @NotEmpty(message = "姓名不能为空" , groups = {Insert.class}) private String name;
/** * 年龄 */ @NotEmpty(message = "年龄不能为空" , groups = {Insert.class}) private String age;
}
Insert分组
public interface Insert {}
Update分组
public interface Update {}
测试接口
/** * 添加用户 */@PostMapping("/addUser")public ResultVo addUser(@RequestBody @Validated({Insert.class}) UserForm form){ // 选择对应的分组进行校验 return ResultVoUtil.success(form);}
/** * 更新用户 */@PostMapping("/updateUser")public ResultVo updateUser(@RequestBody @Validated({Update.class}) UserForm form){ // 选择对应的分组进行校验 return ResultVoUtil.success(form);}
测试结果
添加测试
更新测试
顺序校验@GroupSequence
在@GroupSequence
内可以指定,分组校验的顺序。比如说@GroupSequence({Insert.class, Update.class, UserForm.class})
先执行Insert
校验,然后执行Update
校验。如果Insert
分组,校验失败了,则不会进行Update
分组的校验。
@Data@GroupSequence({Insert.class, Update.class, UserForm.class})public class UserForm {
/** * id */ @Null(message = "新增时id必须为空", groups = {Insert.class}) @NotNull(message = "更新时id不能为空", groups = {Update.class}) private String id;
/** * 类型 */ @NotEmpty(message = "姓名不能为空" , groups = {Insert.class}) private String name;
/** * 年龄 */ @NotEmpty(message = "年龄不能为空" , groups = {Insert.class}) private String age;
}
测试接口
/*** 编辑用户*/@PostMapping("/editUser")public ResultVo editUser(@RequestBody @Validated UserForm form){ return ResultVoUtil.success(form);}
测试结果
哈哈哈,测试结果其实是个死循环,不管你咋输入都会报错,小伙伴可以尝试一下哦。上面的例子只是个演示,在实际中还是别这样做了,需要根据具体逻辑进行校验。
自定义分组校验
对于之前提到了当xxType值为A,paramA值必传。xxType值为B,paramB值必须传这样的场景。单独使用分组校验和分组序列是无法实现的。需要使用@GroupSequenceProvider
才行。
自定义分组表单
@Data@GroupSequenceProvider(value = CustomSequenceProvider.class)public class CustomGroupForm {
/** * 类型 */ @Pattern(regexp = "[A|B]" , message = "类型不必须为 A|B") private String type;
/** * 参数A */ @NotEmpty(message = "参数A不能为空" , groups = {WhenTypeIsA.class}) private String paramA;
/** * 参数B */ @NotEmpty(message = "参数B不能为空", groups = {WhenTypeIsB.class}) private String paramB;
/** * 分组A */ public interface WhenTypeIsA {
}
/** * 分组B */ public interface WhenTypeIsB {
}
}
CustomSequenceProvider
public class CustomSequenceProvider implements DefaultGroupSequenceProvider<CustomGroupForm> {
@Override public List> getValidationGroups(CustomGroupForm form) { List> defaultGroupSequence = new ArrayList<>(); defaultGroupSequence.add(CustomGroupForm.class);if (form != null && "A".equals(form.getType())) { defaultGroupSequence.add(CustomGroupForm.WhenTypeIsA.class); }if (form != null && "B".equals(form.getType())) { defaultGroupSequence.add(CustomGroupForm.WhenTypeIsB.class); }return defaultGroupSequence; }}
测试接口
/** * 自定义分组 */@PostMapping("/customGroup")public ResultVo customGroup(@RequestBody @Validated CustomGroupForm form){ return ResultVoUtil.success(form);}
测试结果
Type类型为A
Type类型为B
小结一下
GroupSequence
注解是一个标准的Bean认证注解。正如之前,它能够让你静态的重新定义一个类的,默认校验组顺序。然而GroupSequenceProvider
它能够让你动态的定义一个校验组的顺序。
注意的一个点
SpringBoot 2.3.x 移除了validation
依赖需要手动引入依赖。
<dependency> <groupId>org.springframework.bootgroupId> <artifactId>spring-boot-starter-validationartifactId>dependency>
总结
个人的一些小经验,参数的非空判断,这个应该是校验的第一步了,除了非空校验,我们还需要做到下面这几点:
- 普通参数 - 需要限定字段的长度。如果会将数据存入数据库,长度以数据库为准,反之根据业务确定。
- 类型参数 - 最好使用正则对可能出现的类型做到严格校验。比如
type
的值是【0|1|2】这样的。 - 列表(list)参数 - 不仅需要对list内的参数是否合格进行校验,还需要对list的size进行限制。比如说 100。
- 日期,邮件,金额,URL这类参数都需要使用对于的正则进行校验。
- 参数真实性 - 这个主要针对于 各种
Id
比如说userId
、merchantId
,对于这样的参数,都需要进行真实性校验,判断系统内是有含有,并且对应的状态是否正常。
参数校验越严格越好,严格的校验规则不仅能减少接口出错的概率,同时还能避免出现脏数据,从而来保证系统的安全性和稳定性。
错误的提醒信息需要友好一点哦,防止等下被前端大哥吐槽哦。
上期回顾
- SpringBoot统一参数校验
结尾
如果觉得对你有帮助,可以多多评论,多多点赞哦,也可以到我的主页看看,说不定有你喜欢的文章,也可以随手点个关注哦,谢谢。
我是不一样的科技宅,每天进步一点点,体验不一样的生活。我们下期见!
element form自定义校验_SpringBoot分组校验及自定义校验注解相关推荐
- 数据校验JSR303快速入门(简单使用、分组效验、自定义注解效验)
前言: 在实际开发中,除了前端需要在表单中验证用户的输入.后台服务也需要对用户传入的参数进行效验,避免他人在得知请求格式后,直接通过类似Postman这样的测试工具进行非常数据请求. JSR303是什 ...
- Hibernate-Validater自定义组序列分组校验
1. Hibernate Validator 中文文档: Hibernate官方文档-https://docs.jboss.org/hibernate/stable/validator/referen ...
- Spring Boot参数校验以及分组校验的使用
简介:做web开发基本上每个接口都要对参数进行校验,如果参数比较少,还比较容易处理,一但参数比较多了的话代码中就会出现大量的if-else语句.虽然这种方式简单直接,但会大大降低开发效率和代码可读性. ...
- JSR303校验的简单使用以及自定义校验规则的代码编写
文章目录 一.JSR303校验 1.简介 2.相关注解 3.JSR303依赖包 二.JSR303自带的校验规则 1.在JavaBean上添加校验规则 2.生效校验规则 2.1 controller返回 ...
- 拼接符 防注入正则校验_SpringBoot 开发秘籍 启动时配置校验
概述 在项目开发过程中,某个功能需要依赖在配置文件中配置的参数.这时候就可能出现下面这种现象问题: 有时候经常出现项目启动了,等到使用某个功能组件的时候出现异常,提示参数未配置或者bean注入失败. ...
- element手机验证格式_基于Vue+elementUI实现动态表单的校验功能(根据条件动态切换校验格式)...
前言 开发过程中遇到了一个需求,根据用户选择的联系方式,动态改变输入框的检验条件,并且整个表单是可以增加的 在线访问:动态表单校验 github(欢迎star): https://github.com ...
- @Validated规则校验和校验分组Group
后台校验有很多的工具,最开始用的是@Valid,这个是比较简单的,不支持分组校验. Spring用@Validated对@Valid进行了封装,这样就满足了分组校验. 其实就是增加了一个group来对 ...
- 参数校验放在controller还是service_@Validated校验的实践
spring-boot中可以用@validated来校验数据,如果数据异常则会统一抛出异常,方便异常中心统一处理. 一.简单使用 1.Controller上开启验证 2.DTO上申明被验证的字段 a. ...
- R语言使用ggplot2包使用geom_violin函数绘制分组小提琴图(自定义边界调色板、brewer调色板、比例灰度)实战
R语言使用ggplot2包使用geom_violin函数绘制分组小提琴图(自定义边界调色板.brewer调色板.比例灰度)实战 目录
最新文章
- 影响声音定位的几个因素
- MySQL 中的反斜杠 \\,真是太坑了!!
- C++井字棋游戏,DOS界面版
- 如何计算一年总共有多少周_余额宝1万一天收益多少?如何计算?
- google天气预报接口_将天气预报添加到谷歌浏览器
- 吴恩达深度学习笔记(八) —— ResNets残差网络
- tomcat运行指定JDK,不运行环境变量配置的JDK
- LINUX操作系统的内核编译内幕详解一
- MyBatis映射文件3(参数处理Map)
- 在Objective-C中,如何测试对象类型?
- 1020. Tree Traversals
- 华为手机6130失效_华为手机的拨号键这5个功能,用过的人都拍手叫好,绝不虚吹...
- Compiler Optimization on VLIW Instruction Scheduling for Low Power
- uCOS在51单片机上的移植心得
- 运行maven项目报错 :The forked VM terminated without saying properly goodbye. VM crash or System.exit calle
- hdu 6438 - 贪心
- 电容降压整流电源电路
- Python案例笔记 | 用python制作二维码
- arcgis 同名图层合并_【求助】ArcGIS中怎样合并图层 - 地学 - 小木虫 - 学术 科研 互动社区...
- 【软件开发】Java语言的简单介绍