Repository 方法的 Null 处理

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

com.google.common.base.Optional
scala.Option
io.vavr.control.Option

或者，查询方法也可以选择根本不使用包装类型。在这种情况下，查询结果的缺失通过返回 null 来表示。返回集合、集合替代类型、包装类型和流的 repository 方法保证永不返回 null，而是返回相应的空表示。有关详细信息，请参阅“Repository 查询返回类型”。

可空性注解

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

@NonNullApi: 用于包级别，声明参数和返回值的默认行为分别是既不接受也不产生 null 值。
@NonNull: 用于参数或返回值，表示其不能为空（对于应用了 @NonNullApi 的参数和返回值则不需要）。
@Nullable: 用于参数或返回值，表示其可以为 null。

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

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

@org.springframework.lang.NonNullApi
package com.acme;

一旦设置了非空默认行为，repository 查询方法的调用将在运行时验证可空性约束。如果查询结果违反了定义的约束，则会抛出异常。当方法返回 null 但被声明为非空（repository 所在包上定义注解时的默认行为）时，就会发生这种情况。如果您想再次选择允许返回 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	该 repository 位于一个我们已定义非空行为的包（或子包）中。
2	当查询没有产生结果时抛出 `EmptyResultDataAccessException`。当传递给方法的 `emailAddress` 为 `null` 时抛出 `IllegalArgumentException`。
3	当查询没有产生结果时返回 `null`。也接受 `null` 作为 `emailAddress` 的值。
4	当查询没有产生结果时返回 `Optional.empty()`。当传递给方法的 `emailAddress` 为 `null` 时抛出 `IllegalArgumentException`。

基于 Kotlin 的 Repositories 中的可空性

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

在 Kotlin Repositories 上使用可空性约束

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`。