SpringBoot统一参数校验
前言
在日常的开发中，参数校验是非常重要的一个环节，严格参数校验会减少很多出bug的概率，增加接口的安全性。也会减少对接时不必要的沟通。比如说：在对接的时候前端动不动就甩个截图过来说接口有问题，你检查了半天发现前端传递的参数有问题。针对以上：今天给大家分享一下SpringBoot如何实现统一参数校验。
实现方式
使用@Validated注解配合参数校验注解， 比如：@NotEmpty对参数进行校验。然后对抛出的异常ControllerAdvice进行捕获然后调整输出数据。
TestController
@RestController
publicclassTestController{
/**
* 表单请求
*@paramform 请求参数
*@return响应数据
*/
@PostMapping("/formRequest")
publicResultVoformRequest(@Validated RequestForm form){
returnResultVoUtil.success(form);
}
/**
* JSON请求
*@paramform 请求参数
*@return响应数据
*/
@PostMapping("/jsonRequest")
publicResultVojsonRequest(@RequestBody @Validated RequestForm form){
returnResultVoUtil.success(form);
}
}
RequestForm
@Data
publicclassRequestForm{
@NotEmpty(message ="姓名不能为空")
privateString name;
@Min(value =1, message ="年龄不能小于1岁")
privateInteger age;
@NotEmpty(message ="性别不能为空")
privateInteger sex;
}
测试结果
请求：http://localhost:8080/formRequest 不传任何参数。
这个时候SpringBoot已经根据校验注解对参数进行校验了。并且输出了一大堆的错误信息。这个时候前端在对接的时候看到这样的错误信息，反手就是给你截个图告诉你接口有问题。所以这个时候就该使用 ControllerAdvice规范异常返回信息了。
ControllerAdvice
@Slf4j
@RestControllerAdvice
publicclassControllerAdvice{
/**
* 拦截表单参数校验
*/
@ResponseStatus(HttpStatus.OK)
@ExceptionHandler({BindException.class})
publicResultVobindException(BindException e){
BindingResult bindingResult = e.getBindingResult();
returnResultVoUtil.error(Objects.requireNonNull(bindingResult.getFieldError()).getDefaultMessage());
}
/**
* 拦截JSON参数校验
*/
@ResponseStatus(HttpStatus.OK)
@ExceptionHandler(MethodArgumentNotValidException.class)
publicResultVobindException(MethodArgumentNotValidException e){
BindingResult bindingResult = e.getBindingResult();
returnResultVoUtil.error(Objects.requireNonNull(bindingResult.getFieldError()).getDefaultMessage());
}
}
@RestControllerAdvice会将返回的数据以json输出，如果不需要可以使用
@ControllerAdvice
以上代码只返回了错误信息。可以根据实际情况进行调整。
这个时候的错误信息就比较友好了，非常明确的指出了缺少参数。
常用校验注解
案例
@Data
publicclassExampleForm{
@NotEmpty(message ="姓名不能为空")
@Length(min =1, max =10, message ="名字长度1~10")
privateString name;
@Range(min =1, max =99, message ="年龄范围在1~99岁")
privateInteger age;
@Pattern(regexp ="^[1][3,4,5,7,8][0-9]{9}$", message ="电话号码有误")
privateString phone;
@Email(message ="邮箱格式有误")
privateString email;
@Valid
@Size(min =1,max =10, message ="列表中的元素数量为1~10")
privateList requestFormList;
@Future(message ="开始时间必须大于当前时间")
privateDate beginTime;
}
实现嵌套验证
在实际的开发中，前台会后台传递一个list，我们不仅要限制每次请求list内的个数，同时还要对list内基本元素的属性值进行校验。这个时候就需要进行嵌套验证了，实现的方式很简单。在list上添加@Vaild就可以实现了。
@Data
publicclassJsonRequestForm{
@Vaild
@Size(min =1,max =10, message ="列表中的元素数量为1~10")
privateList requestFormList;
}
代码地址
https://gitee.com/huangxunhui/unifiedParamCheck.git
结尾
如果觉得对你有帮助，可以多多评论，多多点赞哦，也可以到我的主页看看，说不定有你喜欢的文章，也可以随手点个关注哦，谢谢。有想法的伙伴可以评论或者私信我哦~
作者：不一样的科技宅
