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

在 package-info.java 中声明非空性

一旦非空默认值设置到位，存储库查询方法的调用将在运行时验证可空性约束。如果查询结果违反了定义的约束，将抛出异常。当方法应返回 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`。