倉庫方法的空值處理

從 Spring Data 2.0 開始，返回單個聚合例項的倉庫 CRUD 方法使用 Java 8 的 Optional 來指示可能的值缺失。除此之外，Spring Data 支援在查詢方法上返回以下包裝器型別：

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

或者，查詢方法可以選擇完全不使用包裝器型別。此時，查詢結果的缺失透過返回 null 來表示。返回集合、集合替代方案、包裝器和流的倉庫方法保證不會返回 null，而是返回相應的空表示。詳情請參閱“Repository 查詢返回型別”。

可空性註解

你可以使用 Spring Framework 的可空性註解來表達倉庫方法的可空性約束。它們提供了一種對工具友好的方法，並在執行時選擇性地進行 null 檢查，如下所示：

@NonNullApi：用於包級別，宣告引數和返回值的預設行為分別是既不接受也不產生 null 值。
@NonNull：用於引數或返回值，表示其不能為 null（在應用了 @NonNullApi 的引數和返回值上不需要）。
@Nullable：用於引數或返回值，表示其可以為 null。

Spring 註解使用 JSR 305 註解進行元註解（JSR 305 是一個休眠但廣泛使用的 JSR）。JSR 305 元註解讓工具供應商（如 IDEA、Eclipse 和 Kotlin）以通用方式提供空安全支援，而無需硬編碼對 Spring 註解的支援。要啟用查詢方法可空性約束的執行時檢查，你需要在包級別使用 Spring 的 @NonNullApi 在 package-info.java 中啟用非空性，如下例所示：

在 package-info.java 中宣告非空性

一旦設定了非空預設值，倉庫查詢方法呼叫將在執行時針對可空性約束進行驗證。如果查詢結果違反了定義的約束，則會丟擲異常。當方法將返回 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	該倉庫位於一個我們已定義非空行為的包（或子包）中。
2	當查詢沒有產生結果時丟擲 `EmptyResultDataAccessException`。當傳遞給方法的 `emailAddress` 為 `null` 時丟擲 `IllegalArgumentException`。
3	當查詢沒有產生結果時返回 `null`。也接受 `null` 作為 `emailAddress` 的值。
4	當查詢沒有產生結果時返回 `Optional.empty()`。當傳遞給方法的 `emailAddress` 為 `null` 時丟擲 `IllegalArgumentException`。

基於 Kotlin 的倉庫中的可空性

Kotlin 在語言層面內建了可空性約束的定義。Kotlin 程式碼編譯成位元組碼，它不透過方法簽名而是透過編譯後的元資料來表達可空性約束。確保在你的專案中包含 kotlin-reflect JAR，以啟用對 Kotlin 可空性約束的內省。Spring Data 倉庫使用該語言機制來定義這些約束，以應用相同的執行時檢查，如下所示：

在 Kotlin 倉庫中使用可空性約束

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`。