投影
投影
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();
}
如果你使用封闭投影(closed projection),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 表达式求值支持的方法也可以使用方法参数,然后可以在表达式中引用这些参数。方法参数通过一个名为 args
的 Object
数组提供。以下示例展示了如何从 args
数组中获取方法参数:
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 方法返回所用包装类型的空表示形式。
基于类的投影 (DTOs)
另一种定义投影的方法是使用值类型 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);
}
这样,该方法可以用来直接获取聚合结果,或者在应用投影后获取,如下例所示:
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<?>
。
在使用基于类的投影时,类型必须声明一个单一的构造函数,以便 Spring Data 能够确定其输入属性。如果你的类定义了多个构造函数,那么在没有进一步提示的情况下,你不能将该类型用于 DTO 投影。在这种情况下,请按照以下方式使用 @PersistenceCreator
注解标记所需的构造函数,以便 Spring Data 能够确定要选择的属性:
public class NamesOnly {
private final String firstname;
private final String lastname;
protected NamesOnly() { }
@PersistenceCreator
public NamesOnly(String firstname, String lastname) {
this.firstname = firstname;
this.lastname = lastname;
}
// ...
}