跳到主要内容

仓库方法的空值处理

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

空值注解

你可以通过使用 Spring Framework 的可空性注解 来表达仓储方法的可空性约束。它们提供了一种工具友好的方式,并在运行时选择性地进行 null 检查,如下所示:

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

  • @NonNull: 用于参数或返回值,表示其必须不能为 null(在 @NonNullApi 适用的参数和返回值上不需要使用)。

  • @Nullable: 用于参数或返回值,表示其可以为 null

Spring 注解使用了 JSR 305 注解进行元注解(这是一个休眠但广泛使用的 JSR)。JSR 305 元注解允许工具供应商(如 IDEAEclipseKotlin)以通用方式提供空安全支持,而无需硬编码对 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。当传递给方法的 emailAddressnull 时抛出 IllegalArgumentException

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

  • 当查询未产生结果时返回 Optional.empty()。当传递给方法的 emailAddressnull 时抛出 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