|
此版本仍在开发中，尚不被认为是稳定的。对于最新的稳定版本，请使用 Spring Data Commons 3.5.3！ |
预测
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 表达式评估支持的方法也可以使用方法参数，然后可以从表达式中引用这些参数。
方法参数可通过Object名为args.
以下示例演示如何从args数组：
interface NamesOnly {
@Value("#{args[0] + ' ' + target.firstname + '!'}")
String getSalutation(String prefix);
}同样，对于更复杂的表达式，您应该使用 Spring bean 并让表达式调用一个方法，如前所述。
可为 null 的包装器
投影接口中的 getter 可以使用可为 null 的包装器来提高 null 安全性。 当前支持的包装器类型包括：
-
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 类型的使用方式与使用投影接口的方式完全相同，只是不会发生代理，也无法应用嵌套投影。
如果存储通过限制要加载的字段来优化查询执行，则要加载的字段是根据公开的构造函数的参数名称确定的。
以下示例显示了投影 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 表达式中使用。
如果要使用Classparameter 作为查询参数，请确保使用不同的泛型参数，例如Class<?>. |
|
使用基于类的投影时，类型必须声明单个构造函数，以便 Spring Data 可以确定其输入属性。
如果类定义了多个构造函数，则如果没有 DTO 投影的进一步提示，则无法使用该类型。
在这种情况下，使用 |