仓库方法的 Null 处理

自 Spring Data 2.0 起，返回单个聚合实例的 repository CRUD 方法使用 Java 8 的 Optional 来指示可能不存在的值。此外，Spring Data 支持在查询方法上返回以下包装器类型

  • com.google.common.base.Optional

  • scala.Option

  • io.vavr.control.Option

或者，查询方法可以选择完全不使用包装器类型。在这种情况下，查询结果的缺失通过返回 null 来指示。返回集合、集合替代类型、包装器和 Stream 的 repository 方法保证绝不返回 null，而是返回相应的空表示。详见“Repository 查询返回类型”。

Nullability 注解

你可以使用Spring Framework 的 nullability 注解来表达 repository 方法的 nullability 约束。它们提供了一种对工具友好的方法，并在运行时选择启用 null 检查，如下所示

  • @NonNullApi：用于包级别，声明参数和返回值的默认行为分别是既不接受也不产生 null 值。

  • @NonNull：用于参数或返回值，表示它们不能是 null (在应用 `@NonNullApi` 的参数和返回值上不需要此注解)。

  • @Nullable：用于参数或返回值，表示它们可以是 null。

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

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

一旦非 null 默认设置到位，repository 查询方法调用将在运行时验证 nullability 约束。如果查询结果违反了定义的约束，将抛出异常。这发生在方法返回 null 但被声明为非 nullable（在 repository 所在包上定义的注解的默认行为）时。如果想再次选择启用 nullable 结果，请在个别方法上选择性地使用 `@Nullable`。使用本节开头提到的结果包装器类型会继续按预期工作：空结果被转换为表示缺失的值。

以下示例展示了刚才描述的一些技术

使用不同的 nullability 约束
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 位于已定义非 null 行为的包（或子包）中。
2 当查询没有产生结果时，抛出 EmptyResultDataAccessException。当传递给方法的 emailAddress 为 null 时，抛出 IllegalArgumentException。
3 当查询没有产生结果时，返回 null。也接受 null 作为 emailAddress 的值。
4 当查询没有产生结果时，返回 Optional.empty()。当传递给方法的 emailAddress 为 null 时，抛出 IllegalArgumentException。

基于 Kotlin 的 Repository 中的 Nullability

Kotlin 的语言本身就内置了nullability 约束的定义。Kotlin 代码编译成字节码，它不是通过方法签名而是通过编译进来的元数据来表达 nullability 约束的。请确保在项目中包含 `kotlin-reflect` JAR，以启用对 Kotlin nullability 约束的内省。Spring Data repository 使用语言机制来定义这些约束，以应用相同的运行时检查，如下所示

在 Kotlin repository 上使用 nullability 约束
interface UserRepository : Repository<User, String> {

  fun findByUsername(username: String): User     (1)

  fun findByFirstname(firstname: String?): User? (2)
}
1 该方法将参数和结果都定义为非 nullable（Kotlin 默认行为）。Kotlin 编译器会拒绝向方法传递 null 的方法调用。如果查询结果为空，则会抛出 EmptyResultDataAccessException。
2 此方法接受 null 作为 firstname 参数的值，并且如果查询没有产生结果，则返回 null。