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：用于参数或返回值，表明其不能为空（在适用 @NonNullApi 的参数和返回值上不需要）。

  • @Nullable：用于参数或返回值，表明其可以为 null。

Spring 注解使用 JSR 305 注解进行元注解（这是一个休眠但广泛使用的 JSR）。JSR 305 元注解允许工具供应商（如 IDEA、Eclipse 和 Kotlin）以通用方式提供空值安全支持，而无需硬编码对 Spring 注解的支持。要为查询方法启用运行时空值约束检查，需要在包级别通过在 package-info.java 中使用 Spring 的 @NonNullApi 来激活非空性，示例如下：

在 package-info.java 中声明非空性
@org.springframework.lang.NonNullApi
package com.acme;

一旦设置了非空默认值，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 的 Repositories 中的空值性

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

在 Kotlin Repositories 上使用空值约束
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`。