Repository 方法的空值處理

從 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 查詢返回型別”。

可空性註解

您可以使用 Spring Framework 的可空性註解來表達 repository 方法的可空性約束。它們提供了一種對工具友好的方法，並在執行時選擇啟用 null 檢查，如下所示：

@NonNullApi：用於包級別，宣告引數和返回值的預設行為分別是既不接受也不產生 null 值。
@NonNull：用於引數或返回值，宣告其不能為 null（在應用了 @NonNullApi 的引數和返回值上無需使用）。
@Nullable：用於引數或返回值，宣告其可以為 null。

Spring 註解透過 JSR 305 註解進行了元註解（這是一個休眠但廣泛使用的 JSR）。JSR 305 元註解使工具供應商（例如 IDEA、Eclipse 和 Kotlin）能夠以通用方式提供空安全支援，而無需硬編碼支援 Spring 註解。要為查詢方法啟用可空性約束的執行時檢查，您需要在包級別透過在 package-info.java 中使用 Spring 的 @NonNullApi 來啟用非可空性，如以下示例所示：

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

一旦設定了非 null 預設值，將在執行時驗證 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 位於已定義非 `null` 行為的包（或子包）中。
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`。