仓库方法的空值处理

从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中声明非空值性

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

一旦非空默认值到位，仓库查询方法调用将在运行时针对空值性约束进行验证。如果查询结果违反了定义的约束，则会抛出异常。当方法将返回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	此方法接受`firstname`参数的`null`值，如果查询没有产生结果，则返回`null`。