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

目录

• 1. 问题简要描述
• 2. 异常触发
• 1) 参数级别约束
• 2) 类级别约束
• 3. 异常处理
• 1) 字段级别约束
• 2) 类级别约束
• 4. 进一步学习

1. 问题简要描述

这个问题是在测试自定义注解实现数据格式校验时遇到的，当前有两个注解，ValidateParamsMatched和SafeParam。前者的功能是对类中的两个列表的长度进行比较，后者则是对字符串进行校验，判断是否包含特殊字符

但是，当分别触发这两个校验时，都会触发异常并返回请求，但之后后者能返回请求信息。

这里问题本质上是没弄懂对应的异常处理代码，但也值得记录一下。

2. 异常触发

1) 参数级别约束

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

@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，触发MethodArgumentNotValidExcept编程客栈ion

@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(getParameterandroid().getExecutable().toGenericString());
    BindingResult result = getBindingResult();
    if (result.getErrorCount() > 0) {
        sb.append(", with ").append(result.getErhttp://www.devze.comrorCount()).append(" error(s): ");
        for (ObjectError error : result.getAllErrors()) {
 python           sb.append('[').append(error).append("] ");
        }
    }
    return sb.toString();
}

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

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

到此这篇关于SpringBoot 异常处理/自定义格式校验的文章就介绍到这了,更多相关springboot异常处理内容请搜索编程客栈(www.devze.com)以前的文章或继续浏览下面的相关文章希望大家以后多多支持编程客栈(www.devze.com)！