Projections _ Spring Data3.2.7中文文档(官方文档中文翻译)|Spring 教程 —

对于最新的稳定版本，请使用 Spring Data Commons 3.3.1！

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

查询执行引擎在运行时为返回的每个元素创建该接口的代理实例，并将对公开方法的调用转发到目标对象。

在 U 中声明重写基方法的方法（例如，声明的、特定于存储的存储库接口或）会导致对基方法的调用，而不管声明的返回类型如何。请确保使用兼容的返回类型，因为基本方法不能用于投影。某些存储模块支持注释，以将重写的基方法转换为查询方法，然后可以使用该方法返回投影。RepositoryCrudRepositorySimple…Repository@Query

投影可以递归使用。如果还想包含某些信息，请为其创建一个投影接口，并从声明返回该接口，如以下示例所示：AddressgetAddress()

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

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

支持投影的聚合根在变量中可用。使用的投影接口是开放投影。在这种情况下，Spring Data 无法应用查询执行优化，因为 SpEL 表达式可以使用聚合根的任何属性。target@Value

中使用的表达式不应太复杂 — 您希望避免在变量中编程。对于非常简单的表达式，一种选择可能是求助于默认方法（在 Java 8 中引入），如以下示例所示：@ValueString

使用自定义逻辑的默认方法的投影接口

interface NamesOnly {

  String getFirstname();
  String getLastname();

  default String getFullName() {
    return getFirstname().concat(" ").concat(getLastname());
  }
}

此方法要求您能够完全基于投影接口上公开的其他访问器方法实现逻辑。第二个更灵活的选项是在 Spring Bean 中实现自定义逻辑，然后从 SpEL 表达式调用该逻辑，如以下示例所示：

Sample Person 对象

@Component
class MyBean {

  String getFullName(Person person) {
    …
  }
}

interface NamesOnly {

  @Value("#{@myBean.getFullName(target)}")
  String getFullName();
  …
}

请注意 SpEL 表达式如何引用和调用方法，以及如何将投影目标作为方法参数转发。 SpEL 表达式计算支持的方法也可以使用方法参数，然后可以从表达式中引用这些参数。方法参数可通过名为的数组获得。下面的示例演示如何从数组中获取方法参数：myBeangetFullName(…)Objectargsargs

Sample Person 对象

interface NamesOnly {

  @Value("#{args[0] + ' ' + target.firstname + '!'}")
  String getSalutation(String prefix);
}

同样，对于更复杂的表达式，您应该使用 Spring Bean 并让表达式调用方法，如前所述。

可空包装

投影接口中的 Getter 可以使用可为 null 的包装器来提高 null 安全性。目前支持的包装器类型包括：

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

使用可为 null 包装器的投影接口

interface NamesOnly {

  Optional<String> getFirstname();
}

如果基础投影值不是，则使用包装器类型的 present 表示形式返回值。如果后备值为，则 getter 方法返回所用包装类型的空表示形式。nullnull

基于类的预测（DTO）

定义投影的另一种方法是使用值类型 DTO（数据传输对象），这些对象包含应检索字段的属性。这些 DTO 类型的使用方式与投影接口的使用方式完全相同，只是不会发生代理，也无法应用嵌套投影。

如果存储通过限制要加载的字段来优化查询执行，则要加载的字段由公开的构造函数的参数名称确定。

以下示例显示了投影 DTO：

投影 DTO

record NamesOnly(String firstname, String lastname) {
}

Java 记录是定义 DTO 类型的理想选择，因为它们遵循值语义：所有字段都是和 // 方法自动创建的。或者，可以使用定义要投影的属性的任何类。private finalequals(…)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);
}

检查查询类型的参数是否符合动态投影参数的条件。如果查询的实际返回类型等于参数的泛型参数类型，则匹配参数不可用于查询或 SpEL 表达式。如果要使用参数作为查询参数，请确保使用不同的泛型参数，例如。ClassClassClassClassClass<?>

基于接口的投影

闭合投影

开放投影

可空包装

基于类的预测 （DTO）

动态投影

基于类的预测（DTO）