倉庫方法的 Null 處理

自 Spring Data 2.0 起，返回單個聚合例項的 repository CRUD 方法使用 Java 8 的 Optional 來指示可能不存在的值。此外，Spring Data 支援在查詢方法上返回以下包裝器型別

  • com.google.common.base.Optional

  • scala.Option

  • io.vavr.control.Option

或者，查詢方法可以選擇完全不使用包裝器型別。在這種情況下，查詢結果的缺失透過返回 null 來指示。返回集合、集合替代型別、包裝器和 Stream 的 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-safety 支援，而無需硬編碼對 Spring 註解的支援。要對查詢方法的 nullability 約束啟用執行時檢查，您需要在包級別使用 Spring 的 `package-info.java` 中的 `@NonNullApi` 啟用非 nullability，如以下示例所示

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

一旦非 null 預設設定到位，repository 查詢方法呼叫將在執行時驗證 nullability 約束。如果查詢結果違反了定義的約束，將丟擲異常。這發生在方法返回 null 但被宣告為非 nullable（在 repository 所在包上定義的註解的預設行為）時。如果想再次選擇啟用 nullable 結果，請在個別方法上選擇性地使用 `@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 該方法將引數和結果都定義為非 nullable（Kotlin 預設行為）。Kotlin 編譯器會拒絕向方法傳遞 null 的方法呼叫。如果查詢結果為空，則會丟擲 EmptyResultDataAccessException。
2 此方法接受 null 作為 firstname 引數的值，並且如果查詢沒有產生結果，則返回 null。