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 查詢返回型別”。

可空性註解

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

  • @NonNullApi：用於包級別，宣告引數和返回值的預設行為分別是不接受也不產生 null 值。

  • @NonNull：用於引數或返回值，表示其不能是 null（在 @NonNullApi 生效的引數和返回值上不需要）。

  • @Nullable：用於引數或返回值，表示其可以是 null。

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

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

一旦非空預設設定到位，repository 查詢方法呼叫將在執行時驗證其可空性約束。如果查詢結果違反了定義的約束，則會丟擲異常。這發生在方法將返回 null 但被宣告為非可空（在 repository 所在的包上定義註解時的預設行為）的情況下。如果您想再次選擇允許可空結果，請在個別方法上選擇性地使用 @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 repository 位於我們已定義非 null 行為的包（或子包）中。
2 當查詢沒有產生結果時，丟擲 EmptyResultDataAccessException。當傳遞給方法的 emailAddress 為 null 時，丟擲 IllegalArgumentException。
3 當查詢沒有產生結果時，返回 null。也接受 null 作為 emailAddress 的值。
4 當查詢沒有產生結果時，返回 Optional.empty()。當傳遞給方法的 emailAddress 為 null 時，丟擲 IllegalArgumentException。

基於 Kotlin 的 Repositories 中的可空性

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

在 Kotlin repository 上使用可空性約束
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。