Repository 方法的 Null 处理

从 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 查询返回类型”。

Nullability 注解

您可以使用 Spring Framework 的 nullability 注解来表达 repository 方法的 nullability 约束。它们提供了一种工具友好的方法，并在运行时可选地进行 null 检查，具体如下：

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

  • @NonNull：用于必须非 null 的参数或返回值（在应用 @NonNullApi 的参数和返回值上不需要）。

  • @Nullable：用于可以为 null 的参数或返回值。

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

在 package-info.java 中声明非 nullability

一旦设置了非 null 默认值，repository 查询方法的调用将在运行时验证其 nullability 约束。如果查询结果违反了定义的约束，将抛出异常。这种情况发生在方法应返回 null 但被声明为非 null（在 repository 所在的包中定义了注解时的默认行为）时。如果您希望再次选择可为 null 的结果，可以在个别方法上选择性地使用 @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 该方法将参数和结果都定义为非 null（Kotlin 的默认值）。Kotlin 编译器将拒绝向该方法传递 null 的方法调用。如果查询产生空结果，将抛出 EmptyResultDataAccessException。
2 此方法接受 null 作为 firstname 参数的值，并且如果查询未产生结果，则返回 null。