Repository 方法的空值处理

返回单个聚合实例的存储库 CRUD 方法可以使用 Optional 来指示值可能不存在。此外，Spring Data 支持在查询方法上返回以下包装器类型：

  • com.google.common.base.Optional

  • scala.Option

  • io.vavr.control.Option

或者，查询方法可以选择完全不使用包装器类型。此时，通过返回 null 来指示查询结果的缺失。返回集合、集合替代品、包装器和流的存储库方法保证绝不返回 null，而是返回相应的空表示。有关详细信息，请参阅“存储库查询返回类型”。

空值注解

JSpecify

从 Spring Framework 7 和 Spring Data 4 开始，您可以使用 JSpecify 为存储库方法表达空值约束。JSpecify 与 IntelliJ 和 Eclipse 良好集成，提供了一种工具友好的方法，并在运行时选择性地进行 null 检查，如下所示：

  • @NullMarked：用于模块、包和类级别，声明参数和返回值的默认行为分别是既不接受也不生成 null 值。

  • @NonNull：用于类型级别，表示参数或返回值不得为 null（在应用 @NullMarked 的地方不需要）。

  • @Nullable：用于类型级别，表示参数或返回值可以为 null。

  • @NullUnmarked：用于包、类和方法级别，以回滚空值声明并从之前的 @NullMarked 中选择退出。在这种情况下，空值变为未指定。

通过 package-info.java 文件在包级别使用 @NullMarked
@NullMarked
package org.springframework.core;

import org.jspecify.annotations.NullMarked;

在属于该包的各种 Java 文件中，可空类型的使用通过 @Nullable 显式定义。建议此注解紧接在相关类型之前指定。

例如，对于字段

private @Nullable String fileEncoding;

或者用于方法参数和返回值

public static @Nullable String buildMessage(@Nullable String message,
                                            @Nullable Throwable cause) {
    // ...
}

在覆盖方法时，空值注解不会从超类方法继承。这意味着如果您只是想覆盖实现并保持相同的 API 空值，则应重复这些空值注解。

对于数组和可变参数，您需要能够区分元素的空值性和数组本身的空值性。请注意 Java 规范定义的语法，这可能最初会令人惊讶：

  • @Nullable Object[] array 意味着单个元素可以为 null，但数组本身不能为 null。

  • Object @Nullable [] array 意味着单个元素不能为 null，但数组本身可以为 null。

  • @Nullable Object @Nullable [] array 意味着单个元素和数组都可以为 null。

Java 规范还强制规定，使用 @Target(ElementType.TYPE_USE) 定义的注解，如 JSpecify @Nullable，应在内部或完全限定类型的最后一个 . 之后指定。

  • Cache.@Nullable ValueWrapper

  • jakarta.validation.@Nullable Validator

对于典型用例，@NonNull 和 @NullUnmarked 很少需要。

Spring Framework 空值和 JSR-305 注解

您可以使用 Spring Framework 的空值注解为存储库方法表达空值约束。

与 Spring Framework 7 一样，Spring 的空值注解已弃用，转而支持 JSpecify。有关更多信息，请参阅框架文档中的 从 Spring 空值安全注解迁移到 JSpecify。

它们提供了一种工具友好的方法，并在运行时选择性地进行 null 检查，如下所示：

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

  • @NonNull：用于参数或返回值，表示不得为 null（在应用 @NonNullApi 的参数和返回值上不需要）。

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

Spring 注解使用 JSR 305 注解（一个休眠但广泛使用的 JSR）进行元注解。JSR 305 元注解允许工具供应商（如 IDEA、Eclipse 和 Kotlin）以通用方式提供空值安全支持，而无需硬编码支持 Spring 注解。要启用查询方法的空值约束的运行时检查，您需要在包级别通过在 package-info.java 中使用 Spring 的 @NonNullApi 来激活非空值，如以下示例所示：

在 package-info.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)
}
1 存储库位于我们定义了非空行为的包（或子包）中。
2 当查询未生成结果时，抛出 EmptyResultDataAccessException。当传递给方法的 emailAddress 为 null 时，抛出 IllegalArgumentException。
3 当查询未生成结果时，返回 null。也接受 null 作为 emailAddress 的值。
4 当查询未生成结果时，返回 Optional.empty()。当传递给方法的 emailAddress 为 null 时，抛出 IllegalArgumentException。

基于 Kotlin 的存储库中的空值

Kotlin 将空值约束的定义内置到语言中。Kotlin 代码编译成字节码，它不通过方法签名表达空值约束，而是通过编译后的元数据表达。请确保在您的项目中包含 kotlin-reflect JAR，以启用 Kotlin 空值约束的内省。Spring Data 存储库使用语言机制来定义这些约束，以应用相同的运行时检查，如下所示：

在 Kotlin 存储库上使用空值约束
interface UserRepository : Repository<User, String> {

  fun findByUsername(username: String): User     (1)

  fun findByFirstname(firstname: String?): User? (2)
}
1 该方法将参数和结果都定义为非空值（Kotlin 默认值）。Kotlin 编译器会拒绝向该方法传递 null 的方法调用。如果查询产生空结果，则会抛出 EmptyResultDataAccessException。
2 此方法接受 firstname 参数的 null 值，并且如果查询未生成结果，则返回 null。
© . This site is unofficial and not affiliated with VMware.