SpringBoot参数校验之@Valid与@Validated的用法与场景

 更新时间:2025年02月03日 09:47:33   作者:漫天转悠  
这篇文章主要介绍了SpringBoot参数校验的用法与场景,在实际开发中,参数校验是保证接口安全性和数据完整性的重要手段,Spring Boot提供了@Valid和@Validated两个核心注解来实现参数校验,但许多开发者对它们的区别和使用场景存在疑惑,需要的朋友可以参考下

在实际开发中,参数校验是保证接口安全性和数据完整性的重要手段。Spring Boot提供了@Valid@Validated两个核心注解来实现参数校验,但许多开发者对它们的区别和使用场景存在疑惑。本文将深入解析二者的差异,并通过代码示例演示其具体应用场景。

一、核心注解对比

特性@Valid@Validated
标准来源JSR-303/JSR-349规范(Java标准)Spring框架扩展
作用范围方法参数、字段、嵌套对象类、方法、参数
分组校验不支持支持
嵌套验证需配合@Valid递归触发需配合@Valid递归触发
使用场景简单参数校验复杂校验(分组、方法参数校验)

二、@Valid的用法与场景

1. 基本使用

@Valid主要用于方法参数校验,尤其在Controller层对DTO对象进行验证。需配合JSR-303注解(如@NotNull@Size)使用。

示例代码:

@PostMapping("/users")
public ResponseEntity<?> createUser(@RequestBody @Valid UserDTO userDTO) {
    // 业务逻辑
    return ResponseEntity.ok().build();
}
public class UserDTO {
    @NotBlank(message = "用户名不能为空")
    private String username;
    @Size(min = 6, max = 20, message = "密码长度需在6-20位")
    private String password;
}

2. 嵌套验证

若DTO中包含其他对象字段,需在字段上添加@Valid触发递归校验。

public class OrderDTO {
    @Valid  // 触发嵌套校验
    private UserDTO user;
    @NotNull(message = "订单金额不能为空")
    private BigDecimal amount;
}

三、@Validated的进阶特性

1. 分组校验

场景说明:不同业务场景下,同一对象可能需要不同的校验规则。例如,用户注册时需要验证邮箱,而更新信息时不需要。

实现步骤:

定义分组接口:

public interface CreateGroup {}  // 创建分组
public interface UpdateGroup {}  // 更新分组

在DTO中指定分组:

public class UserDTO {
    @NotBlank(groups = CreateGroup.class, message = "邮箱不能为空")
    private String email;
    @NotBlank(message = "用户名不能为空")
    private String username;
}

在Controller中使用@Validated激活分组:

@PostMapping("/users")
public ResponseEntity<?> createUser(
    @RequestBody @Validated(CreateGroup.class) UserDTO userDTO) {
    // 仅校验CreateGroup分组的规则
    return ResponseEntity.ok().build();
}

2. 方法参数校验

@Validated可用于Service层的方法参数校验,需在类上添加@Validated注解。

@Service
@Validated  // 启用方法参数校验
public class UserService {
    public void updateUser(@NotBlank String username, @Min(1) Long userId) {
        // 业务逻辑
    }
}

四、嵌套验证与分组校验结合

复杂场景:在分组校验中触发嵌套对象的验证。

public class OrderDTO {
    @Validated(CreateGroup.class)  // 指定分组
    @Valid
    private UserDTO user;
    @NotNull(message = "金额必填")
    private BigDecimal amount;
}
// Controller层
@PostMapping("/orders")
public ResponseEntity<?> createOrder(
    @RequestBody @Validated(CreateGroup.class) OrderDTO orderDTO) {
    // 同时校验OrderDTO和UserDTO中CreateGroup分组的规则
    return ResponseEntity.ok().build();
}

五、常见问题与注意事项

1. 异常处理

校验失败会抛出以下异常:

  • MethodArgumentNotValidException(@Valid触发)
  • ConstraintViolationException(@Validated触发)

统一异常处理示例:

@RestControllerAdvice
public class GlobalExceptionHandler {
    @ExceptionHandler(MethodArgumentNotValidException.class)
    public ResponseEntity<?> 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);
    }
}

2. 依赖问题

确保项目中引入spring-boot-starter-validation

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

3. 注意事项

  • Spring版本兼容性:低版本Spring需手动启用@EnableWebMvc@Validated支持。
  • 分组接口设计:分组接口建议定义为空接口,仅作为标识。

六、总结与最佳实践

场景推荐注解
Controller层DTO参数校验@Valid
分组校验@Validated + 分组接口
Service层方法参数校验@Validated(类级别)
嵌套对象递归校验@Valid + @Validated组合

最佳实践:

  • Controller层:优先使用@Valid进行简单校验。
  • 复杂业务校验:使用@Validated的分组功能。
  • Service层参数校验:在类上添加@Validated,配合JSR-303注解。

以上就是SpringBoot中@Valid与@Validated的用法与场景的详细内容,更多关于SpringBoot中@Valid与@Validated的资料请关注脚本之家其它相关文章!

相关文章

  • 深入浅出理解Java Lambda表达式之四大核心函数式的用法与范例

    深入浅出理解Java Lambda表达式之四大核心函数式的用法与范例

    Lambda 表达式,也可称为闭包,它是推动 Java 8 发布的最重要新特性。Lambda 允许把函数作为一个方法的参数(函数作为参数传递进方法中)。使用 Lambda 表达式可以使代码变的更加简洁紧凑,今天小编带你理解Lambda表达式之四大核心函数式的用法,感兴趣的朋友快来看看吧
    2021-11-11
  • Java行为型设计模式之模板方法详解

    Java行为型设计模式之模板方法详解

    模板方法的概念:定义了一个操作中的算法的骨架,而将部分步骤的实现在子类中完成。模板方法模式使得子类可以不改变一个算法的结构即可重定义该算法的某些特定步骤
    2022-09-09
  • Java多线程工具篇BlockingQueue的详解

    Java多线程工具篇BlockingQueue的详解

    今天小编就为大家分享一篇关于Java多线程工具篇BlockingQueue的详解,小编觉得内容挺不错的,现在分享给大家,具有很好的参考价值,需要的朋友一起跟随小编来看看吧
    2019-03-03
  • springboot返回modelandview页面的实例

    springboot返回modelandview页面的实例

    这篇文章主要介绍了springboot返回modelandview页面的实例,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2020-10-10
  • Mybatis查询时数据丢失的问题及解决

    Mybatis查询时数据丢失的问题及解决

    Mybatis查询时数据丢失的问题及解决方案,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-01-01
  • 图文详解Java中class的初始化顺序

    图文详解Java中class的初始化顺序

    网上有很多关于Java中class的初始化顺序文章,但是本文通过图文更加详细的介绍了Java中class的初始化顺序,并对class的装载顺序进行了讲解,下面一起来看看。
    2016-08-08
  • 基于Java Callable接口实现线程代码实例

    基于Java Callable接口实现线程代码实例

    这篇文章主要介绍了基于Java Callable接口实现线程代码实例,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-08-08
  • Spring Aop+Redis实现优雅记录接口调用情况

    Spring Aop+Redis实现优雅记录接口调用情况

    通常情况下,开发完一个接口,无论是在测试阶段还是生产上线,我们都需要对接口的执行情况做一个监控,所以本文为大家整理了Spring统计接口调用的多种方法,希望对大家有所帮助
    2023-06-06
  • 详解Spring Boot中PATCH上传文件的问题

    详解Spring Boot中PATCH上传文件的问题

    这篇文章主要介绍了详解Spring Boot中PATCH上传文件的问题,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2018-12-12
  • Java 并发编程中的锁机制示例详解

    Java 并发编程中的锁机制示例详解

    本文探讨了Java并发编程中的锁机制,包括锁的基本概念、Java中的锁类型如synchronized、ReentrantLock、ReadWriteLock、锁的优化策略以及如何避免死锁,文章强调了合理选择和优化锁使用对于提升程序并发性能的重要性,并提供了实际应用中的最佳实践,感兴趣的朋友一起看看吧
    2025-01-01

最新评论