仓库方法的空处理

可以使用返回单个聚合实例的仓库CRUD方法自选用来表示可能缺少某个值。 除此之外,Spring Data 支持在查询方法上返回以下封装类型:spring-doc.cadn.net.cn

或者,查询方法也可以选择不使用包装类型。 查询结果缺失时,通过返回表示. 返回集合、集合替代方案、包装器和流的存储库方法保证永远不会返回而是相应的空表示。 详情请参见“仓库查询返回类型”。spring-doc.cadn.net.cn

可作废性注释

JSpecify

与 Spring Framework 7 和 Spring Data 4 一样,您可以使用 JSpecify 表达仓库方法的空可受约束。 JSpecify 与 IntelliJ 和 Eclipse 集成良好,提供了工具友好型和选择加入的方式运行时的检查如下:spring-doc.cadn.net.cn

@NullMarked在包层面通过package-info.java文件
@NullMarked
package org.springframework.core;

import org.jspecify.annotations.NullMarked;

在包内的各种 Java 文件中,可空的类型使用被明确定义为@Nullable. 建议将该注释指定在相关类型之前。spring-doc.cadn.net.cn

例如,对于一个字段:spring-doc.cadn.net.cn

private @Nullable String fileEncoding;

或者对于方法参数和返回值:spring-doc.cadn.net.cn

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

在覆盖方法时,空性注释不会继承自超类方法。 这意味着如果你只是想覆盖实现并保持相同的 API 空,这些空标注应该被重复。spring-doc.cadn.net.cn

对于数组和变量,你需要能够区分元素的空值和数组本身的空值。 注意 Java 规范中定义的语法,这可能会让人感到惊讶:spring-doc.cadn.net.cn

Java 规范还强制要求定义为@Target(ElementType.TYPE_USE)像JSpecify一样@Nullable应在最后一个之后指定.具有内层或完全合格的类型:spring-doc.cadn.net.cn

@NonNull@NullUnmarked在典型的使用场景中,通常很少需要。spring-doc.cadn.net.cn

Spring Framework 的可空性与 JSR-305 注释

你可以通过使用 Spring Framework 的可空性注释来表达仓库方法的空可受约束。spring-doc.cadn.net.cn

与 Spring Framework 7 一样,Spring 的空可性注释被弃用,转而使用 JSpecify。更多信息请参阅框架文档,内容是如何从 Spring 空安全注释迁移到 JSpecify

他们提供对工具友好的方案并可选择加入运行时的检查如下:spring-doc.cadn.net.cn

Spring 注释通过 JSR 305 注释进行元注释(一种休眠但广泛使用的 JSR)。JSR 305 元注释使工具厂商(如 IDEAEclipseKotlin)能够以通用方式提供空安全支持,而无需硬编码支持 Spring 注释。为了实现查询方法的空约束的运行时检查,你需要在包层面使用 Spring 的@NonNullApipackage-info.java如下例所示:spring-doc.cadn.net.cn

在中宣告不可归性package-info.java

一旦非空默认设置就位,仓库查询方法调用会在运行时验证是否存在空约束。如果查询结果违反定义的约束,会抛出异常。这发生在方法返回时但被声明为不可空(默认情况下,标注定义在仓库所在包上)。如果你想再次选择可空结果,请选择性使用@Nullable针对单个方法。使用本节开头提到的结果包装类型依然如预期般工作:空结果被转换为表示缺失的值。spring-doc.cadn.net.cn

以下示例展示了刚才描述的一些技术:spring-doc.cadn.net.cn

使用不同的空约束
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当查询未产生结果时。抛出IllegalArgumentException邮箱地址交给该方法的.
3 返回当查询未产生结果时。也接受作为邮箱地址.
4 返回Optional.empty()当查询未产生结果时。抛出IllegalArgumentException邮箱地址交给该方法的.

基于Kotlin的仓库中的可空性

Kotlin 在语言中内置了空可受约束的定义。Kotlin 代码编译为字节码,这不通过方法签名表达空可受约束,而是通过编译后的元数据表达。确保包含Kotlin反射JAR 在你的项目中实现对 Kotlin 空可性约束的内省。Spring Data 仓库使用语言机制来定义这些约束,以应用相同的运行时检查,具体如下:spring-doc.cadn.net.cn

使用 Kotlin 仓库的空可约束
interface UserRepository : Repository<User, String> {

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

  fun findByFirstname(firstname: String?): User? (2)
}
1 该方法将参数和结果都定义为不可空(Kotlin 默认)。Kotlin 编译器拒绝通过的方法调用对方法。如果查询结果为空,则EmptyResultDataAccessException被抛出。
2 该方法接受对于名称参数与返回如果查询没有产生结果。