跳到主要内容

仓库方法的空值处理

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 来表示。返回集合、集合替代方案、包装器或流的 Repository 方法保证永远不会返回 null，而是返回相应的空表示。详情请参阅“Repository 查询返回类型”。

空值注解​

你可以通过使用 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。