|
对于最新稳定版本，请使用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： 用于参数或返回值，可以零.
春季注释通过 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 | 该方法接受零对于名称参数与返回零如果查询没有产生结果。 |