【Spring连载】使用Spring Data的Repositories----存储库方法的null处理

从Spring Data 2.0开始，返回单个聚合实例的存储库CRUD方法使用Java 8的Optional来指示潜在的值缺失。除此之外，Spring Data还支持在查询方法上返回以下包装类型：

• com.google.common.base.Optional
• scala.Option
• io.vavr.control.Option

或者，查询方法可以选择根本不使用包装类型。然后通过返回null来指示没有查询结果。保证返回collections, collection alternatives, wrappers和 streams的存储库方法永远不会返回null，而是返回相应的空表示。有关详细信息，请参阅章节“二十、存储库查询返回类型”。

一、Nullability 注解

你可以通过使用Spring Framework的nullability注解来表达存储库方法的nullability约束。它们提供了一种工具友好的方法，并在运行时选择空检查，如下所示：

• @NonNullApi：在包级别上用于声明参数和返回值的默认行为分别为既不接受也不生成null值。
• @NonNull：用于不能为null的参数或返回值（在@NonNullApi应用的参数和返回值上不需要）。
• @Nullable：用于可以为null的参数或返回值。

Spring注解使用JSR305注解（一个dormant但广泛使用的JSR）进行元注解。JSR305元注解允许工具供应商（如 IDEA、Eclipse和Kotlin）以通用的方式提供空安全支持，而不必对Spring注解进行硬编码支持。要启用查询方法的可空性约束的运行时检查，你需要使用package-info.java中的Spring的@NonNullApi在包级别激活非可空性，如以下示例所示：
在package-info.java中声明不可为null

@org.springframework.lang.NonNullApi
package com.acme;

一旦非null默认设置到位，就会在运行时验证存储库查询方法调用的可空性约束。如果查询结果违反了定义的约束，则会引发异常。当方法返回null但被声明为不可为null（默认情况下，在存储库所在的包上定义了注解）时，就会发生这种情况。如果你想再次选择使用可为null的结果，请在各个方法上选择性地使用@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. 存储库位于一个包（或子包）中，我们已经为其定义了非null行为。
2. 当查询未生成结果时引发EmptyResultDataAccessException。当传递给方法的emailAddress为null时，抛出IllegalArgumentException。
3. 当查询未产生结果时，返回null。也接受null作为emailAddress的值。
4. 当查询未产生结果时，返回Optional.empty()。当传递给方法的emailAddress为null时，抛出IllegalArgumentException。

二、基于Kotlin存储库中的Nullability

Kotlin在语言中加入了可空性约束的定义。Kotlin代码编译为字节码，字节码不通过方法签名来表达可空性约束，而是通过编译后的元数据来表达。确保在你的项目中包括kotlin-reflect JAR，以实现对kotlin的可空性约束的introspection。Spring Data存储库使用语言机制来定义这些约束，以应用相同的运行时检查，如下所示：
在Kotlin存储库上使用可空性约束

interface UserRepository : Repository<User, String> {

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

  fun findByFirstname(firstname: String?): User? --------2
}

1. 该方法将参数和结果定义为不可为null（Kotlin默认值）。Kotlin编译器拒绝将null传递给方法的方法调用。如果查询产生空结果，则抛出EmptyResultDataAccessException。
2. 此方法接受firstname参数为null，如果查询没有产生结果，则返回null。