预测

介绍

Spring Data 查询方法通常返回由仓库管理的聚合根的一个或多个实例。 然而,有时基于这些类型某些属性来创建预测是更理想的。 Spring Data 允许建模专用返回类型,以更有选择地检索受管理聚合的部分视图。spring-doc.cadn.net.cn

想象一个仓库和聚合根类型,如下示例:spring-doc.cadn.net.cn

示例聚合与存储库
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 提供了哪些实现这一目标的方法? 本章的其余部分将回答这个问题。spring-doc.cadn.net.cn

投影类型是存在于实体类型层级之外的类型。 实体实现的超类和接口位于类型层级内,因此返回超类型(或实现接口)会返回完全实体化实体的实例。

基于接口的投影

限制查询结果仅包含名称属性的最简单方法是声明一个接口,暴露访问器方法以供读取属性,如下示例所示:spring-doc.cadn.net.cn

用于检索属性子集的投影接口
interface NamesOnly {

  String getFirstname();
  String getLastname();
}

这里重要的是,这里定义的性质与总汇根中的性质完全匹配。 这样做可以添加如下查询方法:spring-doc.cadn.net.cn

一个基于接口的投影和查询方法的仓库
interface PersonRepository extends Repository<Person, UUID> {

  Collection<NamesOnly> findByLastname(String lastname);
}

查询执行引擎会在运行时为每个返回的元素创建该接口的代理实例,并将调用给暴露的方法转发到目标对象。spring-doc.cadn.net.cn

在你的存储 库该方法覆盖了基础方法(例如在 中声明原油仓库, 存储专用存储库接口,或简单。。。存储 库无论声明的返回类型如何,都会调用基方法。 确保使用兼容的返回类型,因为基础方法无法用于投影。 部分存储模块支持@Query注释将覆盖的基础方法转换为查询方法,从而返回投影。

投影可以递归使用。 如果你想包括一些地址信息也要为它创建一个投影接口,并从声明中返回该接口getAddress()如下例所示:spring-doc.cadn.net.cn

用于检索属性子集的投影接口
interface PersonSummary {

  String getFirstname();
  String getLastname();
  AddressSummary getAddress();

  interface AddressSummary {
    String getCity();
  }
}

在方法调用时,地址目标实例的属性被获取并再包裹进投影代理中。spring-doc.cadn.net.cn

封闭投影

所有访问方法都匹配目标聚合属性的投影接口被视为封闭投影。 以下示例(我们本章前半部分也用过)是一个闭投影:spring-doc.cadn.net.cn

闭投影
interface NamesOnly {

  String getFirstname();
  String getLastname();
}

如果你使用封闭投影,Spring Data 可以优化查询执行,因为我们知道支持投影代理所需的所有属性。 更多细节请参见参考文档中模块专属部分。spring-doc.cadn.net.cn

开放投影

投影接口中的访问器方法也可以通过使用@Value注释,如下示例所示:spring-doc.cadn.net.cn

开放投影
interface NamesOnly {

  @Value("#{target.firstname + ' ' + target.lastname}")
  String getFullName();
  …
}

支持投影的聚合根可以在目标变量。 一种投影接口@Value是一个开投影。 在这种情况下,Spring Data 无法应用查询执行优化,因为 SpEL 表达式可以使用聚合根的任何属性。spring-doc.cadn.net.cn

中使用的表达式@Value不应该太复杂——你想避免编程字符串变量。 对于非常简单的表达式,一种选择可能是采用默认方法(Java 8引入),如下示例所示:spring-doc.cadn.net.cn

使用默认自定义逻辑方法的投影接口
interface NamesOnly {

  String getFirstname();
  String getLastname();

  default String getFullName() {
    return getFirstname().concat(" ").concat(getLastname());
  }
}

这种方法要求你能够完全基于投影接口上暴露的其他访问器方法实现逻辑。 第二个更灵活的选项是在 Spring Bean 中实现自定义逻辑,然后从 SpEL 表达式调用该逻辑,如下示例所示:spring-doc.cadn.net.cn

示例人物对象
@Component
class MyBean {

  String getFullName(Person person) {
    …
  }
}

interface NamesOnly {

  @Value("#{@myBean.getFullName(target)}")
  String getFullName();
  …
}

注意SpEL表达式如何指代我的豆子并引用getFullName(...)方法,并将投影目标作为方法参数前发。 支持 SpEL 表达式评估的方法也可以使用方法参数,然后从表达式中引用这些参数。 方法参数可通过以下方式获得对象数组命名为args. 以下示例展示了如何从args数组:spring-doc.cadn.net.cn

示例人物对象
interface NamesOnly {

  @Value("#{args[0] + ' ' + target.firstname + '!'}")
  String getSalutation(String prefix);
}

同样,对于更复杂的表达式,你应该使用Spring Bean,并让表达式调用一个方法,就像前面描述的那样。spring-doc.cadn.net.cn

可废包装器

投影接口中的采集器可以使用可空包装器以提高空安全性。 目前支持的包装类型有:spring-doc.cadn.net.cn

使用可空包装器的投影接口
interface NamesOnly {

  Optional<String> getFirstname();
}

如果标的投影值不是然后,使用包装类型现在表示返回值。 如果支持值为然后getter方法返回所用包装类型的空表示。spring-doc.cadn.net.cn

基于类别的投影(DTO)

另一种定义投影的方法是使用价值类型DTO(数据传输对象),这些对象包含应检索字段的属性。 这些DTO类型可以与投影接口完全相同,只是不进行代理,也不能应用嵌套投影。spring-doc.cadn.net.cn

如果存储通过限制加载字段来优化查询执行,则加载字段是根据所暴露构造函数的参数名称确定的。spring-doc.cadn.net.cn

下例展示了投影的DTO:spring-doc.cadn.net.cn

投影DTO
record NamesOnly(String firstname, String lastname) {
}

Java 记录非常适合定义 DTO 类型,因为它们遵循值语义: 所有场私人决赛等于(...)/hashCode()/toString()方法会自动创建。 或者,你也可以使用任何定义你想投影属性的类。spring-doc.cadn.net.cn

动态投影

到目前为止,我们使用投影类型作为集合的返回类型或元素类型。 不过,你可能想选择在调用时使用的类型(这样会让它变得动态)。 要应用动态投影,可以使用如下示例所示的查询方法:spring-doc.cadn.net.cn

一个使用动态投影参数的仓库
interface PersonRepository extends Repository<Person, UUID> {

  <T> Collection<T> findByLastname(String lastname, Class<T> type);
}

通过这种方式,该方法可以直接获得聚合体,也可以应用投影,如下例所示:spring-doc.cadn.net.cn

使用带有动态投影的仓库
void someMethod(PersonRepository people) {

  Collection<Person> aggregates =
    people.findByLastname("Matthews", Person.class);

  Collection<NamesOnly> aggregates =
    people.findByLastname("Matthews", NamesOnly.class);
}
查询参数 类型检查它们是否符合动态投影参数的条件。 如果查询的实际返回类型等于参数,然后匹配参数无法用于查询或 SpEL 表达式。 如果你想使用参数作为查询参数,然后确保使用不同的通用参数,例如。班级是<?>.

使用基于类的投影时,类型必须声明一个构造函数,以便 Spring Data 能够确定其输入属性。 如果你的类定义了多个构造函数,那么你不能在没有进一步提示的情况下使用该类型。 在这种情况下,用 来注释所需的构造子@PersistenceCreator如下所述,以便 Spring Data 决定应选择哪些属性:spring-doc.cadn.net.cn

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;
  }

  // ...
}

使用 JPA 投影

你可以用投影和JPA来使用多种方式。 根据技巧和查询类型,你需要应用具体的考虑因素。spring-doc.cadn.net.cn

JPA通常使用的春季数据用于构建基于接口投影的接口代理的查询。spring-doc.cadn.net.cn

派生查询

查询推导支持基于类的投影和接口投影,通过内省返回类型。 基于类的投影使用JPA的实例化机制(构造表达式)来创建投影实例。spring-doc.cadn.net.cn

预测限制选择范围为目标实体的顶层属性。 任何解析为连接的嵌套属性都选择整个嵌套属性,从而实现完整的连接。spring-doc.cadn.net.cn

基于字符串的查询

基于字符串的查询支持,包括JPQL查询(@Query)和本地查询(@NativeQuery).spring-doc.cadn.net.cn

JPQL 查询

JPA 用 JPQL 返回基于类的投影的机制是构造表达式。 因此,你的查询必须定义一个构造表达式,例如:从用户 u 选择 new com.example.NamesOnly(u.firstname, u.lastname). (注意DTO 类型使用了FQDN!)该JPQL表达式可用于@Query还有注释,定义任何命名查询。 作为一个变通方法,你可以使用命名查询,且结果集映射或者休眠者专用的ResultListTransformer.spring-doc.cadn.net.cn

如果查询选择主实体或部分项列表,Spring Data JPA可以帮助将查询重写为构造表达式。spring-doc.cadn.net.cn

DTO 投影 JPQL 查询重写

JPQL 查询允许通过构造表达式选择根对象、单个属性和 DTO 对象。 使用构造表达式会迅速给查询添加大量文本,使实际查询难以阅读。 Spring Data JPA 可以通过引入构造表达式来支持你的 JPQL 查询,方便你。spring-doc.cadn.net.cn

请考虑以下问题:spring-doc.cadn.net.cn

例子1。投影查询
interface UserRepository extends Repository<User, Long> {

  @Query("SELECT u FROM USER u WHERE u.lastname = :lastname")                       (1)
  List<UserDto> findByLastname(String lastname);

  @Query("SELECT u.firstname, u.lastname FROM USER u WHERE u.lastname = :lastname") (2)
  List<UserDto> findMultipleColumnsByLastname(String lastname);
}

record UserDto(String firstname, String lastname){}
1 选择最高层实体。 该查询被重写为SELECT new UserDto(u.firstname, u.lastname) FROM USER u WHERE u.lastname = :lastname.
2 多重选择名称姓氏性能。 该查询被重写为SELECT new UserDto(u.firstname, u.lastname) FROM USER u WHERE u.lastname = :lastname.

JPQL 构造表达式不得包含选定列的别名,查询重写也不会帮你移除这些别名。 而SELECT u 作为用户,count(u.roles) 作为 roleCount FROM USER u ...是基于接口的投影查询,依赖返回的列名,当请求DTO时,同样的构造无效SELECT u, count(u.roles) 来自用户u ....
有些持久化服务商对此比较宽容,有些则不然。
spring-doc.cadn.net.cn

返回DTO投影类型(域类型层级外的Java类型)的仓库查询方法可被查询重写。 如果@Query-注释查询已经使用构造表达式,然后 Spring Data 会退缩,不应用 DTO 构造表达式重写。spring-doc.cadn.net.cn

确保你的DTO类型为投影提供全args构造器,否则查询会失败。spring-doc.cadn.net.cn

原生查询

使用基于类的投影时,根据你的情况需要稍加考虑:spring-doc.cadn.net.cn

  • 如果结果类型的属性直接映射到结果(列的顺序和类型与构造函数参数一致),那么你可以将查询结果类型声明为DTO,无需额外提示(或者通过动态投影使用DTO类)。spring-doc.cadn.net.cn

  • 如果属性不匹配或需要变换,则使用@SqlResultSetMapping通过JPA的注释,将结果集映射到DTO并提供结果映射名称,通过@NativeQuery(resultSetMapping = “...”).spring-doc.cadn.net.cn