SpringBoot参数校验:@Valid与@Validated使用详解

 更新时间:2025年03月13日 11:11:05   作者:L_!!!  
这篇文章主要介绍了SpringBoot参数校验:@Valid与@Validated使用详解,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教

一、案例(参数校验的必要性)

传统方式(无注解)的缺点:

// 需要手动校验每个字段,代码冗余且易出错
public String register(User user) {
    // 手动校验每个字段
    if (user.getEmail() == null || !isValidEmail(user.getEmail())) {
        throw new IllegalArgumentException("邮箱格式错误");
    }
    if (user.getPassword().length() < 8) {
        throw new IllegalArgumentException("密码长度需≥8位");
    }
    // 校验逻辑与业务代码耦合,难以复用
}

问题总结

  • 代码冗余:相同校验逻辑重复编写
  • 维护困难:校验规则分散,修改成本高
  • 可读性差:业务逻辑被大量if-else淹没

注解方式的优势

public class User {
    @Email(message = "邮箱格式不合法")  // 一行注解替代复杂校验
    private String email;
    
    @Size(min = 8, message = "密码长度需≥8位")
    private String password;
}

@PostMapping("/register")
public String register(@Valid @RequestBody User user) { 
    // 校验逻辑由框架自动处理
    return "success";
}

核心优势

  • 声明式校验:通过注解自动完成参数验证
  • 代码简洁:减少冗余的if-else判断
  • 统一规范:标准化校验规则,降低维护成本

二、@Valid 注解

简介

  • Java标准注解(javax.validation)
  • 用于触发 Bean Validation 校验机制
  • 可校验方法参数成员属性

SpringBoot配置

<!-- pom.xml 必须依赖 -->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-validation</artifactId>
</dependency>

使用示例

public class User {
    @NotNull(message = "用户名不能为空")
    private String name;
    
    @Min(value = 18, message = "年龄必须≥18岁")
    private Integer age;
}

@PostMapping("/users")
public String createUser(@Valid @RequestBody User user) { // 触发校验
    return "success";
}

全局异常处理(核心实践)

@RestControllerAdvice
public class GlobalExceptionHandler {
    
    // 处理@Valid/@Validated抛出的校验异常
    @ExceptionHandler(MethodArgumentNotValidException.class)
    public ResponseEntity<Map<String, String>> handleValidationException(MethodArgumentNotValidException ex) {
        Map<String, String> errors = new HashMap<>();
        ex.getBindingResult().getFieldErrors().forEach(error -> 
            errors.put(error.getField(), error.getDefaultMessage()));
        return ResponseEntity.badRequest().body(errors);
    }
}

效果:自动返回结构化错误信息(字段名+错误描述)

三、@Validated 注解

简介

  • Spring框架注解(org.springframework.validation.annotation)(@Validated是Spring框架提供的,导入springboot的依赖就会自动导入这个依赖)
  • 支持分组校验(Group Validation)
  • 可标注在类、方法、参数

核心功能

// 分组接口定义
public interface CreateGroup {} 
public interface UpdateGroup {}

public class User {
    @NotBlank(groups = CreateGroup.class)
    private String name;
    
    @NotNull(groups = {CreateGroup.class, UpdateGroup.class})
    private Integer age;
}

// 使用分组校验
@PostMapping("/users")
public String createUser(@Validated(CreateGroup.class) @RequestBody User user) {
    return "success";
}

四、常用校验注解

最常用的注解:

注解说明示例
@NotNull值不能为null@NotNull(message="字段必填")
@NotBlank字符串非空(trim后)适用于用户名、密码等
@Min/@Max数值范围限制@Min(18)
@Pattern正则表达式校验@Pattern(regexp="^1[3-9]\\d{9}$")
@Valid嵌套对象校验用于对象内的子对象属性

比较常用的注解:

注解适用类型说明示例
@FutureDate日期必须在未来@Future(message="截止时间无效")
@Digits数值类型整数位和小数位限制@Digits(integer=3, fraction=2)
@Negative数值类型必须为负数常用于财务系统
@NotEmpty集合/字符串集合非空或字符串长度>0比@NotBlank更宽松

组合注解(自定义)

// 自定义手机号校验注解
@Documented
@Constraint(validatedBy = PhoneValidator.class)
@Target({FIELD, PARAMETER})
@Retention(RUNTIME)
public @interface Phone {
    String message() default "手机号格式不合法";
    Class<?>[] groups() default {};
    Class<? extends Payload>[] payload() default {};
}

// 校验逻辑实现
public class PhoneValidator implements ConstraintValidator<Phone, String> {
    private static final Pattern PHONE_PATTERN = Pattern.compile("^1[3-9]\\d{9}$");
    
    @Override
    public boolean isValid(String value, ConstraintValidatorContext context) {
        return value != null && PHONE_PATTERN.matcher(value).matches();
    }
}

使用场景:复用企业特定校验规则(如公司内部员工编号)

五、@Valid 与 @Validated 区别

特性@Valid@Validated
标准规范JSR-303/JSR-349 标准Spring 框架扩展
分组校验不支持支持
嵌套校验需要显式添加@Valid不自动支持嵌套校验
作用位置方法参数、成员属性类、方法、参数

六、高频问题与最佳实践

常见问题排查

注解不生效

  • 检查是否忘记添加@Valid/@Validated
  • 确保校验对象未被@RequestBody等注解错误包裹

嵌套校验失败

  • 确认在嵌套对象属性上添加了@Valid

性能优化建议

  • 避免过度校验:在Controller层做基础校验,复杂逻辑放到Service层
  • 使用分组校验:减少不必要的校验开销

高级技巧

// 动态分组校验(根据请求参数决定校验组)
@Validated
@RestController
public class UserController {
    
    @PostMapping("/users")
    public String createUser(
        @RequestParam String type,
        @Validated({Default.class, type.equals("vip") ? VipGroup.class : Default.class}) 
        @RequestBody User user
    ) {
        return "success";
    }
}

实现原理:利用Spring EL表达式动态选择校验组

七、重点总结

优先使用场景

  • 优先使用@Valid的场景:嵌套对象校验、与非Spring框架整合
  • 优先使用@Validated的场景:需要分组校验、校验Service层方法参数

配置要点

  • 要想使用@Valid必须添加spring-boot-starter-validation依赖
  • 校验失败会抛出MethodArgumentNotValidException

最佳实践

// 嵌套校验示例
public class Order {
    @Valid  // 必须显式添加
    private User user;
}

// 分组校验示例
@Validated(UpdateGroup.class)
public void updateUser(@RequestBody User user) {}

校验流程

请求参数 → 注解声明 → 自动校验 → 异常处理(@ControllerAdvice)

相较传统参数校验优势

  • 减少70%以上的参数校验代码量
  • 通过统一异常处理实现错误响应的标准化
  • 提升代码可维护性和团队协作效率

总结

以上为个人经验,希望能给大家一个参考,也希望大家多多支持脚本之家。

相关文章

  • vue vxe-table 实现财务记账凭证的方案

    vue vxe-table 实现财务记账凭证的方案

    使用 vxe-table 实现财务记账凭证非常简单,实现在线实时编辑的记账凭证、自动合计金额等,这篇文章主要介绍了vue vxe-table 实现财务记账凭证的方案,需要的朋友可以参考下
    2024-12-12
  • Java基础-Java常量和常量值

    Java基础-Java常量和常量值

    这篇文章主要介绍了Java基础-Java常量和常量值,在程序中存在大量的数据来代表程序的状态,其中有些数据在程序运行过程中值不能发生改变,这些数据在程序中被叫做常量,下面文章对Java常量和常量值的详细内容,需要的小伙伴可以参考一下
    2022-01-01
  • 利用Java异常机制实现模拟借书系统

    利用Java异常机制实现模拟借书系统

    这篇文章主要给大家介绍了利用Java异常机制实现模拟借书系统的相关资料,文中先对java异常机制进行了简单介绍,而后通过示例代码介绍了java语言是如何实现一个控制台版的模拟借书系统,需要的朋友可以参考学习,一起来看看吧。
    2017-04-04
  • Java创建对象的六种常用方式总结

    Java创建对象的六种常用方式总结

    作为Java开发者,经常创建很多对象,你是否知道Java中创建对象有哪些方式呢?下面这篇文章主要给大家介绍了关于Java创建对象的六种常用方式,文中通过代码介绍的非常详细,需要的朋友可以参考下
    2024-06-06
  • 一文详解Java如何创建和销毁对象

    一文详解Java如何创建和销毁对象

    Java由Sun Microsystems发明并在1995年发布,是世界上使用最广泛的编程语言之一。本文主要和大家介绍一下Java是如何创建和销毁对象的,希望对大家有所帮助
    2022-11-11
  • java获取中文拼音首字母的实例

    java获取中文拼音首字母的实例

    下面小编就为大家带来一篇java获取中文拼音首字母的实例。小编觉得挺不错的,现在就分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2017-09-09
  • springboot整合quartz实例demo

    springboot整合quartz实例demo

    Quartz是一个开源的任务调度框架。基于定时、定期的策略来执行任务是它的核心功能,比如x年x月的每个星期五上午8点到9点,每隔10分钟执行1次,本文重点给大家介绍springboot整合quartz的实例代码,感兴趣的朋友一起看看吧
    2022-02-02
  • java ThreadLocal使用案例详解

    java ThreadLocal使用案例详解

    这篇文章主要为大家详细介绍了java ThreadLocal的使用案例,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2018-03-03
  • Spring boot中Jackson的操作指南

    Spring boot中Jackson的操作指南

    这篇文章主要给大家介绍了关于Spring boot中Jackson操作的相关资料,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2018-11-11
  • Java关键字finally_动力节点Java学院整理

    Java关键字finally_动力节点Java学院整理

    java关键字finally不管是否出现异常,finally子句总是在块完成之前执行。下面通过实现代码给大家介绍Java关键字finally相关知识,需要的的朋友参考下吧
    2017-04-04

最新评论