Repository 方法的空值处理

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

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

或者，查询方法也可以选择根本不使用包装类型。此时，通过返回 null 来指示查询结果的缺失。返回集合、集合替代品、包装器和 Stream 的 Repository 方法保证永远不会返回 null，而是返回相应的空表示。详见“Repository 查询返回类型”。

可空性注解

您可以使用 Spring Framework 的可空性注解来表达 repository 方法的可空性约束。它们提供了一种对工具友好的方法，并在运行时选择启用 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 中声明非可空性

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

基于 Kotlin 的 Repository 中的可空性

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

在 Kotlin repository 上使用可空性约束

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