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 查詢傳回類型」以取得詳細資訊。

Nullability 註解

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

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

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

  • @Nullable：用於可以是 null 的參數或傳回值。

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

在 package-info.java 中宣告 Non-nullability

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

下列範例顯示了剛剛描述的許多技術

使用不同的 nullability 約束
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 中的 Nullability

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

在 Kotlin repository 上使用 nullability 約束
interface UserRepository : Repository<User, String> {

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

  fun findByFirstname(firstname: String?): User? (2)
}
1 此方法將參數和結果都定義為非 null（Kotlin 預設值）。Kotlin 編譯器拒絕將 null 傳遞給方法的方法調用。如果查詢產生空結果，則會擲回 EmptyResultDataAccessException。
2 此方法接受 null 作為 firstname 參數，如果查詢未產生結果，則傳回 null。