Repository 方法的空值處理

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

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

或者，查詢方法可以選擇完全不使用包裝器型別。此時，透過返回 null 來指示查詢結果的缺失。返回集合、集合替代品、包裝器和流的儲存庫方法保證絕不返回 null，而是返回相應的空表示。有關詳細資訊，請參閱“儲存庫查詢返回型別”。

空值註解

JSpecify

從 Spring Framework 7 和 Spring Data 4 開始，您可以使用 JSpecify 為儲存庫方法表達空值約束。JSpecify 與 IntelliJ 和 Eclipse 良好整合，提供了一種工具友好的方法，並在執行時選擇性地進行 null 檢查，如下所示：

@NullMarked：用於模組、包和類級別，宣告引數和返回值的預設行為分別是既不接受也不生成 null 值。
@NonNull：用於型別級別，表示引數或返回值不得為 null（在應用 @NullMarked 的地方不需要）。
@Nullable：用於型別級別，表示引數或返回值可以為 null。
@NullUnmarked：用於包、類和方法級別，以回滾空值宣告並從之前的 @NullMarked 中選擇退出。在這種情況下，空值變為未指定。

透過 package-info.java 檔案在包級別使用 @NullMarked

@NullMarked
package org.springframework.core;

import org.jspecify.annotations.NullMarked;

在屬於該包的各種 Java 檔案中，可空型別的使用透過 @Nullable 顯式定義。建議此註解緊接在相關型別之前指定。

例如，對於欄位

private @Nullable String fileEncoding;

或者用於方法引數和返回值

public static @Nullable String buildMessage(@Nullable String message,
                                            @Nullable Throwable cause) {
    // ...
}

在覆蓋方法時，空值註解不會從超類方法繼承。這意味著如果您只是想覆蓋實現並保持相同的 API 空值，則應重複這些空值註解。

對於陣列和可變引數，您需要能夠區分元素的空值性和陣列本身的空值性。請注意 Java 規範定義的語法，這可能最初會令人驚訝：

@Nullable Object[] array 意味著單個元素可以為 null，但陣列本身不能為 null。
Object @Nullable [] array 意味著單個元素不能為 null，但陣列本身可以為 null。
@Nullable Object @Nullable [] array 意味著單個元素和陣列都可以為 null。

Java 規範還強制規定，使用 @Target(ElementType.TYPE_USE) 定義的註解，如 JSpecify @Nullable，應在內部或完全限定型別的最後一個 . 之後指定。

Cache.@Nullable ValueWrapper
jakarta.validation.@Nullable Validator

對於典型用例，@NonNull 和 @NullUnmarked 很少需要。

Spring Framework 空值和 JSR-305 註解

您可以使用 Spring Framework 的空值註解為儲存庫方法表達空值約束。

與 Spring Framework 7 一樣，Spring 的空值註解已棄用，轉而支援 JSpecify。有關更多資訊，請參閱框架文件中的從 Spring 空值安全註解遷移到 JSpecify。

它們提供了一種工具友好的方法，並在執行時選擇性地進行 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 但被宣告為非空值時（在儲存庫所在的包中定義註解的預設值），就會發生這種情況。如果您想再次選擇空值結果，請在單個方法上選擇性地使用 @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	此方法接受 `firstname` 引數的 `null` 值，並且如果查詢未生成結果，則返回 `null`。