Spring Boot 如何校验前端传递的参数

Spring Boot 参数校验(基于 Hibernate Validator)

1. 简介与依赖

  • 作用:对 Controller 接收的参数进行合法性校验,提升接口健壮性。
  • 底层实现:Hibernate Validator(Bean Validation 规范的参考实现)。
  • 推荐依赖
xml 复制代码
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-validation</artifactId>
</dependency>

✅ 自动引入 hibernate-validator + javax.validation-api,无需手动管理版本。


2. 使用方式

✅ 校验 @RequestBody(JSON 对象)

  • 在参数前加 @Valid无需 @Validated
java 复制代码
@PostMapping("/user")
public Result createUser(@Valid @RequestBody User user) { ... }

✅ 校验 @RequestParam / @PathVariable

  • 必须 在 Controller 类(或方法)上加 @Validated
java 复制代码
@RestController
@Validated // ← 关键!
public class UserController {
    @GetMapping("/user/{id}")
    public Result getUser(@Min(1) @PathVariable Long id) { ... }
}

最佳实践 :Controller 类统一加 @Validated,覆盖所有校验场景。


3. 常用注解

非空校验

  • @NotNull:验证对象不为null,但允许空字符串或空白字符
  • @NotEmpty:验证字符串/集合/数组非null且长度/大小>0(不检查空白字符)
  • @NotBlank:验证字符串非null且至少包含一个非空白字符

范围校验

  • @Size(min=, max=):限制字符串/集合/数组的长度/大小范围
  • @Min:验证数字最小值(含边界值)
  • @Max:验证数字最大值(含边界值)

格式校验

  • @Email:验证字符串是否符合邮箱格式
  • @Pattern(regexp = "..."):通过正则表达式自定义校验规则

时间校验

  • @Past:验证日期是否在当前时间之前
  • @Future:验证日期是否在当前时间之后

4. 全局异常处理器

统一处理校验失败异常,返回结构化错误信息。有了全局异常处理器,前端可以收到规范化的错误信息

java 复制代码
@RestControllerAdvice
public class GlobalValidationExceptionHandler {

    // 处理 @RequestBody 校验失败
    @ExceptionHandler(MethodArgumentNotValidException.class)
    @ResponseStatus(HttpStatus.BAD_REQUEST)
    public ApiResult<Map<String, String>> handleRequestBody(
            MethodArgumentNotValidException ex) {
        Map<String, String> errors = new HashMap<>();
        ex.getBindingResult().getFieldErrors()
          .forEach(e -> errors.put(e.getField(), e.getDefaultMessage()));
        return ApiResult.error(400, "参数校验失败").data(errors);
    }

    // 处理 @RequestParam / @PathVariable 校验失败
    @ExceptionHandler(ConstraintViolationException.class)
    @ResponseStatus(HttpStatus.BAD_REQUEST)
    public ApiResult<Map<String, String>> handleParams(
            ConstraintViolationException ex) {
        Map<String, String> errors = new HashMap<>();
        ex.getConstraintViolations().forEach(v ->
            errors.put(v.getPropertyPath().toString(), v.getMessage()));
        return ApiResult.error(400, "参数校验失败").data(errors);
    }
}

💡 返回示例:

json 复制代码
{ "code": 400, "message": "参数校验失败", "data": { "name": "姓名不能为空" } }
相关推荐
紫穹几秒前
009.LangChain 手动记忆全流程
后端·ai编程
Promise5205 分钟前
用油猴脚本实现用户身份快速切换
前端·javascript
玲玲5126 分钟前
vue3组件通信:defineEmits和defineModel
前端
勇者无畏4046 分钟前
基于 Spring AI Alibaba 搭建 Text-To-SQL 智能系统(前置介绍)
java·后端·spring·prompt·embedding
温柔532912 分钟前
仓颉语言异常捕获机制深度解析
java·服务器·前端
AronTing16 分钟前
2025阿里P6 Java后端面试全攻略:八大模块深度解析
后端·面试
温宇飞20 分钟前
ECS 系统的一种简单 TS 实现
前端
shenshizhong22 分钟前
鸿蒙HDF框架源码分析
前端·源码·harmonyos
用户685453759776929 分钟前
📈 提升系统吞吐量实战:从1000到10万QPS的飞跃!
后端
ruleslol29 分钟前
SpringBoot15-项目部署
spring boot