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：用于参数或返回值，表示其不能为 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 中声明非空性

一旦非空性默认设置到位，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-based 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`。