Repository 方法的空值处理

从 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）。JSR 305 元注解允许工具供应商（例如IDEA、Eclipse 和Kotlin）以通用方式提供空安全支持，无需硬编码对 Spring 注解的支持。要为查询方法启用空值约束的运行时检查，您需要在包级别使用 Spring 的 @NonNullApi 在 package-info.java 中激活非空性，如下例所示：

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

一旦非空默认设置生效，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 位于我们定义了非空行为的包（或子包）中。
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 repositories 使用语言机制来定义这些约束，以应用相同的运行时检查，如下所示：

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