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 約束的執行時檢查，您需要透過在 package-info.java 中使用 Spring 的 @NonNullApi 來在包級別啟用非 nullability，如下例所示：

在 package-info.java 中宣告非 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。