使用@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开发之内部类对象的创建及hook机制分析

    Java开发之内部类对象的创建及hook机制分析

    这篇文章主要介绍了Java开发之内部类对象的创建及hook机制,结合实例形式分析了java基于hook机制内部类对象的创建与使用,需要的朋友可以参考下
    2018-01-01
  • Java中的JSONObject使用及错误处理详解

    Java中的JSONObject使用及错误处理详解

    这篇文章主要给大家介绍了关于Java中的JSONObject使用及错误处理的相关资料,文中讲解了Java中的JSONObject创建、基本操作、高级特性和错误处理,通过示例代码和方法说明,使读者能够理解和掌握JSONObject的使用技巧,需要的朋友可以参考下
    2024-12-12
  • java打成jar后,获取resources下的文件资源问题及解决

    java打成jar后,获取resources下的文件资源问题及解决

    作者在写代码时遇到一个问题:在将项目打包成jar包后,无法通过常规方式获取resources文件夹下的资源,通过分析原因,作者找到了一种新的解决方案,即通过类加载器获取jar包内的资源,此方式返回后的资源以文件流的形式返回,作者将其转换为了byte[]的形式使用
    2026-05-05
  • Java8 使用流抽取List<T>集合中T的某个属性操作

    Java8 使用流抽取List<T>集合中T的某个属性操作

    这篇文章主要介绍了Java8 使用流抽取List<T>集合中T的某个属性操作,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2021-02-02
  • eclipse如何搭建Springboot项目详解

    eclipse如何搭建Springboot项目详解

    今天带大家学习eclipse如何搭建Spring boot项目,文中有非常详细的图文解说,对正在学习java的小伙伴们有很好地帮助,需要的朋友可以参考下
    2021-05-05
  • 基于springboot i18n国际化后台多种语言设置的方式

    基于springboot i18n国际化后台多种语言设置的方式

    这篇文章主要介绍了基于springboot i18n国际化后台多种语言设置的方式,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-06-06
  • HashMap之keyset()方法底层原理解读

    HashMap之keyset()方法底层原理解读

    这篇文章主要介绍了HashMap之keyset()方法底层原理解读,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2023-03-03
  • 解决IDEA中pom.xml文件变为灰色的问题

    解决IDEA中pom.xml文件变为灰色的问题

    这篇文章主要给大家介绍了如何解决IDEA中pom.xml文件变为灰色的问题,文中通过图文结合给大家介绍的非常详细,对大家的学习或工作有一定的帮助,需要的朋友可以参考下
    2023-12-12
  • Java详细讲解不同版本的接口语法和抽象类与接口的区别

    Java详细讲解不同版本的接口语法和抽象类与接口的区别

    对于面向对象编程来说,抽象是它的一大特征之一,在 Java 中可以通过两种形式来体现OOP的抽象:接口和抽象类,下面这篇文章主要给大家介绍了关于Java入门基础之抽象类与接口的相关资料,需要的朋友可以参考下
    2022-04-04
  • Spark学习笔记之Spark中的RDD的具体使用

    Spark学习笔记之Spark中的RDD的具体使用

    这篇文章主要介绍了Spark学习笔记之Spark中的RDD的具体使用,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2019-06-06

最新评论