投影

Spring Data 查詢方法通常返回由 Repository 管理的一個或多個 Aggregate Root 例項。然而，有時可能希望根據這些型別的特定屬性建立投影。Spring Data 允許建模專用的返回型別，以更選擇性地檢索托管聚合的部分檢視。

設想一個 Repository 和 Aggregate Root 型別，例如以下示例

一個示例聚合和 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();
}

這裡重要的一點是，此處定義的屬性與 Aggregate Root 中的屬性完全匹配。這樣做可以新增一個查詢方法，如下所示

一個使用基於介面的投影和查詢方法的 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();
  …
}

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

@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 並讓表示式呼叫方法，如前面所述。

可空包裝器

投影介面中的 getter 可以使用可空包裝器來提高 null 安全性。當前支援的包裝器型別有

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

一個使用可空包裝器的投影介面

interface NamesOnly {

  Optional<String> getFirstname();
}

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

基於類的投影 (DTOs)

定義投影的另一種方法是使用值型別 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<?>。

使用基於類的投影時，型別必須宣告一個建構函式，以便 Spring Data 可以確定其輸入屬性。如果你的類定義了多個建構函式，則在使用該型別進行 DTO 投影時，你需要提供進一步的提示。在這種情況下，如以下所示，使用 @PersistenceCreator 註解所需的建構函式，以便 Spring Data 可以確定選擇哪些屬性

public class NamesOnly {

  private final String firstname;
  private final String lastname;

  protected NamesOnly() { }

  @PersistenceCreator
  public NamesOnly(String firstname, String lastname) {
      this.firstname = firstname;
      this.lastname = lastname;
  }

  // ...
}