【Spring Boot】如何进行级联校验多层级的参数对象

发布日期: 2025-02-25

更新日期: 2025-02-26

文章字数: 832

阅读时长: 3 分

阅读次数:

问题背景

在开发 RESTful API 时，常常需要处理复杂的请求体，其中可能包含多层级的参数对象。为了确保数据的有效性和安全性，Spring Boot 提供了级联校验的功能，可以对嵌套对象进行校验。本文将介绍如何在 Spring Boot 中实现级联校验多层级的参数对象。

依赖配置

确保在 pom.xml 中添加了 spring-boot-starter-validation 依赖（如果之前已经添加过，可以跳过这一步）：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-validation</artifactId>
</dependency>

级联校验示例

1. 定义嵌套对象

首先，我们定义一个嵌套对象，例如 Address 和 User 类：

import javax.validation.constraints.NotBlank;

public class Address {
    
    @NotBlank(message = "地址不能为空")
    private String street;

    @NotBlank(message = "城市不能为空")
    private String city;

    // getters and setters
}

import javax.validation.Valid;
import javax.validation.constraints.Email;
import javax.validation.constraints.NotBlank;

public class User {
    
    @NotBlank(message = "用户名不能为空")
    private String username;

    @Email(message = "邮箱格式不正确")
    private String email;

    @Valid // 级联校验
    private Address address;

    // getters and setters
}

2. 控制器示例

在控制器中，我们可以使用 @Valid 注解来对 User 对象进行校验，Spring 会自动校验嵌套的 Address 对象：

import org.springframework.http.ResponseEntity;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.*;

@RestController
@RequestMapping("/api/users")
public class UserController {

    @PostMapping
    public ResponseEntity<String> createUser(@Valid @RequestBody User user) {
        // 处理用户创建逻辑
        return ResponseEntity.ok("用户创建成功");
    }
}

3. 全局异常处理

为了处理校验失败时的异常，我们可以使用全局异常处理器，和之前的参数校验示例相同：

import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.MethodArgumentNotValidException;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;

import java.util.HashMap;
import java.util.Map;

@ControllerAdvice
public class GlobalExceptionHandler {

    @ExceptionHandler(MethodArgumentNotValidException.class)
    public ResponseEntity<Map<String, String>> handleValidationExceptions(MethodArgumentNotValidException ex) {
        Map<String, String> errors = new HashMap<>();
        ex.getBindingResult().getFieldErrors().forEach(error -> 
            errors.put(error.getField(), error.getDefaultMessage())
        );
        return new ResponseEntity<>(errors, HttpStatus.BAD_REQUEST);
    }
}