存储库方法的空值处理

从 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 注解硬编码支持。要启用对查询方法的空性约束的运行时检查，您需要使用 Spring 的 @NonNullApi 在 package-info.java 中激活包级别的非空性，如下例所示

在 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 此方法接受 `firstname` 参数的 `null`，如果查询没有产生结果，则返回 `null`。