Repository 方法的 Null 處理

從 Spring Data 2.0 開始，repository CRUD 方法若回傳單一聚合實例，會使用 Java 8 的 Optional 來表示可能缺少值的情況。除此之外，Spring Data 也支援在查詢方法中回傳以下包裝類型

  • com.google.common.base.Optional

  • scala.Option

  • io.vavr.control.Option

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

Null 標註

您可以使用 Spring Framework 的 Null 標註來表達 repository 方法的 null 性約束。它們提供工具友善的方法，並在執行期間選擇性啟用 null 檢查，如下所示

  • @NonNullApi：在套件層級使用，宣告參數和回傳值的預設行為分別為既不接受也不產生 null 值。

  • @NonNull：在不得為 null 的參數或回傳值上使用（在套用 @NonNullApi 的參數和回傳值上不需要）。

  • @Nullable：在可為 null 的參數或回傳值上使用。

Spring 標註使用 JSR 305 標註（一個休眠但廣泛使用的 JSR）進行元標註。JSR 305 元標註讓工具供應商（例如 IDEA、Eclipse 和 Kotlin）以通用方式提供 null 安全性支援，而無需硬式編碼對 Spring 標註的支援。若要為查詢方法啟用 null 性約束的執行階段檢查，您需要在套件層級使用 Spring 的 @NonNullApi 在 package-info.java 中啟用非 null 性，如下列範例所示

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

一旦非 null 預設值就位，repository 查詢方法的調用會在執行階段針對 null 性約束進行驗證。如果查詢結果違反定義的約束，則會拋出例外。當方法本應回傳 null，但被宣告為非 null 時（在 repository 所在的套件中定義的標註預設值），就會發生這種情況。如果您想再次選擇可為 null 的結果，請在個別方法上選擇性地使用 @Nullable。使用本節開頭提及的結果包裝器類型會繼續如預期般運作：空結果會轉換為表示缺失的值。

以下範例展示了許多剛才描述的技巧

使用不同的 null 性約束
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 repository 位於我們已定義非 null 行為的套件（或子套件）中。
2 當查詢未產生結果時，拋出 EmptyResultDataAccessException。當傳遞給方法的 emailAddress 為 null 時，拋出 IllegalArgumentException。
3 當查詢未產生結果時，回傳 null。也接受 null 作為 emailAddress 的值。
4 當查詢未產生結果時，回傳 Optional.empty()。當傳遞給方法的 emailAddress 為 null 時，拋出 IllegalArgumentException。

Kotlin 基礎 Repository 中的 Null 性

Kotlin 在語言中內建了 null 性約束的定義。Kotlin 程式碼編譯為位元組碼，這不會透過方法簽名來表達 null 性約束，而是透過編譯時中繼資料。請務必在您的專案中包含 kotlin-reflect JAR，以啟用 Kotlin null 性約束的內省。Spring Data repositories 使用語言機制來定義這些約束，以套用相同的執行階段檢查，如下所示

在 Kotlin repositories 上使用 null 性約束
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。