投影
投影
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);
}
现在设想我们只想检索 person 的姓名属性。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 表达式中调用它，如下例所示：
@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，并让表达式调用方法，如前文所述。
可空包装器
投影接口中的 getter 可以利用可空包装器来改进空安全。目前支持的包装类型有：
-
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：
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<?>。
使用基于类的投影时，类型必须声明一个构造函数，以便 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;
}
// ...
}