投影
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 表达式中调用它,如下例所示:
@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:
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;
}
// ...
}