仓库方法的空值处理

从 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）进行元注解。JSR 305 元注解允许工具供应商（例如 IDEA、Eclipse 和 Kotlin）以通用方式提供空安全支持，而无需硬编码对 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`。