|
该版本仍在开发中，尚未被视为稳定。对于最新稳定版本，请使用Spring Data Elasticsearch 5.5.5！ |
仓库方法的空处理
自 Spring Data 2.0 起，返回单个聚合实例的仓库 CRUD 方法使用 Java 8自选以表示可能缺失的值。除此之外，Spring Data支持在查询方法上返回以下封装类型：
-
com.google.common.base.Optional -
斯卡拉。选择 -
io.vavr.control.Option
或者，查询方法也可以选择不使用包装类型。查询结果的缺失通过返回表示零. 返回集合、集合替代方案、包装器和流的存储库方法保证永远不会返回零而是相应的空表示。详情请参见“仓库查询返回类型”。
可作废性注释
你可以通过使用 Spring Framework 的空可否性注释来表达仓库方法的空可受约束。它们提供了工具友好型和选择加入的方式零运行时的检查如下：
-
@NonNullApi： 在包层面用于声明参数和返回值的默认行为分别是既不接受，也不产生零值。 -
@NonNull： 用于参数或返回值，且不得为零（参数和返回值在其中不需要@NonNullApi适用）。 -
@Nullable： 用于参数或返回值，可以零.
Spring 注释通过 JSR 305 注释进行元注释（一种休眠但广泛使用的 JSR）。JSR 305 元注释使工具厂商（如 IDEA、Eclipse 和 Kotlin）能够以通用方式提供空安全支持，而无需硬编码支持 Spring 注释。为了实现查询方法的空约束的运行时检查，你需要在包层面使用 Spring 的@NonNullApi在package-info.java如下例所示：
package-info.java一旦非空默认设置就位，仓库查询方法调用会在运行时验证是否存在空约束。如果查询结果违反定义的约束，会抛出异常。这发生在方法返回时零但被声明为不可空（默认情况下，标注定义在仓库所在包上）。如果你想再次选择可空结果，请选择性使用@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当查询未产生结果时。抛出IllegalArgumentException当邮箱地址交给该方法的零. |
| 3 | 返回零当查询未产生结果时。也接受零作为邮箱地址. |
| 4 | 返回Optional.empty（）当查询未产生结果时。抛出IllegalArgumentException当邮箱地址交给该方法的零. |
基于Kotlin的仓库中的可空性
Kotlin 在语言中内置了空可受约束的定义。Kotlin 代码编译为字节码，这不通过方法签名表达空可受约束，而是通过编译后的元数据表达。确保包含Kotlin反射JAR 在你的项目中实现对 Kotlin 空可性约束的内省。Spring Data 仓库使用语言机制来定义这些约束，以应用相同的运行时检查，具体如下：
interface UserRepository : Repository<User, String> {
fun findByUsername(username: String): User (1)
fun findByFirstname(firstname: String?): User? (2)
}| 1 | 该方法将参数和结果都定义为不可空（Kotlin 默认）。Kotlin 编译器拒绝通过的方法调用零对方法。如果查询结果为空，则EmptyResultDataAccessException被抛出。 |
| 2 | 该方法接受零对于名称参数与返回零如果查询没有产生结果。 |