跳到主要内容

仓储方法的空值处理

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”。

可空性注解​

您可以通过使用 Spring Framework 的可空性注解 来表示存储库方法的可空性约束。这些注解提供了一种工具友好的方法，并在运行时进行可选的 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。