倉庫方法中的 Null 處理

從 Spring Data 2.0 開始，返回單個聚合例項的倉庫 CRUD 方法使用 Java 8 的 Optional 來指示值可能不存在的情況。除此之外，Spring Data 還支援在查詢方法上返回以下包裝器型別：

com.google.common.base.Optional
scala.Option
io.vavr.control.Option

或者，查詢方法也可以選擇完全不使用包裝器型別。此時，查詢結果的不存在透過返回 null 來表示。返回集合、集合替代品、包裝器和流的倉庫方法保證永遠不會返回 null，而是返回相應的空表示。詳情請參閱 "倉庫查詢返回型別"。

可空性註解

您可以使用 Spring Framework 的可空性註解來表達倉庫方法的可空性約束。它們提供了一種對工具友好的方法，並在執行時選擇性地啟用 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 中宣告非空性

@org.springframework.lang.NonNullApi
package com.acme;

一旦設定了非空預設值，倉庫查詢方法呼叫將在執行時驗證可空性約束。如果查詢結果違反了定義的約束，則會丟擲異常。這發生在方法本應返回 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	此倉庫位於我們已定義非空行為的包（或子包）中。
2	當查詢沒有產生結果時，丟擲 `EmptyResultDataAccessException`。當傳遞給方法的 `emailAddress` 為 `null` 時，丟擲 `IllegalArgumentException`。
3	當查詢沒有產生結果時，返回 `null`。也接受 `null` 作為 `emailAddress` 的值。
4	當查詢沒有產生結果時，返回 `Optional.empty()`。當傳遞給方法的 `emailAddress` 為 `null` 時，丟擲 `IllegalArgumentException`。

基於 Kotlin 的倉庫中的可空性

Kotlin 在語言層面內建了可空性約束的定義。Kotlin 程式碼編譯成位元組碼，位元組碼不透過方法簽名而是透過編譯後的元資料來表達可空性約束。請確保在專案中包含 kotlin-reflect JAR，以便啟用對 Kotlin 可空性約束的內省。Spring Data 倉庫使用語言機制來定義這些約束，以應用相同的執行時檢查，如下所示：

在 Kotlin 倉庫中使用可空性約束

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