SpringBoot使用@NotNull注解解决办法

Spring Boot 中 @NotNull 注解失效问题指南

前言

在 Spring Boot 框架中，@NotNull 注解用于验证请求参数、方法参数和属性的非空性。但是，有时 @NotNull 注解可能会失效，导致 Spring Boot 应用程序无法正确验证输入。本文将探讨导致 @NotNull 注解失效的常见原因及其对应的解决方案。

解决方案

要解决 Spring Boot 应用程序中 @NotNull 注解失效的问题，可以按照以下步骤进行：

1. 检查库依赖项

确保应用程序的 pom.xml 文件包含了必要的依赖项。在 Spring Boot 2.3 之前，@NotNull 注解包含在 spring-boot-starter-web 库中。在 Spring Boot 2.3 及更高版本中，需要显式引入 spring-boot-starter-validation 库。添加以下依赖项：

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

2. 正确使用 @NotNull 注解

@NotNull 注解只能用于基本类型（如 int、long、double 等）、字符串、枚举和 JavaBean。用于其他类型时，注解将失效。

3. 启用 Spring MVC 参数验证

Spring MVC 参数验证默认启用，但可以通过在 application.properties 或 application.yml 文件中设置 spring.mvc.valid 参数来禁用。要启用它，添加以下设置：

spring.mvc.valid=true

4. 其他解决方法

如果上述步骤不起作用，可以尝试以下方法：

• 清除项目缓存并重新编译。
• 确保 Java 编译器版本与 Spring Boot 版本兼容。
• 检查类路径，确保没有与 spring-boot-starter-validation 库冲突的其他库。

最佳实践

• 始终在需要验证的字段上使用 @NotNull 注解。
• 尽量使用 @NotNull 注解，而不是 @NotEmpty 或 @NotBlank 注解，因为 @NotNull 注解对所有类型有效。
• 在方法参数和请求参数上使用 @NotNull 注解，而不是属性。
• 在控制器方法中使用 @Valid 注解验证请求参数或方法参数。
• 在实体类中使用 @Valid 注解验证属性。

常见问题解答

• 为什么 @NotNull 注解对字符串无效？
  @NotNull 注解不能直接用于字符串。相反，可以使用 @NotEmpty 或 @NotBlank 注解，分别验证字符串是否不为空或不为空白。

• 为什么 @NotNull 注解对集合无效？
  @NotNull 注解不能直接用于集合。相反，可以使用 @NotEmpty 或 @Size 注解，分别验证集合是否不为空或具有特定大小。

• 为什么 @NotNull 注解对自定义类型无效？
  要使 @NotNull 注解对自定义类型有效，需要在类型上使用 @Validated 注解，并在字段上使用 @NotNull 注解。

• 如何禁用 Spring MVC 参数验证？
  可以在 application.properties 或 application.yml 文件中设置 spring.mvc.valid=false 来禁用 Spring MVC 参数验证。

• @NotNull 注解和 @Required 注解有什么区别？
  @NotNull 注解验证非空性，而 @Required 注解验证是否存在，即使值为 null。

结论

通过遵循本文中的步骤和最佳实践，可以确保 Spring Boot 应用程序中 @NotNull 注解的有效性，从而防止无效输入和确保数据完整性。