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 中宣告非空性
@org.springframework.lang.NonNullApi
package com.acme;

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

基於 Kotlin 的 Repository 中的可空性

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。