使用@Validated注解异常信息的处理方式
目录
- 使用@Validated注解异常信息的处理
- 解决方案
- 拓展
- 总结
使用@Validated注解异常信息的处理
我在使用spring提供的注解@Validated进行参数校验时,发现默认的异常有点过于杂乱,本文就对这个问题优化一下。
首先是接收参数的dto
- StoreItemInfoDto .Java
@Data @AllArgsConstructor @NoArgsConstructor public class StoreItemInfoDto { @Field(name = "二维码中心-批次id") @NotNull(message = "centerRecordId为空,请检查") private Integer centerRecordId; } //接收请求的方法 MultiResponse<CodeInfoItemVo> queryCodeInfos(@Validated @RequestBody(required = true) StoreItemInfoDto storeItemInfoDto);
请求参数校验失败
我发现返回的信息过于杂乱且长,其实只需要最后“[ ]”里面的信息,今天就来对这个异常优化一下。
解决方案
写一个spring的统一异常处理,使用@ExceptionHandler注解标注,通过字符串截取“[ ]”里面的信息就可以
这样返回的错误信息就简洁明了
今天又发现了一个更为简洁的写法,这里用到MethodArgumentNotValidException异常类,查看其源码,它对exception抛出的异常先进行了android处理,而且它将校验信息封装到了BipythonndingResult对象里面,我们可以直接根据getFieldErrors()方法拿到校验不通过的信息;
- MethodArgumentNotValidException.java
public class MethodArgumentNotValidException extends Exception { private final MethodParameter parameter; private final BindingResult bindingResult; public MethodArgumentNotValidExcept编程客栈ion(MethodParameter parameter, BindingResult bindingResult) { this.parameter = parameter; this.bindingResult = bindingResult; } public MethodParameter getParameter() { return this.parameter; } public BindingResult getBindingResult() { return this.bindingResult; } //这里对异常进行了封装 public String getMessage() { StringBuilder sb = (new StringBuilder("Validation failed for argument [")).append(this.parameter.getParameterIndex()).append("] in ").append(this.parameter.getExecutable().toGenericString()); if (this.bindingResult.getErrorCount() > 1) { sb.append(" with ").append(this.bindingResult.getErrorCount()).append(" errors"); } sb.append(": "); Iterator var2 = this.bindingResult.getAllErrors().iterator(); while(var2.hasNext()) { ObjectError error = (ObjectError)var2.next(); sb.append("[").append(error).append("] "); } return sb.toString(); } }
基于MethodArgumentNotValidException这个类我们可以把方法改写为如下:
@ExceptionHandler(MethodArgumentNotValidException.class) public SingleResponse<?> handlerException(MethodArgumentNotValidException e) { BindingResult bindingResult = e.getBindingResult(); String errorMsg = bindingResult.getFieldErrors().stream().map(o -> o.getDefaultMessage()).collect(编程Collectors.joining(",")); return SingleResponse.buildFailure(ResultCodeEnum.CONSTRAINT_VIOLATION_ERROR.getCode(), errorMsg); }
拓展
@RestControllerAdvice是一个组合注解,由@ControllerAdvice、@ResponseBody组成,而@ControllerAdvice继承了@Component,因此@RestContjavascriptrollerAdvice本质上是个Component,用于定义@ExceptionHandler,@InitBinder和@ModelAttribute方法,适用于所有使用@RequestMapping方法。
@RestControllerAdvice的特点:
- 1.通过@ControllerAdvice注解可以将对于控制器的全局配置放在同一个位置。
- 2.注解了@RestControllerAdvice的类的方法可以使用@ExceptionHandler、@InitBinder、@ModelAttribute注解到方法上。
- 3.@RestControllerAdvice注解将作用在所有注解了@RequestMapping的控制器的方法上。
- 4.@ExceptionHandler:用于指定异常处理方法。当与@RestControllerAdvice配合使用时,用于全局处理控制器里的异常。
- 5.@InitBinder:用来设置WebDataBinder,用于自动绑定前台请求参数到Model中。
- 6.@ModelAttribute:本来作用是绑定键值对到Model中,当与@ControllerAdvice配合使用时,可以让全局的@RequestMapping都能获得在此处设置的键值对
总结
以上为个人经验,希望能给大家一个参考,也希望大家多多支持编程客栈(www.devze.com)。
精彩评论