儲存庫方法的 Null 處理

從 Spring Data 2.0 開始，儲存庫 CRUD 方法回傳單一聚合實例時，會使用 Java 8 的 Optional 來表示可能沒有值。除此之外，Spring Data 支援在查詢方法中回傳以下包裝類型

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

或者，查詢方法可以選擇完全不使用包裝類型。查詢結果的缺失將通過返回 null 來表示。返回集合、集合替代方案、包裝器和流的儲存庫方法保證永遠不會返回 null，而是返回相應的空表示形式。詳情請參閱「儲存庫查詢回傳類型」。

可空性註解

您可以使用 Spring Framework 的可空性註解來表達儲存庫方法的可空性約束。它們提供了一種工具友好的方法，並在運行時選擇加入 null 檢查，如下所示

@NonNullApi：在套件層級使用，宣告參數和回傳值的預設行為分別為既不接受也不產生 null 值。
@NonNull：在參數或回傳值上使用，表示不得為 null（在 @NonNullApi 適用的參數和回傳值上不需要）。
@Nullable：在參數或回傳值上使用，表示可以為 null。

Spring 註解使用 JSR 305 註解（一個休眠但廣泛使用的 JSR）進行元註解。JSR 305 元註解讓工具供應商（例如 IDEA、Eclipse 和 Kotlin）以通用方式提供 null 安全性支援，而無需硬式編碼對 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	此方法接受 `firstname` 參數為 `null`，如果查詢未產生結果，則返回 `null`。