Repository 方法的空值處理

自 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：用於引數或返回值，表明其不能為空（在適用 @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;

一旦設定了非空預設值，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 位於一個我們為其定義了非空行為的包（或子包）中。
2	當查詢沒有產生結果時丟擲 `EmptyResultDataAccessException`。當傳遞給方法的 `emailAddress` 為 `null` 時丟擲 `IllegalArgumentException`。
3	當查詢沒有產生結果時返回 `null`。也接受 `null` 作為 `emailAddress` 的值。
4	當查詢沒有產生結果時返回 `Optional.empty()`。當傳遞給方法的 `emailAddress` 為 `null` 時丟擲 `IllegalArgumentException`。

基於 Kotlin 的 Repositories 中的空值性

Kotlin 將空值約束的定義內置於語言中。Kotlin 程式碼編譯為位元組碼，它不透過方法簽名表達空值約束，而是透過編譯入的元資料。確保在您的專案中包含 kotlin-reflect JAR，以啟用對 Kotlin 空值約束的內省。Spring Data Repositories 使用語言機制定義這些約束，以應用相同的執行時檢查，如下所示：

在 Kotlin Repositories 上使用空值約束

interface UserRepository : Repository<User, String> {

  fun findByUsername(username: String): User     (1)

  fun findByFirstname(firstname: String?): User? (2)
}

1	該方法將引數和結果都定義為非空（Kotlin 預設）。Kotlin 編譯器會拒絕向該方法傳遞 `null` 的方法呼叫。如果查詢結果為空，則會丟擲 `EmptyResultDataAccessException`。
2	此方法接受 `firstname` 引數為 `null`，並且如果查詢沒有產生結果，則返回 `null`。