投影

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 提供了哪些方法来实现这一点？本章的其余部分将回答这个问题。

投影类型是位于实体类型层次结构之外的类型。实体实现的超类和接口位于类型层次结构内，因此返回超类型（或实现的接口）将返回完全物化的实体的实例。

基于接口的投影

限制查询结果仅包含姓名属性的最简单方法是声明一个接口，该接口公开要读取的属性的访问器方法，如下例所示

用于检索属性子集的投影接口

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 表达式中调用它，如下例所示

示例 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 并让表达式调用方法，如前面所述。

可空包装器

投影接口中的 Getter 可以使用可空包装器来提高空安全性。当前支持的包装器类型是

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

使用可空包装器的投影接口

interface NamesOnly {

  Optional<String> getFirstname();
}

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

基于类的投影（DTO）

定义投影的另一种方法是使用包含要检索的字段属性的值类型 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<?>。