投影
投影
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 提供什么方法来实现此目的？本章的其余部分将回答这个问题。
| 投影类型是存在于实体类型层次结构之外的类型。实体实现的超类和接口位于类型层次结构中，因此返回超类型（或实现的接口）将返回完全具体化实体的实例。 |
基于接口的投影
限制查询结果仅为 name 属性的最简单方法是声明一个接口，该接口公开要读取的属性的访问器方法，如下例所示
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 并让表达式调用方法，如前面所述。
基于类的投影（DTO）
定义投影的另一种方法是使用值类型 DTO（数据传输对象），它包含要检索的字段的属性。这些 DTO 类型可以与投影接口完全相同的方式使用，但不会发生代理，并且不能应用嵌套投影。
如果存储通过限制要加载的字段来优化查询执行，则要加载的字段将由公开的构造函数的参数名称确定。
以下示例显示投影 DTO
record NamesOnly(String firstname, String lastname) {
}Java 记录非常适合定义 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<?>。
|
