原标题:Spring认证#spring认证#|Spring Data Commons 预测
Spring Data 查询方法通常返回存储库管理的聚合根的一个或多个实例。但是,有时可能需要根据这些类型的某些属性创建投影。Spring Data 允许对专用返回类型进行建模,以更有选择地检索托管聚合的部分视图。
想象一个存储库和聚合根类型,例如以下示例:
示例 56. 示例聚合和存储库
class Person {
@Id UUID id;
String firstname, lastname;
Address address;
static class Address {
String zipCode, city, street;
}
}
interface PersonRepository extends Repository {
Collection findByLastname(String lastname);
}
现在假设我们只想检索此人的姓名属性。Spring Data 提供什么方法来实现这一目标?本章的其余部分回答了这个问题。
5.1. 基于界面的投影
将查询结果限制为仅名称属性的最简单方法是声明一个接口,该接口公开要读取的属性的访问器方法,如以下示例所示:
示例 57. 用于检索属性子集的投影接口
interface NamesOnly {
String getFirstname();
String getLastname();
}
这里的重要一点是这里定义的属性与聚合根中的属性完全匹配。这样做可以添加一个查询方法,如下所示:
示例 58. 使用基于接口的投影和查询方法的存储库
interface PersonRepository extends Repository {
Collection findByLastname(String lastname);
}
查询执行引擎在运行时为每个返回的元素创建该接口的代理实例,并将对公开方法的调用转发到目标对象。
可以递归地使用投影。如果您还想包含一些Address信息,请为其创建一个投影接口,并从 的声明中返回该接口getAddress(),如下例所示:
示例 59. 用于检索属性子集的投影接口
interface PersonSummary {
String getFirstname();
String getLastname();
AddressSummary getAddress();
interface AddressSummary {
String getCity();
}
}
在方法调用时,address获取目标实例的属性并依次包装到投影代理中。
5.1.1. 封闭式投影
其访问器方法都与目标聚合的属性匹配的投影接口被认为是封闭投影。以下示例(我们在本章前面也使用过)是一个封闭投影:
示例 60. 闭合投影
interface NamesOnly {
String getFirstname();
String getLastname();
}
如果使用封闭投影,Spring Data 可以优化查询执行,因为我们知道支持投影代理所需的所有属性。有关更多详细信息,请参阅参考文档中特定于模块的部分。
5.1.2. 打开投影
投影接口中的访问器方法也可用于通过使用@Value注释计算新值,如以下示例所示:
例 61. 一个开放的投影
interface NamesOnly {
@Value("#")
String getFullName();
…
}
支持投影的聚合根在target变量中可用。使用的投影界面@Value是开放式投影。在这种情况下,Spring Data 无法应用查询执行优化,因为 SpEL 表达式可以使用聚合根的任何属性。
中使用的表达式@Value不应太复杂——您希望避免在String变量中编程。对于非常简单的表达式,一种选择可能是采用默认方法(在 Java 8 中引入),如以下示例所示:
示例 62. 使用自定义逻辑的默认方法的投影界面
interface NamesOnly {
String getFirstname();
String getLastname();
default String getFullName() {
return getFirstname().concat(" ").concat(getLastname());
}
}
interface NamesOnly {
String getFirstname();
String getLastname();
default String getFullName() {
return getFirstname().concat(" ").concat(getLastname());
}
}
这种方法要求您能够纯粹基于投影接口上公开的其他访问器方法来实现逻辑。第二个更灵活的选择是在 Spring bean 中实现自定义逻辑,然后从 SpEL 表达式调用它,如以下示例所示:
示例 63.示例 Person 对象
@Component
class MyBean {
String getFullName(Person person) {
…
}
}
interface NamesOnly {
@Value("#{@myBean.getFullName(target)}")
String getFullName();
…
}
示例 64. 示例 Person 对象
interface NamesOnly {
@Value("#")
String getSalutation(String prefix);
}
同样,对于更复杂的表达式,您应该使用 Spring bean 并让表达式调用一个方法,如前所述。
5.1.3. 可空包装器
投影接口中的 getter 可以使用可为空的包装器来提高空安全性。当前支持的包装器类型有:
java.util.Optional
com.google.common.base.Optional
scala.Option
io.vavr.control.Option
示例 65. 使用可为空包装器的投影接口
interface NamesOnly {
Optional getFirstname();
}
如果基础投影值不是null,则使用包装器类型的当前表示返回值。如果支持值是null,则 getter 方法返回所用包装器类型的空表示。
5.2. 基于类的预测 (DTO)
定义投影的另一种方法是使用值类型 DTO(数据传输对象),这些 DTO 包含应该检索的字段的属性。这些 DTO 类型可以以与使用投影接口完全相同的方式使用,除了不发生代理并且不可以应用嵌套投影。
如果存储通过限制要加载的字段来优化查询执行,则要加载的字段由公开的构造函数的参数名称确定。
以下示例显示了一个投影 DTO:
示例 66. 一个投影 DTO
class NamesOnly {
private final String firstname, lastname;
NamesOnly(String firstname, String lastname) {
this.firstname = firstname;
this.lastname = lastname;
}
String getFirstname() {
return this.firstname;
}
String getLastname() {
return this.lastname;
}
// equals(…) and hashCode() implementations
}
避免投影 DTO 的样板代码
您可以使用Project Lombok显着简化 DTO 的代码,它提供了一个@Value注解(不要与@Value前面的接口示例中显示的Spring 的注解混淆)。如果使用 Project Lombok 的@Value注释,之前显示的示例 DTO 将变为以下内容:
@Value
class NamesOnly {
String firstname, lastname;
}
字段是private final默认的,该类公开了一个构造函数,该构造函数接受所有字段并自动获取equals(…)和hashCode()实现方法。
5.3. 动态投影
到目前为止,我们已经使用投影类型作为集合的返回类型或元素类型。但是,您可能希望选择在调用时使用的类型(这使其成为动态的)。要应用动态投影,请使用如下例所示的查询方法:
示例 67. 使用动态投影参数的存储库
interface PersonRepository extends Repository {
Collection findByLastname(String lastname, Class type);
}
这样,该方法可用于按原样或应用投影获取聚合,如以下示例所示:
示例 68.使用具有动态投影的存储库
void someMethod(PersonRepository people) {
Collection aggregates =
people.findByLastname("Matthews", Person.class);
Collection aggregates =
people.findByLastname("Matthews", NamesOnly.class);
}
e.findByLastname("Matthews", Person.class);
Collection aggregates =
people.findByLastname("Matthews", NamesOnly.class);
}