跳到主要内容

存储库方法的空值处理

ChatGPT-4o-mini 中英对照 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 query return types”。

Nullability 注解​

您可以通过使用Spring Framework 的 nullability 注解来表示仓库方法的可空性约束。它们提供了一种适合工具的方式，并在运行时选择性地进行 null 检查，具体如下：

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

  • @NonNull：用于不能为 null 的参数或返回值（如果适用 @NonNullApi，则不需要在参数和返回值上使用）。

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

Spring 注解通过 JSR 305 注解进行了元注解（这是一个处于休眠状态但广泛使用的 JSR）。JSR 305 元注解使工具供应商（如 IDEA、Eclipse 和 Kotlin）能够以通用的方式提供空安全支持，而无需为 Spring 注解硬编码支持。为了在查询方法中启用空值约束的运行时检查，您需要通过在 package-info.java 中使用 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-reflect JAR 以启用对 Kotlin 空值约束的反射。Spring Data 仓库使用该语言机制来定义这些约束，以应用相同的运行时检查，如下所示：

interface UserRepository : Repository<User, String> {

  fun findByUsername(username: String): User     1

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

  • 该方法将参数和返回结果定义为非空（Kotlin 的默认值）。Kotlin 编译器会拒绝传递 null 的方法调用。如果查询返回空结果，将抛出 EmptyResultDataAccessException。

  • 该方法接受 null 作为 firstname 参数，并在查询没有返回结果时返回 null。