【Spring Boot】如何进行 Body、Query、Path Variable 类型的参数校验

发布日期: 2025-02-25

更新日期: 2025-02-26

文章字数: 954

阅读时长: 4 分

阅读次数:

问题背景

在开发 RESTful API 时，参数校验是确保数据有效性和安全性的重要环节。Spring Boot 提供了强大的参数校验功能，可以对请求中的 Body、Query 和 Path Variable 类型的参数进行校验。本文将介绍如何在 Spring Boot 中实现这些参数的校验。

依赖配置

首先，确保在 pom.xml 中添加了 spring-boot-starter-validation 依赖：

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

1. Body 参数校验

对于请求体中的参数校验，我们可以使用 @Valid 注解结合 Java Bean Validation API（如 Hibernate Validator）来实现。

示例代码

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

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

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

    @Size(min = 6, message = "密码长度不能少于6位")
    private String password;

    // getters and setters
}

控制器示例

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 UserDTO userDTO) {
        // 处理用户创建逻辑
        return ResponseEntity.ok("用户创建成功");
    }
}

2. Query 参数校验

对于查询参数的校验，可以直接在控制器方法的参数上使用校验注解。

示例代码

import javax.validation.constraints.Min;
import javax.validation.constraints.NotNull;

@RestController
@RequestMapping("/api/products")
public class ProductController {

    @GetMapping
    public ResponseEntity<List<Product>> getProducts(
            @RequestParam @NotNull(message = "页码不能为空") @Min(value = 1, message = "页码必须大于0") Integer page,
            @RequestParam @NotNull(message = "每页数量不能为空") @Min(value = 1, message = "每页数量必须大于0") Integer size) {
        // 处理获取产品逻辑
        return ResponseEntity.ok(productService.getProducts(page, size));
    }
}

3. Path Variable 校验

对于路径变量的校验，方法与查询参数类似，可以在路径变量上使用校验注解。

示例代码

import javax.validation.constraints.Min;
import javax.validation.constraints.NotNull;

@RestController
@RequestMapping("/api/orders")
public class OrderController {

    @GetMapping("/{id}")
    public ResponseEntity<Order> getOrder(
            @PathVariable @NotNull(message = "订单ID不能为空") @Min(value = 1, message = "订单ID必须大于0") Long id) {
        // 处理获取订单逻辑
        return ResponseEntity.ok(orderService.getOrderById(id));
    }
}

4. 全局异常处理

为了处理校验失败时的异常，我们可以使用全局异常处理器。

示例代码

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);
    }
}