SpringBoot如何优雅的处理校验参数的方法
前言
做web开发有一点很烦人就是要校验参数，基本上每个接口都要对参数进行校验，比如一些格式校验非空校验都是必不可少的。如果参数比较少的话还是容易处理的一但参数比较多了的话代码中就会出现大量的IFELSE就比如下面这样：
这个例子只是校验了一下空参数。如果需要验证邮箱格式和手机号格式校验的话代码会更多，所以介绍一下validator通过注解的方式进行校验参数。
什么是Validator
BeanValidation是Java定义的一套基于注解的数据校验规范，目前已经从JSR303的1.0版本升级到JSR349的1.1版本，再到JSR380的2.0版本（2.0完成于2017.08），已经经历了三个版本。在SpringBoot中已经集成在starter-web中，所以无需在添加其他依赖。
注解介绍
validator内置注解
注解
详细信息
@Null
被注释的元素必须为null
@NotNull
被注释的元素必须不为null
@AssertTrue
被注释的元素必须为true
@AssertFalse
被注释的元素必须为false
@Min(value)
被注释的元素必须是一个数字，其值必须大于等于指定的最小值
@Max(value)
被注释的元素必须是一个数字，其值必须小于等于指定的最大值
@DecimalMin(value)
被注释的元素必须是一个数字，其值必须大于等于指定的最小值
@DecimalMax(value)
被注释的元素必须是一个数字，其值必须小于等于指定的最大值
@Size(max,min)
被注释的元素的大小必须在指定的范围内
@Digits(integer,fraction)
被注释的元素必须是一个数字，其值必须在可接受的范围内
@Past
被注释的元素必须是一个过去的日期
@Future
被注释的元素必须是一个将来的日期
@Pattern(value)
被注释的元素必须符合指定的正则表达式
HibernateValidator附加的constraint
注解
详细信息
被注释的元素必须是电子邮箱地址
@Length
被注释的字符串的大小必须在指定的范围内
@NotEmpty
被注释的字符串的必须非空
@Range
被注释的元素必须在合适的范围内
@NotBlank
验证字符串非null，且长度必须大于0
注意：
- @NotNull适用于任何类型被注解的元素必须不能与NULL
- @NotEmpty适用于StringMap或者数组不能为Null且长度必须大于0
- @NotBlank只能用于String上面不能为null,调用trim()后，长度必须大于0
使用
使用起来也非常简单，下面略过创建项目
模拟用户注册封装了一个UserDTO
当提交数据的时候如果使用以前的做法就是IFELSE判断参数使用validator则是需要增加注解即可。
例如非空校验：
然后需要在controller方法体添加@Validated不加@Validated校验会不起作用
然后请求一下请求接口,把Email参数设置为空
参数:
{
"userName":"luomengsun",
"mobileNo":"11111111111",
"sex":1,
"age":21,
"email":""
}
返回结果：
后台抛出异常
这样是能校验成功，但是有个问题就是返回参数并不理想，前端也并不容易处理返回参数，所以我们添加一下全局异常处理，然后添加一下全局统一返回参数这样比较规范。
添加全局异常
创建一个GlobalExceptionHandler类，在类上方添加@RestControllerAdvice注解然后添加以下代码：
/**
*方法参数校验
*/
@ExceptionHandler(MethodArgumentNotValidException.class)
publicReturnVOhandleMethodArgumentNotValidException(MethodArgumentNotValidExceptione){
log.error(e.getMessage(),e);
returnnewReturnVO().error(e.getBindingResult().getFieldError().getDefaultMessage());
}
此方法主要捕捉MethodArgumentNotValidException异常然后对异常结果进行封装，如果需要在自行添加其他异常处理。
添加完之后我们在看一下运行结果，调用接口返回:
{
"code":"9999",
"desc":"邮箱不能为空",
"data":null
}
OK已经对异常进行处理。
校验格式
如果想要校验邮箱格式或者手机号的话也非常简单。
校验邮箱
/** *邮箱 */ @NotBlank(message="邮箱不能为空") @NotNull(message="邮箱不能为空") @Email(message="邮箱格式错误") privateStringemail;
使用正则校验手机号
校验手机号使用正则进行校验，然后限制了一下位数
/**
*手机号
*/
@NotNull(message="手机号不能为空")
@NotBlank(message="手机号不能为空")
@Pattern(regexp="^[1][3,4,5,6,7,8,9][0-9]{9}$",message="手机号格式有误")
@Max(value=11,message="手机号只能为{max}位")
@Min(value=11,message="手机号只能为{min}位")
privateStringmobileNo;
查看一下运行结果
传入参数：
{
"userName":"luomengsun",
"mobileNo":"111111a",
"sex":1,
"age":21,
"email":"1212121"
}
返回结果：
{
"code":"9999",
"desc":"邮箱格式错误",
"data":null
}
这里不再验证手机号的例子
自定义注解
上面的注解只有这么多，如果有特殊校验的参数我们可以使用Validator自定义注解进行校验
首先创建一个IdCard注解类
@Documented
@Target({ElementType.PARAMETER,ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
@Constraint(validatedBy=IdCardValidator.class)
public@interfaceIdCard{
Stringmessage()default"身份证号码不合法";
Class[]groups()default{};
Class[]payload()default{};
}
在UserDTO中添加@IdCard注解即可验证，在运行时触发，本文不对自定义注解做过多的解释，下篇文章介绍自定义注解
- message提示信息
- groups分组
- payload针对于Bean
然后添加IdCardValidator主要进行验证逻辑
上面调用了is18ByteIdCardComplex方法，传入参数就是手机号，验证身份证规则自行百度
然后使用
@NotNull(message="身份证号不能为空") @IdCard(message="身份证不合法") privateStringIdCardNumber;
分组
就比如上面我们定义的UserDTO中的参数如果要服用的话怎么办？
在重新定义一个类然后里面的参数要重新添加注解？
Validator提供了分组方法完美了解决DTO服用问题
现在我们注册的接口修改一下规则，只有用户名不能为空其他参数都不进行校验
先创建分组的接口
publicinterfaceCreateextendsDefault{
}
我们只需要在注解加入分组参数即可例如：
/** *用户名 */ @NotBlank(message="用户姓名不能为空",groups=Create.class) @NotNull(message="用户姓名不能为空",groups=Create.class) privateStringuserName; @NotBlank(message="邮箱不能为空",groups=Update.class) @NotNull(message="邮箱不能为空",groups=Update.class) @Email(message="邮箱格式错误",groups=Update.class) privateStringemail;
然后在修改Controller在@Validated中传入Create.class
@PostMapping("/user")
publicReturnVOuserRegistra(@RequestBody@Validated(Create.class)UserDTOuserDTO){
ReturnVOreturnVO=userService.userRegistra(userDTO);
returnreturnVO;
}
然后调用传入参数：
{
"userName":"",
}
返回参数：
{
"code":"9999",
"desc":"用户姓名不能为空",
"data":null
}
OK现在只对Create的进行校验，而Updata组的不校验，如果需要复用DTO的话可以使用分组校验
校验单个参数
在开发的时候一定遇到过单个参数的情况,在参数前面加上注解即可
@PostMapping("/get")
publicReturnVOgetUserInfo(@RequestParam("userId")@NotNull(message="用户ID不能为空")StringuserId){
returnnewReturnVO().success();
}
然后在Controller类上面增加@Validated注解,注意不是增加在参数前面。
以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持毛票票。
声明：本文内容来源于网络，版权归原作者所有，内容由互联网用户自发贡献自行上传，本网站不拥有所有权，未作人工编辑处理，也不承担相关法律责任。如果您发现有涉嫌版权的内容，欢迎发送邮件至：czq8825#qq.com（发邮件时，请将#更换为@）进行举报，并提供相关证据，一经查实，本站将立刻删除涉嫌侵权内容。