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

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

一旦非空性預設設定到位，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-based 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`。