投影
Spring Data 查詢方法通常會回傳 Repository 管理的聚合根的一個或多個實例。然而，有時可能需要根據這些類型的特定屬性建立投影。Spring Data 允許對專用的回傳類型建模，以便更有選擇性地檢索受管理聚合的部分視圖。
假設有一個 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 提供哪些方法來實現這一點？本章的其餘部分將回答這個問題。
| 投影類型是位於實體類型層次結構之外的類型。實體實作的超類別和介面位於類型層次結構內，因此回傳超類型（或實作的介面）會回傳完全具體化實體的實例。 |
務必注意，使用 JPQL 的基於類別的投影僅限於 JPQL 表達式中的建構子表達式，例如 SELECT new com.example.NamesOnly(u.firstname, u.lastname) from User u。（請注意 DTO 類型的 FQDN 用法！）此 JPQL 表達式也可以在您定義任何具名查詢的 @Query 註解中使用。而且務必指出，基於類別的投影完全不適用於原生查詢。作為一種變通方法，您可以使用帶有 ResultSetMapping 的具名查詢，或 Hibernate 特定的 ResultListTransformer |
基於介面的投影
將查詢結果限制為僅姓名屬性的最簡單方法是宣告一個介面，該介面公開要讀取屬性的存取器方法，如下例所示
interface NamesOnly {
String getFirstname();
String getLastname();
}這裡重要的部分是，此處定義的屬性與聚合根中的屬性完全匹配。這樣做可以新增查詢方法，如下所示
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 表達式中調用該邏輯，如下例所示
@Component
class MyBean {
String getFullName(Person person) {
…
}
}
interface NamesOnly {
@Value("#{@myBean.getFullName(target)}")
String getFullName();
…
}請注意 SpEL 表達式如何引用 myBean 並調用 getFullName(…) 方法，並將投影目標作為方法參數轉發。由 SpEL 表達式評估支援的方法也可以使用方法參數，然後可以從表達式中引用這些參數。方法參數透過名為 args 的 Object 陣列提供。以下範例顯示如何從 args 陣列中取得方法參數
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
interface NamesOnly {
Optional<String> getFirstname();
}如果底層投影值不是 null，則使用包裝器類型的 present 表示法回傳值。如果後端值為 null，則 getter 方法會回傳所使用包裝器類型的空表示法。
基於類別的投影 (DTO)
定義投影的另一種方法是使用值類型 DTO（資料傳輸物件），該 DTO 保留要檢索欄位的屬性。這些 DTO 類型可以與投影介面以完全相同的方式使用，不同之處在於不會發生代理，並且無法套用巢狀投影。
如果商店透過限制要載入的欄位來最佳化查詢執行，則要載入的欄位由公開的建構子的參數名稱決定。
以下範例顯示了投影 DTO
record NamesOnly(String firstname, String lastname) {
}Java Record 是定義 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<?>。 |
