前言
在日常的开发中，参数校验是十分重要的一个环节，严格参数校验会缩小很多出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这个注解来应用正则表达式进行校验。如果被应用在多处，一旦正则表达式产生更改，则须要一个一个的进行批改。很显然为了防止做这样的无用功，自定义校验注解就是你的好帮手。
@Data
public 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 {
@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 表单数据
@Data
public 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
@Data
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;
}
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 {
@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依赖须要手动引入依赖。
org.springframework.boot
spring-boot-starter-validation
总结
集体的一些小教训，参数的非空判断，这个应该是校验的第一步了，除了非空校验，咱们还须要做到上面这几点：
一般参数 – 须要限定字段的长度。如果会将数据存入数据库，长度以数据库为准，反之依据业务确定。
类型参数 – 最好应用正则对可能呈现的类型做到严格校验。比方type的值是【0|1|2】这样的。
列表(list)参数 – 不仅须要对list内的参数是否合格进行校验，还须要对list的size进行限度。比如说 100。
日期，邮件，金额，URL这类参数都须要应用对于的正则进行校验。
参数真实性 – 这个次要针对于 各种Id 比如说 userId、merchantId，对于这样的参数，都须要进行真实性校验，判断零碎内是有含有，并且对应的状态是否失常。
参数校验越严格越好，严格的校验规定不仅能缩小接口出错的概率，同时还能避免出现脏数据，从而来保证系统的安全性和稳定性。
谬误的揭示信息须要敌对一点哦，避免等下被前端大哥吐槽哦。
上期回顾
SpringBoot对立参数校验
结尾
如果感觉对你有帮忙，能够多多评论，多多点赞哦，也能够到我的主页看看，说不定有你喜爱的文章，也能够顺手点个关注哦，谢谢。
我是不一样的科技宅，每天提高一点点，体验不一样的生存。咱们下期见！
2587
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
