SpringBoot 异常处理/自定义格式校验的问题实例详解

 更新时间:2025年07月23日 14:34:41   作者:Su-RE  
文章探讨Spring Boot中自定义注解校验问题,区分参数级与类级约束触发的异常类型,建议通过@RestControllerAdvice统一处理,并说明如何获取不同错误类型(FieldError/ObjectError)的信息差异,感兴趣的朋友一起看看吧

1. 问题简要描述

这个问题是在测试自定义注解实现数据格式校验时遇到的,当前有两个注解,ValidateParamsMatched和SafeParam。前者的功能是对类中的两个列表的长度进行比较,后者则是对字符串进行校验,判断是否包含特殊字符
但是,当分别触发这两个校验时,都会触发异常并返回请求,但之后后者能返回请求信息。
这里问题本质上是没弄懂对应的异常处理代码,但也值得记录一下。

2. 异常触发

1) 参数级别约束

在 Controller 方法上直接使用参数级约束,并且,Controller 类上有 @Validated 注解时,验证失败会触发 ConstraintViolationException 异常

@Validated // 必需
@RestController
public class ProductController {
    @GetMapping("/products")
    public Product getProduct(@ValidCategory String category) {
        // ...
    }
}

在 DTO 的字段上使用参数级约束,且方法参数前有 @Valid 注解时,验证失败会触发 MethodArgumentNotValidException 异常

@PostMapping("/products")
public ResponseEntity<?> createProduct(
    @Valid @RequestBody ProductRequest request // 触发验证
) {
    // ...
}

2) 类级别约束

在实体类上标注了类级约束,且Controller 方法参数使用了 @Valid,触发MethodArgumentNotValidException

@ValidInventory // 类级别约束
public class Product {
    private int stockQuantity;
    private int minStockLevel;
}
@PostMapping("/products")
public ResponseEntity<?> createProduct(
    @Valid @RequestBody Product product // 触发验证
) {
    // ...
}

注意:类级别约束应该加在需要验证的目标类(实体类/DTO)的类声明上,且在 Controller 方法参数添加 @Valid 和在 Service 方法参数添加 @Valid

3. 异常处理

建议通过 @RestControllerAdvice 设置全局异常处理来对此类异常进行处置。但获取信息时,这两类约束的方法不同。
在 MethodArgumentNotValidException 中,字段级约束产生 FieldError,类级约束产生 ObjectError(也称为全局错误)

1) 字段级别约束

获取方式为 ex.getBindingResult().getFieldErrors(),包含字段名、错误消息、拒绝值。
ex.getMessage() 会返回详细错误信息

@ExceptionHandler(MethodArgumentNotValidException.class)
public ResponseEntity<String> handleValidationException(MethodArgumentNotValidException ex) {
    // 只获取字段错误
    String errorMsg = ex.getBindingResult().getFieldErrors().stream()
            .map(fieldError -> fieldError.getField() + ": " + fieldError.getDefaultMessage())
            .collect(Collectors.joining("; "));
    log.warn("请求值验证异常 | request={}", ex.getMessage());
    return ResponseEntity.status(HttpStatus.BAD_REQUEST).body(errorMsg);
}

2) 类级别约束

获取方式为 ex.getBindingResult().getGlobalErrors(),包含对象名、错误消息。
ex.getMessage() 返回通用消息。

@ExceptionHandler(MethodArgumentNotValidException.class)
public ResponseEntity<String> handleValidationException(MethodArgumentNotValidException ex) {
    // 只获取字段错误
    String errorMsg = ex.getBindingResult().getGlobalErrors().stream()
            .map(DefaultMessageSourceResolvable::getDefaultMessage)
            .collect(Collectors.joining("; "));
    log.warn("请求值验证异常 | request={}", ex.getMessage());
    return ResponseEntity.status(HttpStatus.BAD_REQUEST).body(errorMsg);
}

在类级别约束的异常处理时,ex.getBindingResult().getFieldErrors() 会返回空值;同样的,ex.getBindingResult().getGlobalErrors()也会返回空值
因此,可以统一错误处理格式

@ExceptionHandler(MethodArgumentNotValidException.class)
public ResponseEntity<String> handleValidationException(MethodArgumentNotValidException ex) {
    // 创建错误消息列表
    List<String> errorMessages = new ArrayList<>();
    // 处理字段错误
    ex.getBindingResult().getFieldErrors().forEach(fieldError -> {
        String msg = String.format("%s: %s",
                fieldError.getField(),
                fieldError.getDefaultMessage());
        errorMessages.add(msg);
    });
    // 处理全局错误
    ex.getBindingResult().getGlobalErrors().forEach(globalError -> {
        String msg = String.format("全局错误: %s", globalError.getDefaultMessage());
        errorMessages.add(msg);
    });
    // 合并所有错误消息
    String errorMsg = String.join("; ", errorMessages);
    return ResponseEntity.status(HttpStatus.BAD_REQUEST).body(errorMsg);
}

4. 进一步学习

值得注意的是, ex.getMessage() 给出的结果也是不一样的,这个与代码实现有关

public String getMessage() {
    StringBuilder sb = new StringBuilder("Validation failed for argument at index ")
            .append(getParameter().getParameterIndex()).append(" in method: ")
            .append(getParameter().getExecutable().toGenericString());
    BindingResult result = getBindingResult();
    if (result.getErrorCount() > 0) {
        sb.append(", with ").append(result.getErrorCount()).append(" error(s): ");
        for (ObjectError error : result.getAllErrors()) {
            sb.append('[').append(error).append("] ");
        }
    }
    return sb.toString();
}

当只有类级约束失败时,result.getErrorCount() == 1(只有 ObjectError),因此,ex.getMessage() 输出的内容不同

  1. 另外,在调试的过程中还遇到了一个问题,在类级别约束中,考虑到已经存在非空校验了,因此,在类约束中再重复做校验。但在测试过程中发现,输入属性为空时,会在类约束中报错。后来经过查验,确定问题原因。
    1. 虽然对于 Bean 的校验按照 字段->类 的顺序进行,但校验过程会收集所有违反约束的情况,而不是在遇到第一个约束失败时就停止。也就是说类级别的约束(即放在类上的注解)的校验器,在字段级别约束失败时,仍然会被执行

到此这篇关于SpringBoot 异常处理/自定义格式校验的文章就介绍到这了,更多相关springboot异常处理内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • java高级排序之希尔排序

    java高级排序之希尔排序

    这篇文章主要介绍了java高级排序之希尔排序 ,需要的朋友可以参考下
    2015-04-04
  • Java类加载机制实现流程及原理详解

    Java类加载机制实现流程及原理详解

    这篇文章主要介绍了Java类加载机制实现流程及原理详解,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-06-06
  • java使用POI实现html和word相互转换

    java使用POI实现html和word相互转换

    这篇文章主要为大家详细介绍了java使用POI实现html和word的相互转换,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2018-12-12
  • Java字符串比较方法equals的空指针异常的解决

    Java字符串比较方法equals的空指针异常的解决

    这篇文章主要介绍了Java字符串比较方法equals的空指针异常的解决,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2019-09-09
  • Java nacos动态配置实现流程详解

    Java nacos动态配置实现流程详解

    使用动态配置的原因是properties和yaml是写到项目中的,好多时候有些配置需要修改,每次修改就要重新启动项目,不仅增加了系统的不稳定性,也大大提高了维护成本,非常麻烦,且耗费时间
    2022-09-09
  • javascript最新2020经典面试题

    javascript最新2020经典面试题

    这篇文章主要介绍了javascript最新2020经典面试题的相关内容,有需要的朋友们可以学习下。
    2020-02-02
  • java多线程开发ScheduledExecutorService简化方式

    java多线程开发ScheduledExecutorService简化方式

    这篇文章主要为大家介绍了java多线程开发ScheduledExecutorService的简化方式,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步
    2022-03-03
  • Java常见的数据结构之栈和队列详解

    Java常见的数据结构之栈和队列详解

    这篇文章主要介绍了Java常见的数据结构之栈和队列详解,栈(Stack) 是一种基本的数据结构,具有后进先出(LIFO)的特性,类似于现实生活中的一叠盘子,栈用于存储一组元素,但只允许在栈顶进行插入(入栈)和删除(出栈)操作,需要的朋友可以参考下
    2023-10-10
  • 基于Intellij Idea乱码的解决方法

    基于Intellij Idea乱码的解决方法

    下面小编就为大家分享一篇基于Intellij Idea乱码的解决方法,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2018-03-03
  • springboot后端使用LocalDate接收日期的问题解决

    springboot后端使用LocalDate接收日期的问题解决

    在做Java开发时,肯定会碰到传递时间参数的情况,本文主要介绍了springboot后端使用LocalDate接收日期的问题解决,具有一定的参考价值,感兴趣的可以了解一下
    2023-09-09

最新评论