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）進行 meta-annotation 註解。JSR 305 meta-annotations 讓工具供應商（例如 IDEA、Eclipse 和 Kotlin）以通用方式提供 null-safety 支援，而無需硬式編碼 Spring 註解的支援。若要啟用查詢方法 nullability 約束的執行時期檢查，您需要在套件層級使用 Spring 的 @NonNullApi 在 package-info.java 中啟用 non-nullability，如下列範例所示

在 package-info.java 中宣告 Non-nullability
@org.springframework.lang.NonNullApi
package com.acme;

一旦 non-null 預設值就位，repository 查詢方法調用會在執行時期針對 nullability 約束進行驗證。如果查詢結果違反定義的約束，則會擲出例外。當方法會回傳 null 但宣告為 non-nullable 時（預設值為在 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 位於我們已定義 non-null 行為的套件（或子套件）中。
2 當查詢未產生結果時，擲出 EmptyResultDataAccessException。當傳遞給方法的 emailAddress 為 null 時，擲出 IllegalArgumentException。
3 當查詢未產生結果時，回傳 null。也接受 null 作為 emailAddress 的值。
4 當查詢未產生結果時，回傳 Optional.empty()。當傳遞給方法的 emailAddress 為 null 時，擲出 IllegalArgumentException。

Kotlin 基礎 Repository 中的 Nullability

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

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

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

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