|
对于最新的稳定版本，请使用 Spring Data Commons 3.3.4！ |
|
对于最新的稳定版本，请使用 Spring Data Commons 3.3.4！ |
Spring Data 查询方法通常返回存储库 Management 的聚合根的一个或多个实例。 但是，有时可能需要基于这些类型的某些属性创建投影。 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);
}现在假设我们只想检索人员的 name 属性。 Spring Data 提供了什么方法来实现这一目标？ 本章的其余部分回答了这个问题。
| 投影类型是位于实体类型层次结构之外的类型。 实体实现的超类和接口位于类型层次结构内，因此返回超类型（或实现的接口）将返回完全具体化实体的实例。 |
| 投影类型是位于实体类型层次结构之外的类型。 实体实现的超类和接口位于类型层次结构内，因此返回超类型（或实现的接口）将返回完全具体化实体的实例。 |
基于接口的投影
将查询结果限制为仅 name 属性的最简单方法是声明一个接口，该接口公开要读取的属性的访问器方法，如以下示例所示：
interface NamesOnly {
String getFirstname();
String getLastname();
}这里重要的是，这里定义的属性与 aggregate 根中的 properties 完全匹配。 这样做可以按如下方式添加查询方法：
interface PersonRepository extends Repository<Person, UUID> {
Collection<NamesOnly> findByLastname(String lastname);
}查询执行引擎在运行时为返回的每个元素创建该接口的代理实例，并将对公开方法的调用转发到目标对象。
在 your 中声明一个覆盖基方法的方法（例如，在 、特定于存储的存储库接口或 中声明）会导致调用基方法，而不管声明的返回类型如何。
请确保使用兼容的返回类型，因为基方法不能用于投影。
某些 store 模块支持注释，以将重写的 base 方法转换为查询方法，然后可用于返回投影。RepositoryCrudRepositorySimple…Repository@Query |
投影可以递归使用。
如果还希望包含一些信息，请为此创建一个 projection 接口，并从 的声明中返回该接口，如以下示例所示：AddressgetAddress()
interface PersonSummary {
String getFirstname();
String getLastname();
AddressSummary getAddress();
interface AddressSummary {
String getCity();
}
}在方法调用时，将获取目标实例的属性，并依次包装到投影代理中。address
封闭式投影
其访问器方法都与目标聚合的属性匹配的投影接口被视为闭式投影。 以下示例（我们在本章前面也使用过）是一个闭合投影：
interface NamesOnly {
String getFirstname();
String getLastname();
}如果您使用封闭式投影， Spring Data 可以优化查询执行，因为我们知道支持投影代理所需的所有属性。 有关这方面的更多详细信息，请参阅参考文档的特定于模块的部分。
打开投影
projection 接口中的访问器方法还可用于使用注释计算新值，如以下示例所示：@Value
interface NamesOnly {
@Value("#{target.firstname + ' ' + target.lastname}")
String getFullName();
…
}支持投影的聚合根在变量中可用。
使用的 projection interface is an open projection.
在这种情况下，Spring Data 无法应用查询执行优化，因为 SPEL 表达式可以使用聚合根的任何属性。target@Value
中使用的表达式不应该太复杂 — 您希望避免在变量中编程。
对于非常简单的表达式，一种选择可能是使用默认方法（在 Java 8 中引入），如以下示例所示：@ValueString
interface NamesOnly {
String getFirstname();
String getLastname();
default String getFullName() {
return getFirstname().concat(" ").concat(getLastname());
}
}这种方法要求您能够完全基于 projection 接口上公开的其他访问器方法实现 logic 。 第二个更灵活的选项是在 Spring bean 中实现自定义逻辑，然后从 SPEL 表达式中调用该逻辑，如以下示例所示：
@Component
class MyBean {
String getFullName(Person person) {
…
}
}
interface NamesOnly {
@Value("#{@myBean.getFullName(target)}")
String getFullName();
…
}请注意 SPEL 表达式如何引用和调用方法，以及如何将投影目标作为方法参数转发。
由 SpEL 表达式评估支持的方法也可以使用方法参数，然后可以从表达式中引用这些参数。
方法参数可通过名为 .
以下示例演示如何从数组中获取方法参数：myBeangetFullName(…)Objectargsargs
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();
}如果基础 projection value 不是 ，则使用包装器类型的 present-representation 返回值。
如果 backing 值为 ，则 getter 方法返回所用包装器类型的空表示形式。nullnull
在 your 中声明一个覆盖基方法的方法（例如，在 、特定于存储的存储库接口或 中声明）会导致调用基方法，而不管声明的返回类型如何。
请确保使用兼容的返回类型，因为基方法不能用于投影。
某些 store 模块支持注释，以将重写的 base 方法转换为查询方法，然后可用于返回投影。RepositoryCrudRepositorySimple…Repository@Query |
基于类的投影 （DTO）
定义投影的另一种方法是使用值类型 DTO（数据传输对象），它保存应检索的字段的属性。 这些 DTO 类型的使用方式与使用投影接口的方式完全相同，只是不会发生代理，也不能应用嵌套投影。
如果存储区通过限制要加载的字段来优化查询执行，则要加载的字段将根据公开的构造函数的参数名称确定。
以下示例显示了一个投影的 DTO：
record NamesOnly(String firstname, String lastname) {
}Java 记录是定义 DTO 类型的理想选择，因为它们遵循值语义：
所有字段都是自动创建的 // 方法。
或者，您可以使用定义要投影的属性的任何类。private finalequals(…)hashCode()toString()
动态投影
到目前为止，我们已经使用 projection 类型作为集合的返回类型或元素类型。 但是，您可能希望选择要在调用时使用的类型（这使其成为动态的）。 要应用动态投影，请使用如下例所示的查询方法：
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<?> |
检查类型的查询参数是否符合动态投影参数的条件。
如果查询的实际返回类型等于参数的泛型参数类型，则匹配参数不可用于查询或 SPEL 表达式。
如果要将参数用作查询参数，请确保使用不同的泛型参数，例如 .ClassClassClassClassClass<?> |