Spring Data的Repositories----投影Projections

Spring Data查询方法通常返回由存储库管理的聚合根（aggregate root）的一个或多个实例。但是，有时可能需要基于这些类型的某些属性来创建投影。Spring Data允许对专用的返回类型进行建模，以便更有选择地检索托管聚合（managed aggregates）的部分视图。
参见一个存储库和聚合根类型，例如以下示例：
聚合和存储库示例

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);
}

查询执行引擎在运行时为返回的每个元素创建该接口的代理实例，并将对公开方法的调用转发到目标对象。
在存储库中声明覆盖base方法的方法（例如，在CrudRepository中声明的方法，特定于存储库的接口或Simple…Repository）会导致对base方法的调用，而不管声明的返回类型如何。请确保使用兼容的返回类型，因为基方法不能用于投影。一些存储模块支持@Query注解，将重写的base方法转换为查询方法，然后可以用于返回投影。
投影可以递归使用。如果你也想包含一些Address信息，请为其创建一个投影接口，并从getAddress()的声明中返回该接口，如以下示例所示：
用于检索属性子集的投影接口

interface PersonSummary {

  String getFirstname();
  String getLastname();
  AddressSummary getAddress();

  interface AddressSummary {
    String getCity();
  }
}

在方法调用时，获取目标实例的address属性并依次包装到投影代理中。

1.1 Closed Projections

其访问器方法都与目标聚合的属性匹配的投影接口被视为闭合投影。下面的例子（我们在本章前面也使用过）是一个闭合投影：
闭合投影

interface NamesOnly {

  String getFirstname();
  String getLastname();
}

如果使用闭合投影，Spring Data可以优化查询执行，因为框架知道支持投影代理所需的所有属性。有关详细信息，请参阅参考文档中特定于模块的部分。

1.2 Open Projections

投影接口中的访问器方法也可以用于通过使用@Value注解来计算新值，如以下示例所示：
开放投影

interface NamesOnly {

  @Value("#{target.firstname + ' ' + target.lastname}")
  String getFullName();
  …
}

支持投影的聚合根(aggregate root)在目标变量中可用。使用@Value的投影接口是开放投影。在这种情况下，Spring Data无法应用查询执行优化，因为SpEL表达式可以使用聚合根的任何属性。
@Value中使用的表达式不应太复杂 — 你可能希望避免在字符串变量中编程。对于非常简单的表达式，一种选择可能是使用默认方法（在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并让表达式调用方法，如前所述。

1.3 Nullable Wrappers

投影接口中的Getter可以使用nullable的包装来提高null-safety。当前支持的包装类型为：

• java.util.Optional
• com.google.common.base.Optional
• scala.Option
• io.vavr.control.Option

使用nullable的包装器的投影接口

interface NamesOnly {

  Optional<String> getFirstname();
}

如果底层投影值不为空，则使用包装器类型的当前表示返回值。如果backing值为空，则getter方法返回所用包装器类型的空表示形式。

二、基于类的投影(DTOs)

定义投影的另一种方法是使用值类型的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);
}

通过这种方式，该方法可用于按原样或在应用投影的情况下获得aggregates，如以下示例所示：
使用具有动态投影的存储库

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<?>。