投影

Spring Data 查詢方法通常會返回 Repository 管理的聚合根的一個或多個實例。然而，有時可能需要根據這些類型的某些屬性建立投影。Spring Data 允許對專用的返回類型進行建模，以更有選擇性地檢索受管理聚合的部分視圖。

想像一下如下範例所示的 Repository 和聚合根類型

範例聚合和 Repository
class Person {

  @Id UUID id;
  String firstname, lastname;
  Address address;

  static class Address {
    String zipCode, city, street;
  }
}

interface PersonRepository extends Repository<Person, UUID> {

  Collection<Person> findByLastname(String lastname);
}

現在想像一下，我們只想檢索人員的姓名屬性。Spring Data 提供了哪些方法來實現這一點？本章的其餘部分將回答這個問題。

投影類型是位於實體類型層次結構之外的類型。實體實作的父類別和介面位於類型層次結構內，因此返回超類型（或實作的介面）會返回完全實體化的實例。

基於介面的投影

將查詢結果限制為僅姓名屬性的最簡單方法是宣告一個介面，該介面公開用於讀取屬性的存取器方法，如下例所示

用於檢索屬性子集的投影介面
interface NamesOnly {

  String getFirstname();
  String getLastname();
}

這裡重要的是，此處定義的屬性與聚合根中的屬性完全匹配。這樣做可以新增如下查詢方法

使用基於介面的投影和查詢方法的 Repository
interface PersonRepository extends Repository<Person, UUID> {

  Collection<NamesOnly> findByLastname(String lastname);
}

查詢執行引擎在運行時為每個返回的元素建立該介面的代理實例，並將對公開方法的呼叫轉發到目標物件。

在您的 Repository 中宣告一個覆寫基底方法的方法（例如，在 CrudRepository、特定商店的 repository 介面或 Simple…Repository 中宣告）會導致呼叫基底方法，而與宣告的回傳類型無關。請確保使用相容的回傳類型，因為基底方法不能用於投影。某些商店模組支援 @Query 註解，以將覆寫的基底方法轉換為查詢方法，然後可用於返回投影。

投影可以遞迴使用。如果您也想包含一些 Address 資訊，請為其建立一個投影介面，並從 getAddress() 的宣告中返回該介面，如下例所示

用於檢索屬性子集的投影介面
interface PersonSummary {

  String getFirstname();
  String getLastname();
  AddressSummary getAddress();

  interface AddressSummary {
    String getCity();
  }
}

在方法調用時，會取得目標實例的 address 屬性，並依次包裝到投影代理中。

封閉式投影

存取器方法都與目標聚合的屬性匹配的投影介面被視為封閉式投影。以下範例（我們在本章前面也使用過）是封閉式投影

封閉式投影
interface NamesOnly {

  String getFirstname();
  String getLastname();
}

如果您使用封閉式投影，Spring Data 可以最佳化查詢執行，因為我們知道支援投影代理所需的所有屬性。有關更多詳細資訊，請參閱參考文檔中特定模組的部分。

開放式投影

投影介面中的存取器方法也可以使用 @Value 註解來計算新值，如下例所示

開放式投影
interface NamesOnly {

  @Value("#{target.firstname + ' ' + target.lastname}")
  String getFullName();
  …
}

支援投影的聚合根在 target 變數中可用。使用 @Value 的投影介面是開放式投影。在這種情況下，Spring Data 無法套用查詢執行最佳化，因為 SpEL 表達式可以使用聚合根的任何屬性。

在 @Value 中使用的表達式不應太複雜 — 您要避免在 String 變數中程式設計。對於非常簡單的表達式，一種選擇可能是求助於預設方法（在 Java 8 中引入），如下例所示

使用預設方法進行自訂邏輯的投影介面
interface NamesOnly {

  String getFirstname();
  String getLastname();

  default String getFullName() {
    return getFirstname().concat(" ").concat(getLastname());
  }
}

此方法要求您能夠完全根據投影介面上公開的其他存取器方法來實作邏輯。第二種更靈活的選擇是在 Spring Bean 中實作自訂邏輯，然後從 SpEL 表達式中調用它，如下例所示

範例 Person 物件
@Component
class MyBean {

  String getFullName(Person person) {
    …
  }
}

interface NamesOnly {

  @Value("#{@myBean.getFullName(target)}")
  String getFullName();
  …
}

請注意 SpEL 表達式如何引用 myBean 並調用 getFullName(…) 方法，以及如何將投影目標作為方法參數轉發。由 SpEL 表達式評估支援的方法也可以使用方法參數，然後可以從表達式中引用這些參數。方法參數透過名為 args 的 Object 陣列提供。以下範例展示了如何從 args 陣列中取得方法參數

範例 Person 物件
interface NamesOnly {

  @Value("#{args[0] + ' ' + target.firstname + '!'}")
  String getSalutation(String prefix);
}

同樣，對於更複雜的表達式，您應該使用 Spring Bean 並讓表達式調用方法，如先前所述。

可為 Null 的包裝器

投影介面中的 Getter 可以使用可為 Null 的包裝器來提高 Null 安全性。目前支援的包裝器類型為

  • java.util.Optional

  • com.google.common.base.Optional

  • scala.Option

  • io.vavr.control.Option

使用可為 Null 的包裝器的投影介面
interface NamesOnly {

  Optional<String> getFirstname();
}

如果底層投影值不是 null，則會使用包裝器類型的 present-representation 返回值。如果後備值為 null，則 getter 方法會返回所用包裝器類型的空表示。

基於類別的投影 (DTO)

定義投影的另一種方法是使用值類型 DTO（資料傳輸物件），這些 DTO 保留要檢索欄位的屬性。這些 DTO 類型可以以與投影介面完全相同的方式使用，只是不會發生代理，並且無法套用巢狀投影。

如果商店透過限制要載入的欄位來最佳化查詢執行，則要載入的欄位會從公開的建構子的參數名稱中確定。

以下範例顯示了投影 DTO

投影 DTO
record NamesOnly(String firstname, String lastname) {
}

Java Records 是定義 DTO 類型的理想選擇，因為它們符合值語意：所有欄位都是 private final，並且會自動建立 equals(…)`/`hashCode()`/`toString()` 方法。或者，您可以使用任何定義您要投影的屬性的類別。

動態投影

到目前為止，我們已將投影類型用作集合的回傳類型或元素類型。但是，您可能希望在調用時選擇要使用的類型（這使其成為動態的）。若要套用動態投影，請使用如下例所示的查詢方法

使用動態投影參數的 Repository
interface PersonRepository extends Repository<Person, UUID> {

  <T> Collection<T> findByLastname(String lastname, Class<T> type);
}

這樣，該方法可用於取得聚合，無論是否套用投影，如下例所示

使用動態投影的 Repository
void someMethod(PersonRepository people) {

  Collection<Person> aggregates =
    people.findByLastname("Matthews", Person.class);

  Collection<NamesOnly> aggregates =
    people.findByLastname("Matthews", NamesOnly.class);
}
會檢查 Class 類型的查詢參數是否符合動態投影參數的資格。如果查詢的實際回傳類型等於 Class 參數的泛型參數類型，則匹配的 Class 參數不可用於查詢或 SpEL 表達式中。如果您想使用 Class 參數作為查詢引數，請確保使用不同的泛型參數，例如 Class<?>。