参数自动校验
一般情况我们前端向后端传递参数都是2种方式 JSON或者表单提交
因此本文分别讲述JSON提交参数校验和表单提交参数校验在Spring Boot中是如何操作，以及校验失败如何统一转交给异常处理类去处理的。
{"username":"123","password":"123"}
采用JSON方式提交,所以设置content-type如下:
Content-Type: application/json
新建一个Spring Boot项目
Api如下设计：
/** *@author: hujiansong *@email: [email protected] *@since: 2019/1/29 16:53 */@RestControllerpublicclassValidController{@GetMapping("/get-args-valid")publicStringgetArgsValid(String username, String password){returnnull; }@PostMapping("/post-args-valid")publicStringpostArgsValid(@RequestBody User user){returnnull; }@DataclassUser{ String username; String password; }}复制代码
先讲JSON方式如何进行参数校验
JSON方式:
@RestControllerpublicclassValidController{@PostMapping("/post-args-valid")publicStringpostArgsValid(@Valid<1> @RequestBody User user){returnnull; }@DatastaticclassUser{@NotNull(message ="用户名不能为空")<2> String username;@NotNull(message ="密码不能为空") String password; }}复制代码
注意: 这里内部类User需要加上static，否则json传过来无法解析
<1>:@Valid表示这个实体参数交给Spring去校验
<2>:@NotNull校验规则
如上2步操作就可以完成参数校验:
可以看到如何password不传递，spring 已经帮我们做了参数校验，再来看看表单方式
表单方式:
@RestController@Validated<1>public class ValidController { @GetMapping("/get-args-valid") public String getArgsValid(@NotNull(message = "用户名不能空")<2> String username, @NotNull(message = "密码不能为空") String password) { return null; }}复制代码
同样也是2步搞定
<1>:@Validated,交给Spring去校验
<2>:@NotNull校验规则
看看如果password不传递会返回什么:
可见，Spring已经替我们做了参数校验
Spring 还包含了很多校验规则如下：
注解解释
@Null被注释的元素必须为 null
@NotNull被注释的元素必须不为 null
@AssertTrue被注释的元素必须为 true
@AssertFalse被注释的元素必须为 false
@Min(value)被注释的元素必须是一个数字，其值必须大于等于指定的最小值
@Max(value)被注释的元素必须是一个数字，其值必须小于等于指定的最大值
@DecimalMin被注释的元素必须是一个数字，其值必须大于等于指定的最小值
@DecimalMax被注释的元素必须是一个数字，其值必须小于等于指定的最大值
@Size(max=, min=)被注释的元素的大小必须在指定的范围内
@Digits被注释的元素必须是一个数字，其值必须在可接受的范围内
@Past被注释的元素必须是一个过去的日期
@Future被注释的元素必须是一个将来的日期
@Pattern(regex=)被注释的元素必须符合指定的正则表达式
异常统一处理
上面介绍了如何让Spring校验我们的参数，那么可以看到JSON方式校验返回的结果一大串，不是十分优雅。那么利用统一异常处理则可优雅返回参数校验结果。
JSON方式：校验失败后，会抛出一个MethodArgumentNotValidException
表单方式：校验失败，会抛出一个ConstraintViolationException
因此只需要在统一异常处理类里面处理这2个异常即可。
ExceptionHanlder
表单方式:
@RestControllerAdvicepublicclassExceptionHandler{@org.springframework.web.bind.annotation.ExceptionHandler(ConstraintViolationException.class)publicMapmethodArgNotValidException(ConstraintViolationException cve, HttpServletRequest httpServletRequest){ Set> cves = cve.getConstraintViolations(); StringBuffer errorMsg =newStringBuffer(); cves.forEach(ex -> errorMsg.append(ex.getMessage())); Map respMap =newHashMap<>(4); respMap.put("code", -1); respMap.put("msg", errorMsg);returnrespMap; }}复制代码
重新调用:
JSON方式:
@RestControllerAdvicepublicclassExceptionHandler{@org.springframework.web.bind.annotation.ExceptionHandler({MethodArgumentNotValidException.class})publicMapmethodDtoNotValidException(Exception ex, HttpServletRequest request){ MethodArgumentNotValidException c = (MethodArgumentNotValidException) ex; List errors = c.getBindingResult().getAllErrors(); StringBuffer errorMsg =newStringBuffer(); errors.stream().forEach(x -> { errorMsg.append(x.getDefaultMessage()).append(";"); }); Map respMap =newHashMap<>(4); respMap.put("code", -1); respMap.put("msg", errorMsg);returnrespMap; }}复制代码
同样调用，这次username为空试试看:
完整代码https://github.com/jounghu/Spring-boot-args-valid
在此我向大家推荐一个架构学习交流群。交流学习群号：938837867 暗号：555 里面会分享一些资深架构师录制的视频录像：有Spring，MyBatis，Netty源码分析，高并发、高性能、分布式、微服务架构的原理，JVM性能优化、分布式架构等这些成为架构师必备