仓库方法中的 Null 处理

从 Spring Data 2.0 开始，返回单个聚合实例的仓库 CRUD 方法使用 Java 8 的 Optional 来指示值可能不存在的情况。除此之外，Spring Data 还支持在查询方法上返回以下包装器类型：

  • com.google.common.base.Optional

  • scala.Option

  • io.vavr.control.Option

或者，查询方法也可以选择完全不使用包装器类型。此时，查询结果的不存在通过返回 null 来表示。返回集合、集合替代品、包装器和流的仓库方法保证永远不会返回 null，而是返回相应的空表示。详情请参阅 "仓库查询返回类型"。

可空性注解

您可以使用 Spring Framework 的可空性注解 来表达仓库方法的可空性约束。它们提供了一种对工具友好的方法，并在运行时选择性地启用 null 检查，如下所示：

  • @NonNullApi：用于包级别，声明参数和返回值的默认行为分别是既不接受也不产生 null 值。

  • @NonNull：用于参数或返回值，表示它们不能是 null（在应用了 @NonNullApi 的参数和返回值上不需要）。

  • @Nullable：用于参数或返回值，表示它们可以是 null。

Spring 注解用 JSR 305 注解（一个不活跃但被广泛使用的 JSR）进行了元注解。JSR 305 元注解允许工具供应商（如 IDEA、Eclipse 和 Kotlin）以通用方式提供空安全支持，而无需对 Spring 注解进行硬编码支持。要为查询方法启用可空性约束的运行时检查，您需要在包级别激活非空性，方法是在 package-info.java 中使用 Spring 的 @NonNullApi，如下例所示：

在 package-info.java 中声明非空性
@org.springframework.lang.NonNullApi
package com.acme;

一旦设置了非空默认值，仓库查询方法调用将在运行时验证可空性约束。如果查询结果违反了定义的约束，则会抛出异常。这发生在方法本应返回 null 但被声明为非可空（在包含仓库的包中定义注解时的默认行为）时。如果您想再次选择接受可空结果，可以在单个方法上选择性地使用 @Nullable。使用本节开头提到的结果包装器类型仍然会按预期工作：空结果会被转换为表示不存在的值。

以下示例展示了刚才描述的一些技巧：

使用不同的可空性约束
package com.acme;                                                       (1)

import org.springframework.lang.Nullable;

interface UserRepository extends Repository<User, Long> {

  User getByEmailAddress(EmailAddress emailAddress);                    (2)

  @Nullable
  User findByEmailAddress(@Nullable EmailAddress emailAdress);          (3)

  Optional<User> findOptionalByEmailAddress(EmailAddress emailAddress); (4)
}
1 此仓库位于我们已定义非空行为的包（或子包）中。
2 当查询没有产生结果时，抛出 EmptyResultDataAccessException。当传递给方法的 emailAddress 为 null 时，抛出 IllegalArgumentException。
3 当查询没有产生结果时，返回 null。也接受 null 作为 emailAddress 的值。
4 当查询没有产生结果时，返回 Optional.empty()。当传递给方法的 emailAddress 为 null 时，抛出 IllegalArgumentException。

基于 Kotlin 的仓库中的可空性

Kotlin 在语言层面内置了 可空性约束 的定义。Kotlin 代码编译成字节码，字节码不通过方法签名而是通过编译后的元数据来表达可空性约束。请确保在项目中包含 kotlin-reflect JAR，以便启用对 Kotlin 可空性约束的内省。Spring Data 仓库使用语言机制来定义这些约束，以应用相同的运行时检查，如下所示：

在 Kotlin 仓库中使用可空性约束
interface UserRepository : Repository<User, String> {

  fun findByUsername(username: String): User     (1)

  fun findByFirstname(firstname: String?): User? (2)
}
1 该方法将参数和结果都定义为非可空（Kotlin 默认）。Kotlin 编译器将拒绝传递 null 给方法的调用。如果查询产生空结果，将抛出 EmptyResultDataAccessException。
2 此方法接受 null 作为 firstname 参数的值，并且如果查询没有产生结果，则返回 null。