跳到主要内容

Repository 方法的 Null 处理

QWen Flash 中英对照 Null Handling of Repository Methods

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

  • com.google.common.base.Optional

  • scala.Option

  • io.vavr.control.Option

或者，查询方法可以完全选择不使用包装类型。查询结果不存在则通过返回 null 来表示。返回集合、集合替代类型、包装类型和流的 Repository 方法保证永远不会返回 null，而是返回相应的空表示形式。有关详细信息，请参见“Repository query return types”。

可空性注释​

JSpecify​

从 Spring Framework 7 和 Spring Data 4 开始，你可以使用 JSpecify 为 repository 方法表达可空性约束。JSpecify 已很好地集成到 IntelliJ 和 Eclipse 中，提供了一种对工具友好的方式，并可在运行时进行可选的 null 检查，如下所示：

  • @NullMarked: 用于在模块、包和类级别声明，默认情况下参数和返回值分别既不接受也不产生 null 值。

  • @NonNull: 用于类型级别，表示参数或返回值必须不为 null（对于已由 @NullMarked 覆盖的参数和返回值，无需再标注）。

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

  • @NullUnmarked: 用于包、类和成员方法级别，以撤销 nullness 声明并选择退出之前的 @NullMarked。在这种情况下，nullness 变为未指定。

@NullMarked
package org.springframework.core;

import org.jspecify.annotations.NullMarked;
java

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

例如，对于一个字段：

private @Nullable String fileEncoding;
java

或者用于方法参数与返回值：

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

当重写一个方法时，nullness annotations 不会从父类方法继承。这意味着如果你只是想重写实现并保持相同的 API nullness，这些 nullness annotations 应该被重复声明。

使用数组和 varargs 时，你需要能够区分元素的可空性与数组本身的可空性。请注意 Java 规范 中定义的语法，它一开始可能令人意外：

  • @Nullable Object[] array 表示数组元素可以为 null，但数组本身不能为 null。

  • Object @Nullable [] array 表示数组元素不能为 null，但数组本身可以为 null。

  • @Nullable Object @Nullable [] array 表示数组元素和数组本身都可以为 null。

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

  • Cache.@Nullable ValueWrapper

  • jakarta.validation.@Nullable Validator

@NonNull 和 @NullUnmarked 在典型使用场景中很少需要。

Spring Framework 可空性与 JSR-305 注解​

您可以使用 Spring Framework 的可空性注解 来表达仓储方法的可空性约束。

备注

自 Spring Framework 7 起，Spring 的 nullability annotations 已弃用，推荐使用 JSpecify。请参阅框架文档中的 从 Spring null-safety annotations 迁移到 JSpecify 以获取更多信息。

它们提供了一种对工具友好的方式，并在运行时支持可选择启用的 null 检查，如下所示：

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

  • @NonNull: 用于不能为 null 的参数或返回值（在 @NonNullApi 适用的参数和返回值上不需要）。

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

Spring annotations 通过 JSR 305 annotations（一个休眠但广泛使用的 JSR）进行元注解。JSR 305 meta-annotations 让工具厂商（例如 IDEA、Eclipse 和 Kotlin）以通用方式提供 null-safety 支持，而无需硬编码支持 Spring annotations。要启用对 query methods 的 nullability 约束的运行时检查，你需要在 package 级别通过使用 Spring’s @NonNullApi 在 package-info.java 中激活 non-nullability，如下例所示：

一旦启用非空默认值，repository 查询方法调用会在运行时针对可空性约束进行校验。如果查询结果违反已定义的约束，就会抛出异常。当方法本应返回 null 但被声明为非空时，就会发生这种情况（默认情况下，该 annotation 定义在 repository 所在的 package 上）。如果想再次选择启用可空结果，可以在单个方法上按需使用 @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 emailAddress);          3

  Optional<User> findOptionalByEmailAddress(EmailAddress emailAddress); 4
}
java

  • 该仓库位于我们定义了非空行为的包（或子包）中。

  • 当查询没有产生结果时，抛出 EmptyResultDataAccessException。当传递给该方法的 emailAddress 为 null 时，抛出 IllegalArgumentException。

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

  • 当查询没有产生结果时，返回 Optional.empty()。当传递给该方法的 emailAddress 为 null 时，抛出 IllegalArgumentException。

基于 Kotlin 的仓库中的可空性​

Kotlin 在语言中内置了 nullability constraints 的定义。Kotlin 代码会编译为 bytecode，而 bytecode 并不通过 method signatures 表达 nullability constraints，而是通过编译内置的 metadata 表达。请确保在项目中包含 kotlin-reflect JAR，以启用对 Kotlin’s nullability constraints 的内省。Spring Data repositories 使用这一语言机制来定义这些约束，以应用相同的 runtime checks，如下所示：

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。