跳到主要内容

仓库方法的空值处理

DeepSeek V3 中英对照 Null Handling of Repository Methods

自 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 来激活非空性，如以下示例所示：

@org.springframework.lang.NonNullApi
package com.acme;
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
}
java

  • 该存储库位于一个包（或子包）中，我们已为其定义了非空行为。

  • 当查询未产生结果时抛出 EmptyResultDataAccessException。当传递给方法的 emailAddress 为 null 时抛出 IllegalArgumentException。

  • 当查询未产生结果时返回 null。同时接受 null 作为 emailAddress 的值。

  • 当查询未产生结果时返回 Optional.empty()。当传递给方法的 emailAddress 为 null 时抛出 IllegalArgumentException。

基于 Kotlin 的仓库中的空值处理​

Kotlin 在语言层面内置了空值约束的定义。Kotlin 代码编译为字节码后，字节码并不会通过方法签名来表达空值约束，而是通过编译后的元数据来实现。为了启用对 Kotlin 空值约束的内省，请确保在项目中包含 kotlin-reflect JAR。Spring Data 仓库利用这种语言机制来定义这些约束，从而应用相同的运行时检查，如下所示：

interface UserRepository : Repository<User, String> {

  fun findByUsername(username: String): User     1

  fun findByFirstname(firstname: String?): User? 2
}
kotlin

  • 该方法将参数和结果都定义为非空类型（Kotlin 的默认行为）。Kotlin 编译器会拒绝将 null 传递给该方法的调用。如果查询结果为空，则会抛出 EmptyResultDataAccessException 异常。

  • 该方法允许 firstname 参数为 null，并且如果查询未产生结果，则返回 null。