SpringBoot注解篇之@Validated

---

前言

大家好，我是AK，在做新项目顺便整理SpringBoot相关内容，这里主要介绍下@Validated注解的应用，减少核心业务逻辑中一些参数判断的代码。

---

@Validated作用

@Validated 是 Spring Framework 中的一个注解，用于在方法或类级别上进行参数校验。

它的作用是校验方法参数或类中的字段的有效性，并能够结合 Spring Validation 框架来实现参数校验的功能。@Validated 注解可以应用于控制器层、服务层、持久层等不同的组件中。

下面是几个 @Validated 注解的使用方案：

方法参数校验：可以将 @Validated 注解应用于方法的参数上，以校验该参数的有效性。此时，需要结合其他参数校验注解（如 @NotNull、@NotBlank、@Size 等）一起使用。

public void saveUser(@Validated User user) {
    // 方法体
}
1
2
3

分组校验：通过指定校验分组，可以对不同的场景应用不同的校验规则。可以使用 @Validated 注解的 groups 属性来指定校验分组。

public void updateUser(@Validated({Group1.class, Group2.class}) User user) {
    // 方法体
}
1
2
3

类级别校验：可以将 @Validated 注解应用于类上，以校验类中的所有字段的有效性。此时，需要在字段上使用相应的参数校验注解。

@Validated
public class User {
    @NotNull
    private String username;
    
    @NotBlank
    private String password;
    
    // 其他字段及getter/setter
}
1
2
3
4
5
6
7
8
9
10

需要注意的是，@Validated 注解是 Spring Framework 提供的增强版验证注解，它与 JSR-303/JSR-349 中的 Bean Validation 规范相类似，但有一些不同之处。例如，Spring 的 @Validated 注解支持 Spring EL 表达式等高级功能。

总之，@Validated 注解是 Spring Framework 中用于参数校验的注解，可以应用于方法参数、类以及校验分组。它提供了一种方便的方式来实现参数校验，并能够与其他参数校验注解一起使用。

@NotNull与@NotBlank区别

@NotBlank 和 @NotEmpty 是常用的参数校验注解，用于验证字符串字段或方法参数的非空性。它们之间的主要区别在于注解的行为和适用的场景：

@NotBlank 注解：

@NotBlank 注解来自于 Hibernate Validator，它验证一个字符串字段或方法参数是否非空，并且不能只包含空格字符。这意味着字符串不能为 null，长度必须大于零，并且不能只包含空格字符。
@NotBlank 注解只适用于字符串类型，不能用于其他类型。
示例用法：@NotBlank String name;

@NotEmpty 注解：

@NotEmpty 注解来自于 JSR-303/JSR-349 Bean Validation 规范，它验证一个字段或方法参数是否非空，适用于字符串、集合、数组和 Map 等类型的字段和参数。
@NotEmpty 注解要求字段或参数不能为 null，并且其长度或大小不能为零。
示例用法：
字符串：@NotEmpty String name;
集合、数组或 Map：@NotEmpty List list;
总结：

@NotBlank 主要用于验证字符串的非空性，且不能仅包含空格字符。
@NotEmpty 可用于字符串、集合、数组和 Map 等类型的非空性验证，要求字段或参数不能为 null，且长度或大小不能为零。 注解无法直接校验空串（空字符串）。它的主要作用是验证字段或方法参数是否为空，但它不对空字符串进行验证。

在选择使用时，要根据具体情况和需求来决定使用哪个注解，以确保合适的非空性验证。

如果您需要校验空串，可以使用 @NotBlank 注解。@NotBlank 注解在校验字符串非空的同时，也会检查字符串是否只包含空格字符。

示例用法：

@NotBlank
private String name;
1
2

另外，若需要校验空串的情况，也可以使用 @NotNull 注解来实现。@NotNull 用于验证字段或方法参数是否为 null，若要同时校验空串，可以配合使用 @Size(min = 1) 注解。

示例用法：

@NotNull
@Size(min = 1)
private String name;
1
2
3

请注意，在使用 @NotBlank 或 @NotNull 进行校验时，需要确保使用的校验实现支持这些注解。通常，使用引入了对应实现的验证框架（如 Hibernate Validator）会对这些注解提供支持。

---

总结

@NotBlank对字符串校验更严格，可以校验出仅有空格字符串；@NotEmpty不仅可以校验字符串（不能校验仅有空格字符串），还能校验集合。

---

                                                                                                         ---- 永不磨灭的番号：我是AK