Repository 方法的空值處理

從 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）以通用方式提供空安全支援，無需硬編碼對 Spring 註解的支援。要為查詢方法啟用空值約束的執行時檢查，您需要在包級別使用 Spring 的 @NonNullApi 在 package-info.java 中啟用非空性，如下例所示：

在 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 位於我們定義了非空行為的包（或子包）中。
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 repositories 使用語言機制來定義這些約束，以應用相同的執行時檢查，如下所示：

在 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。