使用@Validated注解异常信息的处理方式

 更新时间:2025年07月31日 09:01:03   作者:艾默丝  
本文优化Spring @Validated参数校验异常信息,通过MethodArgumentNotValidException和BindingResult提取关键错误,使用@RestControllerAdvice实现统一异常处理,提升错误信息简洁性及代码可维护性

使用@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抛出的异常先进行了处理,而且它将校验信息封装到了BindingResult对象里面,我们可以直接根据getFieldErrors()方法拿到校验不通过的信息;

  • MethodArgumentNotValidException.java
public class MethodArgumentNotValidException extends Exception {
    private final MethodParameter parameter;
    private final BindingResult bindingResult;

    public MethodArgumentNotValidException(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,因此@RestControllerAdvice本质上是个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都能获得在此处设置的键值对

总结

以上为个人经验,希望能给大家一个参考,也希望大家多多支持脚本之家。

相关文章

  • Java获取Excel中图片所在的行和列坐标位置

    Java获取Excel中图片所在的行和列坐标位置

    这篇文章主要介绍了Java获取Excel中图片所在的行和列坐标位置,文章围绕主题展开详细的内容介绍,具有一定的参考价值,需要的朋友可以参考一下
    2022-08-08
  • jdbc中class.forname的作用

    jdbc中class.forname的作用

    这篇文章主要介绍了jdbc中class.forname的作用,使用示例说明了他作用及使用方法,大家参考使用吧
    2014-01-01
  • Spring技巧之如何动态读取配置文件

    Spring技巧之如何动态读取配置文件

    这篇文章主要介绍了Spring技巧之如何动态读取配置文件的操作,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-09-09
  • JVM GC 垃圾收集梳理总结

    JVM GC 垃圾收集梳理总结

    这篇文章主要介绍了JVM GC 垃圾收集梳理总结,GC是一种自动的存储管理机制。当一些被占用的内存不再需要时,就应该予以释放,这种存储资源管理,称为垃圾回收
    2022-07-07
  • Java实现简单画画画板

    Java实现简单画画画板

    这篇文章主要为大家详细介绍了Java实现简单画画画板,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2022-06-06
  • Java连接MongoDB进行增删改查的操作

    Java连接MongoDB进行增删改查的操作

    这篇文章主要介绍了Java连接MongoDB进行增删改查的操作的相关资料,需要的朋友可以参考下
    2017-05-05
  • 详解Java二叉排序树

    详解Java二叉排序树

    这篇文章主要介绍了Java二叉排序树,包括二叉排序树的定义、二叉排序树的性质、二叉排序树的插入和查找等,感兴趣的小伙伴们可以参考一下
    2015-12-12
  • 在Spring Boot中集成RabbitMQ的实战记录

    在Spring Boot中集成RabbitMQ的实战记录

    本文介绍SpringBoot集成RabbitMQ的步骤,涵盖配置连接、消息发送与接收,并对比两种定义Exchange与队列的方式:手动声明(适合复杂路由)和注解绑定(适合快速开发),感兴趣的朋友跟随小编一起看看吧
    2025-06-06
  • Spring Bean生命周期之Bean的实例化详解

    Spring Bean生命周期之Bean的实例化详解

    这篇文章主要为大家详细介绍了Spring Bean生命周期之Bean的实例化,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下,希望能够给你带来帮助
    2022-03-03
  • Springboot项目启动到一半卡住了,不报错问题及解决

    Springboot项目启动到一半卡住了,不报错问题及解决

    这篇文章主要介绍了Springboot项目启动到一半卡住了,不报错问题及解决方案,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-06-06

最新评论