|
对于最新的稳定版本，请使用 Spring Data Cassandra 5.0.4！ |
投影
投影
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、特定数据存储的 Repository 接口或 Simple…Repository 中声明的方法），无论声明的返回类型是什么，都会调用基础方法。
请确保使用与基础方法兼容的返回类型，因为基础方法不能用于投影（projections）。
某些数据存储模块支持使用 @Query 注解，将被覆盖的基础方法转换为查询方法，从而可用于返回投影。 |
投影可以递归使用。
如果你想同时包含一些 Address 的信息，请为该信息创建一个投影接口，并从 getAddress() 的声明中返回该接口，如下例所示：
interface PersonSummary {
String getFirstname();
String getLastname();
AddressSummary getAddress();
interface AddressSummary {
String getCity();
}
}在方法调用时，目标实例的 address 属性会被获取，并依次包装成一个投影代理。
封闭投影
一种投影接口，其所有访问器方法均与目标聚合的属性相匹配，被视为封闭投影（closed projection）。 以下示例（我们在本章前面也使用过）就是一个封闭投影：
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 表达式中调用该 Bean，如下例所示：
@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，并让表达式调用其方法，如前文所述。
可空包装器
投影接口中的 Getter 方法可以使用可空包装器（nullable wrappers）来提升空值安全性。 目前支持的包装器类型包括：
-
java.util.Optional -
com.google.common.base.Optional -
scala.Option -
io.vavr.control.Option
interface NamesOnly {
Optional<String> getFirstname();
}如果底层的投影值不为 null，则使用包装类型的“存在”表示形式返回值。
如果底层值为 null，则 getter 方法返回所用包装类型的“空”表示形式。
基于类的投影（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<?>。 |
|
使用基于类的投影（Class-based projection）时，类型必须声明一个单一的构造函数，以便 Spring Data 能够确定其输入属性。
如果你的类定义了多个构造函数，那么在没有额外提示的情况下，你将无法在 DTO 投影中使用该类型。
在这种情况下，请按照下面所示，在期望使用的构造函数上添加 |