投影

Spring Data 查詢方法通常返回一個或多個由倉庫管理的聚合根例項。然而，有時可能需要基於這些型別的某些屬性建立投影。Spring Data 允許定義專門的返回型別，以便更具選擇性地檢索托管聚合的部分檢視。

假設有一個倉庫和聚合根型別，如下例所示：

一個示例聚合和倉庫

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();
}

這裡的關鍵在於，在此處定義的屬性與聚合根中的屬性完全匹配。這樣做就可以新增一個查詢方法，如下所示：

一個使用基於介面的投影並帶有查詢方法的倉庫

interface PersonRepository extends Repository<Person, UUID> {

  Collection<NamesOnly> findByLastname(String lastname);
}

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

在您的 Repository 中宣告一個覆蓋基本方法（例如在 CrudRepository、特定儲存的倉庫介面或 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 並讓表示式呼叫方法，如前面所述。

可空包裝器

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

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

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

interface NamesOnly {

  Optional<String> getFirstname();
}

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

基於類的投影 (DTOs)

定義投影的另一種方法是使用值型別 DTO（資料傳輸物件），它們持有要檢索的欄位的屬性。這些 DTO 型別的使用方式與投影介面完全相同，不同之處在於不會發生代理，並且不能應用巢狀投影。

如果儲存透過限制要載入的欄位來最佳化查詢執行，則要載入的欄位由公開的建構函式的引數名稱決定。

以下示例顯示了一個投影 DTO：

一個投影 DTO

record NamesOnly(String firstname, String lastname) {
}

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

動態投影

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

一個使用動態投影引數的倉庫

interface PersonRepository extends Repository<Person, UUID> {

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

透過這種方式，該方法可用於按原樣或應用投影來獲取聚合，如下例所示：

使用具有動態投影的倉庫

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;
  }

  // ...
}