投射

投射

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 並讓表達式調用方法，如稍早所述。

可為 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 表示法回傳值。如果後端值為 null，則 getter 方法會回傳所用包裝器型別的空表示法。

基於類別的投射 (DTO)

定義投射的另一種方法是使用值型別 DTO（資料傳輸物件），該 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<?>。