Spring Boot中@Valid和@Validated的区别,你明白了吗?

2024年 2月 4日 88.8k 0

在Spring Boot中,@Valid和@Validated是常用的注解,用于参数校验和验证。尽管它们都用于验证参数,但在嵌套校验方面,它们存在着一些关键的区别。本文将详细介绍@Valid和@Validated之间的三个区别,并重点讲述嵌套校验的区别,包括相应的代码和解析。

1. 校验级别

@Valid是Java标准的Bean Validation API的一部分,它提供了一种在方法参数、字段和方法级别上进行校验的方式。它支持JSR-303和JSR-349规范,并且可以与Spring的Validator接口一起使用。

@Validated是Spring框架提供的注解,它是对@Valid的扩展。它提供了更多的校验级别,包括方法参数和方法返回值的校验。

2. 校验目标

@Valid主要用于验证JavaBean对象的属性。它可以用于验证请求参数、表单对象或任何带有验证注解的JavaBean。

@Validated主要用于验证方法参数和方法返回值。它可以用于验证控制器的请求参数、服务方法的输入参数和返回值。

3. 嵌套校验

嵌套校验是指对复合对象中的属性进行校验,即验证对象中的对象。在嵌套校验中,@Valid和@Validated也存在一些区别。

@Valid的嵌套校验

使用@Valid进行嵌套校验时,被校验的对象的属性上需要加上@Valid注解。这样,在校验时会递归地进行嵌套校验。

下面是一个使用@Valid进行嵌套校验的示例:

public class Address {
   @NotBlank(message = "街道不能为空")
   private String street;
   // 其他属性省略
}

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

   @Valid
   private Address address;
   // 其他属性省略
}

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

在上面的示例中,当请求参数中的User对象被传递到createUser方法时,address属性上的@Valid注解会触发嵌套校验,对User对象中的Address对象的属性进行校验。

@Validated的嵌套校验

与@Valid不同,@Validated不支持嵌套校验。如果在使用@Validated注解时出现嵌套校验,需要使用@Valid注解替代。

下面是一个使用@Validated进行嵌套校验的示例:

public class Address {
   @NotBlank(message = "街道不能为空")
   private String street;
   // 其他属性省略
}

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

   @Valid
   private Address address;
   // 其他属性省略
}

@Service
@Validated
public class UserService {
   public void createUser(@Valid User user) {
       // 处理创建用户的逻辑
  }
}

在上面的示例中,UserService类中的createUser方法使用了@Validated注解,但是由于@Validated不支持嵌套校验,所以在User对象上仍然需要使用@Valid注解来触发嵌套校验。

总结

总的来说,@Valid和@Validated是Spring Boot中常用的参数校验注解。它们之间的三个主要区别是:

  • 校验级别:@Valid支持JSR-303和JSR-349规范,适用于Bean Validation API;@Validated是Spring框架提供的扩展,支持更多的校验级别。
  • 校验目标:@Valid主要用于验证JavaBean对象的属性;@Validated主要用于验证方法参数和方法返回值。
  • 嵌套校验:@Valid支持嵌套校验,可以递归地对复合对象中的属性进行校验;@Validated不支持嵌套校验,需要使用@Valid注解来触发嵌套校验。
  • 根据具体的需求,选择合适的注解来进行参数校验是非常重要的。通过了解@Valid和@Validated之间的区别,特别是在嵌套校验方面的区别,您可以更好地掌握它们的使用方式,并在Spring Boot应用程序中提供更准确、可靠的参数校验功能。

    相关文章

    JavaScript2024新功能:Object.groupBy、正则表达式v标志
    PHP trim 函数对多字节字符的使用和限制
    新函数 json_validate() 、randomizer 类扩展…20 个PHP 8.3 新特性全面解析
    使用HTMX为WordPress增效:如何在不使用复杂框架的情况下增强平台功能
    为React 19做准备:WordPress 6.6用户指南
    如何删除WordPress中的所有评论

    发布评论