之前两篇文章 Spring-boot自界说参数校验注解和若何在spring-boot中举行参数校验,我们先容了,参数校验以及若何自界说参数校验注解,然则当通报参数失足时,只是把错误信息打印到了控制台,合理的做法是应该把校验的错误信息返回给前端,见告用户那里有问题,下面就这一步内容举行说明。

请求body参数

上篇文章 Spring-boot自界说参数校验注解的最后,在控制台打印了校验失足的信息

失足的异常类是MethodArgumentNotValidException,那若是想要自界说异常的返回,就需要在全局的异常处置器中针对这种异常举行处置。

在这篇文章 spring-boot自界说异常返回中,我们说了若何举行自界说异常的返回,参数校验的错误信息返回依然根据此方式举行处置,在全局异常处置类中界说异常处置方式:

@ExceptionHandler(value = MethodArgumentNotValidException.class)
@ResponseStatus(HttpStatus.BAD_REQUEST)
@ResponseBody
public UnifyResponse handlerBeanValidationException(HttpServletRequest request,
                                                    MethodArgumentNotValidException ex) {
    String requestUri = request.getRequestURI();
    String method = request.getMethod();

    List<ObjectError> errors = ex.getBindingResult().getAllErrors();
    return UnifyResponse.builder()
            .code(5000)
            .message(formatError(errors))
            .requestUri(method + " " + requestUri)
            .build();
}

private String formatError(List<ObjectError> errors) {
    StringBuilder builder = new StringBuilder();
    errors.forEach(error -> builder.append(error.getDefaultMessage()).append(";"));
    return builder.toString();
}

我们来对上面的代码举行一下注释:

  • 由于这个处置方式只是针对MethodArgumentNotValidException这个异常举行处置,以是@ExceptionHandler(value = MethodArgumentNotValidException.class)这里指定
  • @ResponseStatus(HttpStatus.BAD_REQUEST),所有的参数校验错误都是一类的,状态码设置为HttpStatus.BAD_REQUEST,也就是code即是400,固然也可以界说为其他的,根据自己营业需求界说就好,可以参考这篇文章 spring-boot自界说异常返回里关于自界说状态码的部门。
  • @ResponseBody,由于这个异常处置方式要返回自界说的工具,以是要使用这个注解,否则spring-boot是不会对自界说工具举行序列化的
  • List<ObjectError> errors = ex.getBindingResult().getAllErrors()举行参数校验的时刻,可能多个参数都有问题,我们希望能够有问题的参数的错误信息全部都返回回去,以是这里要获取所有的错误。

回首一下参数的界说,对这里有疑惑的同砚可以看一下这篇文章Spring-boot自界说参数校验注解

@Builder
@Getter
@Setter
@PasswordEqual(min = 5, message = "密码和确认密码不一样")
public class UserDto {

    private int userId;

    @Length(min = 2, max = 10, message = "用户名长度必须在2-10的局限内")
    private String username;

    private String password;

    private String confirmPassword;
}

接下来我们定再界说一个简朴的接口,当传参失足时看异常处置方式能否根据界说的那样返回错误信息

@RequestMapping("/v2/user/create")
public UserDto createUser(@RequestBody @Validated  UserDto userDto){
    return userDto;
}

我们先来组织一个密码和确认密码不一致的情形

可以看到界说的错误信息被返回,而且状态码和自界说的code都是相符设计的,接下来我们再看一下多个参数错误的场景:

上面的场景中,用户名是不相符要求的,密码和确认密码也不一样,以是会发生两条错误信息,将其拼接到一起,返回给前端。

之前讨论的都是body里提交的参数,接下来我们看下路径参数或者查询参数校验失足时的处置

查询参数和路径参数

我们先界说两个接口一个是路径参数查询信息,一个是通过查询参数查询信息

@GetMapping("/v2/user/info")
public UserDto getUserInfo(@RequestParam @Length(min = 2, max = 5, message = "用户名长度必须在2-5的局限")
                                       String username){
    return UserDto.builder()
            .userId(1000)
            .username(username)
            .build();
}

@GetMapping("/v2/user/{username}")
public UserDto getUserInfoV2(@PathVariable @Length(min = 2, max = 5, message = "用户名长度必须在2-5的局限") String username){
    return UserDto.builder()
            .userId(2000)
            .username(username)
            .build();
}

然后我们访问这两接口,当发生错误时,看看他们会不会进入上文界说的异常处置方式中:

很明显,并没有进入上文界说的异常处置方式中,而是进入了handleException这个异常方式当中,这个算是个兜底的异常处置方式。

看一下控制台的输出:

这里抛出了ConstraintViolationException异常,这个异常我们并没有定制对应的异常处置函数,下面我们就来写一下:

@ExceptionHandler(ConstraintViolationException.class)
@ResponseStatus(HttpStatus.BAD_REQUEST)
@ResponseBody
public UnifyResponse handlerConstraintViolationException(HttpServletRequest request, ConstraintViolationException ex){
    String requestUri = request.getRequestURI();
    String method = request.getMethod();

    Set<ConstraintViolation<?>> errors = ex.getConstraintViolations();
    return UnifyResponse.builder()
            .code(6000)
            .message(formatConstraintException(errors))
            .requestUri(method + " " + requestUri)
            .build();
}

private String formatConstraintException(Set<ConstraintViolation<?>> constraintViolations){
    StringBuilder builder = new StringBuilder();
    constraintViolations.forEach(constraintViolation -> builder.append(constraintViolation.getMessage()));
    return builder.toString();
}

整体来说异常处置和上文几乎是一样的,只是获取错误message的方式不一样而已,我们再请求一下:

至此参数校验的错误message自界说返回,都完成了。

本文链接:https://www.immortalp.com/articles/2020/05/16/1589623786527.html
迎接人人去 我的博客 瞅瞅,内里有更多关于测试实战的内容哦!!

,

sunbet

www.0379st.com信誉来自于每一位客户的口碑,Sunbet贴心的服务,让你尊享贵宾通道,秒速提现,秒速到账,同行业中体验最佳。

Allbet Gaming声明:该文看法仅代表作者自己,与阳光在线无关。转载请注明:济宁房产信息网:测试开发专题:spring-boot自定义返回参数校验错误信息
发布评论

分享到:

《欧博》allbet网址:《坚如磐石》‘讲什么’ 张艺谋版犯罪警匪影戏挑战“亘古未有”
1 条回复
  1. 约搏牛牛
    约搏牛牛
    (2020-06-09 00:05:25) 1#

    欧博注册网址www.cx11yx.cn欢迎进入欧博网址(Allbet Gaming),欧博网址开放会员注册、代理开户、电脑客户端下载、苹果安卓下载等业务。这么精彩没人?

发表评论

◎欢迎参与讨论,请在这里发表您的看法、交流您的观点。