投影
投影
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);
}现在想象一下，我们只想检索 Person 的姓名属性。Spring Data 提供了哪些方法来实现这一目标？本章的其余部分将回答这个问题。
| 投影类型是位于实体类型层次结构之外的类型。实体的超类和实现的接口位于类型层次结构之内，因此返回超类型（或实现的接口）将返回完全具体化的实体实例。 |
基于接口的投影
限制查询结果仅包含姓名属性的最简单方法是声明一个接口，该接口公开了要读取属性的访问器方法，示例如下：
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 并让表达式调用方法，如前面所述。
基于类的投影（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 投影进一步提示的情况下使用该类型。在这种情况下，如以下概要所示，使用 |
