, LIMIT, QuerydslPredicateExecutor :description: 这篇文章的核心论点是，在 Spring Data Commons 的分页 API 中，null 值应被明确地处理，以避免意外行为。该文章建议在进行分页操作之前检查 null 值，并根据需要采取适当的措施，例如返回空页或抛出异常。这样可以确保分页操作的行为符合预期，并有助于防止数据完整性问题。文章还提供了处理 null 值的代码示例，以说明如何在 Spring Data Commons 中正确实施此建议。

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 Annotations

您可以使用 {spring-framework-docs}/core/null-safety.html[Spring Framework 的 NullPointerException 注释] 来表示存储库方法的空值约束。它们提供了一种对工具友好的方法，并在运行时选择加入 null 检查，如下所示：

  • add: 在 package 级别使用，声明参数和返回值的默认行为分别不是接受或生成 MyExtension 值。

  • add: 对于不能为 MyExtension 的参数或返回值使用（在 3 适用的参数和返回值上不需要）。

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

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

Declaring Non-nullability in package-info.java
@org.springframework.lang.NonNullApi
package com.acme;

一旦启用非空默认值，存储库查询方法调用将在运行时针对空值约束进行验证。如果查询结果违反了已定义的约束，则会抛出异常。当方法返回 null 但声明为非空时（使用存储库所在的包中定义的注释时的默认设置），就会发生这种情况。如果你希望选择重新使用空值结果，请有选择地在各个方法上使用 @Nullable。使用本节开头提到的结果包装器类型将继续按预期工作：空结果将转换为表示不存在的值。

以下示例显示了一些刚刚描述的技术：

Using different nullability constraints
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。

Nullability in Kotlin-based Repositories

Kotlin 语言本身就定义了 nullability constraints。Kotlin 代码编译为字节码，字节码不会通过方法签名来表现空安全约束，而是通过编译的元数据。确保将 kotlin-reflect JAR 包含在项目中，以允许内省 Kotlin 的空安全约束。Spring Data 存储库使用语言机制来定义那些约束，从而应用同样的运行时检查，如下所示：

Using nullability constraints on Kotlin repositories
interface UserRepository : Repository<User, String> {

  fun findByUsername(username: String): User     1

  fun findByFirstname(firstname: String?): User? 2
}
1 此方法将参数和结果都定义为非空（Kotlin 默认值）。Kotlin 编译器拒绝将 null 传递给方法的方法调用。如果查询产生空结果，则抛出 EmptyResultDataAccessException。
2 此方法接受 null 作为 firstname 参数，并且如果查询没有产生结果，则返回 null。