|
该版本仍在开发中，尚未被视为稳定。对于最新稳定版本，请使用Spring Data Elasticsearch 5.5.5！ |
定义查询方法
仓库代理有两种方式可以从方法名称推导出存储专属查询：
-
通过直接从方法名称推导查询。
-
通过手动定义的查询。
可选的选项取决于具体的商店。 然而，必须有一套策略来决定实际创建的查询内容。 下一节介绍可用的选项。
查询查询策略
存储库基础设施可用以下策略来解决查询。
通过XML配置，你可以在命名空间通过查询-查找-策略属性。
对于 Java 配置，你可以使用queryLookupStrategy属性EnableElasticsearchRepositories注解。
某些策略可能不支持特定数据存储。
-
创造尝试从查询方法名称构建一个存储特定的查询。 一般做法是从方法名称中移除一组已知前缀，然后解析方法的其余部分。 你可以在“查询创建”中了解更多关于查询构建的内容。 -
USE_DECLARED_QUERY尝试寻找声明的查询，如果找不到则抛出异常。 查询可以通过某处的注释定义，也可以通过其他方式声明。 请参阅该门店的说明文件，了解该门店可用的选项。 如果仓库基础设施在引导时找不到该方法的声明查询，则该方法失败。 -
CREATE_IF_NOT_FOUND（默认）组合创造和USE_DECLARED_QUERY. 它首先查找已声明的查询，如果未找到声明查询，则创建基于方法名称的自定义查询。 这是默认的查找策略，因此如果你没有显式配置，就会使用。 它允许通过方法名称快速定义查询，同时也可以通过根据需要引入声明查询来自定义调优这些查询。
查询创建
Spring Data 存储库基础设施中内置的查询构建机制对于构建对存储库实体的约束查询非常有用。
以下示例展示了如何创建多个查询：
interface PersonRepository extends Repository<Person, Long> {
List<Person> findByEmailAddressAndLastname(EmailAddress emailAddress, String lastname);
// Enables the distinct flag for the query
List<Person> findDistinctPeopleByLastnameOrFirstname(String lastname, String firstname);
List<Person> findPeopleDistinctByLastnameOrFirstname(String lastname, String firstname);
// Enabling ignoring case for an individual property
List<Person> findByLastnameIgnoreCase(String lastname);
// Enabling ignoring case for all suitable properties
List<Person> findByLastnameAndFirstnameAllIgnoreCase(String lastname, String firstname);
// Enabling static ORDER BY for a query
List<Person> findByLastnameOrderByFirstnameAsc(String lastname);
List<Person> findByLastnameOrderByFirstnameDesc(String lastname);
}解析查询方法名称分为主语和谓词。第一部分（找到。。。 由,存在。。。 由）定义查询的主语，后半部分构成谓词。引入子句（主语）可以包含更多表达式。任意文本之间找到（或其他引入关键词）以及由除非使用限制结果的关键词之一，如不同在要创建的查询上设置一个不同的标志，或者返回页首/第一限制查询结果.
附录包含查询方法主语和谓词关键词的完整列表，包括排序和字母大小写修饰符。然而，由作为分隔符，指示实际条件谓词的起始。在非常基础的层面上，你可以定义实体属性的条件，并将其与和和或.
解析方法的实际结果取决于你创建查询的持久存储。不过，有一些一般性需要注意：
-
这些表达式通常是属性遍历和可串接的算子结合。你可以将属性表达式与
和和或. 你还会得到支持像之间,LessThan,伟大超越和喜欢对于属性表达式。支持的运算符可能因数据存储而异，因此请参考参考文档中的相应部分。 -
方法解析器支持设置
忽略Case为单个属性设置旗帜（例如，findByLastnameIgnoreCase（...））或对所有支持忽略情况的类型性质（通常如此）字符串实例——例如，查找ByLastname和Firstname全部忽略Case（...）). 是否支持忽略案例可能因商店而异，因此请查阅参考文档中相关商店特定查询方法的章节。 -
你可以通过附加一个
OrderBy通过提供排序方向（升天或描述). 要创建支持动态排序的查询方法，请参见“分页、迭代大型结果、排序与限制”。
保留方法名称
虽然派生仓库方法通过名称绑定属性，但在针对标识符属性的某些方法名称中，从基仓库继承的方法名称存在一些例外。这些保留方法如CrudRepository#findById（或者只是findById）无论声明方法中使用的实际属性名称如何，都指向标识符属性。
考虑以下域类型，包含一个属性PK标记为标识符，通过以下方式@Id以及一个称为身份证. 在这种情况下，你需要特别注意查找方法的命名，因为它们可能会与预定义的签名发生冲突：
class User {
@Id Long pk; (1)
Long id; (2)
// …
}
interface UserRepository extends Repository<User, Long> {
Optional<User> findById(Long id); (3)
Optional<User> findByPk(Long pk); (4)
Optional<User> findUserById(Long id); (5)
}| 1 | 标识符属性（主键）。 |
| 2 | 一个名为身份证但不是标识符。 |
| 3 | 目标PK属性（标记为@Id这被视为标识符），因为它指的是原油仓库基础仓库方法。因此，它不是使用 的派生查询。身份证正如房产名称所示，因为它是保留方法之一。 |
| 4 | 目标PK属性名称，因为它是一个派生查询。 |
| 5 | 目标身份证通过使用描述Tokens在找到和由以避免与保留方式的碰撞。 |
这种特殊行为不仅针对查找方法，也适用于出口和删除的。 请参阅“仓库查询关键词”以获取方法列表。
性质表达式
属性表达式只能指代被管理实体的直接属性，如前例所示。在查询创建时，你已经确保解析后的属性是托管域类的属性。不过，你也可以通过遍历嵌套属性来定义约束。考虑以下方法签名：
List<Person> findByAddressZipCode(ZipCode zipCode);假设人有地址其中邮政编码. 在这种情况下，该方法生成x.地址.zipCode（邮编）性质遍历。解析算法首先解释整个部分（地址邮政编码）作为该属性，并检查域类中是否有该名称（未大写）的属性。
如果算法成功，它就会利用该性质。
如果不行，算法会将骆驼壳部分的源从右侧拆分为正面和尾部，并尝试找到相应的性质——在我们的例子中，地址邮编和法典.
如果算法找到带有该中心的属性，它会取尾部并继续向下构建树，并按照刚才描述的方式将尾部拆分。
如果第一个分裂不匹配，算法会将分裂点向左移动（地址,邮政编码）并继续。
虽然这在大多数情况下是可行的，但算法仍有可能选择错误的性质。
假设人类有地址邮编财产也一样。
算法在第一轮分流时就已经匹配，选择错误的性质，导致失败（作为地址邮编大概没有法典财产）。
为了解决这种歧义，你可以在方法名内手动定义遍历点。
所以我们的方法名称如下：_
List<Person> findByAddress_ZipCode(ZipCode zipCode);|
由于我们将下划线（）视为保留字符，强烈建议遵循标准的Java命名规范（即在属性名称中不使用下划线，而是应用骆驼大小写）。 |
|
场地名称以下划线开头：
字段名称可能以下划线开头，如 大写字段名称：
所有大写的字段名称都可以作为大写字母使用。
嵌套路径（如适用）需要通过分割，如 字段名称含第二个大写字母：
字段名称由一个开头的小写字母跟一个大写字母组成，如 路径模糊性：
以下示例中性质的排列 由于先考虑性质上的直接匹配，任何潜在嵌套路径都不会被考虑，算法会选择 |
存储库方法返回集合或迭代
返回多个结果的查询方法可以使用标准 Java可迭代,列表和设置.
除此之外，我们支持回归春季数据可流媒体，是 的自定义扩展可迭代以及Vavr提供的收集类型。
请参阅附录，解释所有可能的查询方法返回类型。
使用 Streamable 作为查询方法返回类型
你可以使用可流媒体作为替代可迭代或者任何类型的集合。
它提供了便捷的方法来访问非并行的流（缺失于可迭代）以及直接......滤网（......）和......地图（......）对元素进行连接可流媒体致他人：
interface PersonRepository extends Repository<Person, Long> {
Streamable<Person> findByFirstnameContaining(String firstname);
Streamable<Person> findByLastnameContaining(String lastname);
}
Streamable<Person> result = repository.findByFirstnameContaining("av")
.and(repository.findByLastnameContaining("ea"));返回自定义可流媒体包装类型
为集合提供专用的包装类型是一种常用的模式，用于为返回多个元素的查询结果提供 API。 通常，这些类型通过调用仓库方法返回类似集合的类型，并手动创建包装类型的实例来实现。 你可以避免这一额外步骤，因为 Spring Data 允许你将这些封装类型用作查询方法的返回类型，前提是满足以下条件：
-
类型实现
可流媒体. -
该类型暴露一个构造函数或名为
（...）或valueOf（...）该可流媒体作为论点。
以下列表展示了一个示例：
class Product { (1)
MonetaryAmount getPrice() { … }
}
@RequiredArgsConstructor(staticName = "of")
class Products implements Streamable<Product> { (2)
private final Streamable<Product> streamable;
public MonetaryAmount getTotal() { (3)
return streamable.stream()
.map(Product::getPrice)
.reduce(Money.of(0), MonetaryAmount::add);
}
@Override
public Iterator<Product> iterator() { (4)
return streamable.iterator();
}
}
interface ProductRepository implements Repository<Product, Long> {
Products findAllByDescriptionContaining(String text); (5)
}| 1 | 一个产品该实体通过API访问产品价格。 |
| 2 | 一个封装类型用于Streamable<Product>可以通过以下方式构造Products.of（...）（工厂方法创建，使用龙目标注）。
一个标准构造函数，取Streamable<Product>我也会的。 |
| 3 | 包装类型会暴露一个额外的API，计算新的值Streamable<Product>. |
| 4 | 实现可流媒体界面并委派到实际结果。 |
| 5 | 那种包装类型产品可以直接用作查询方法的返回类型。
你不需要回去Streamable<Product>查询后在仓库客户端手动包装。 |
支持Vavr收藏
Vavr 是一个包含 Java 函数式编程概念的库。 它自带一套自定义的集合类型，你可以用作查询方法的返回类型，如下表所示：
| Vavr 收集类型 | 使用的Vavr实现类型 | 有效的 Java 源代码类型 |
|---|---|---|
|
|
|
|
|
|
|
|
|
你可以使用第一列（或其子类型）作为查询方法的返回类型，第二列的类型作为实现类型，具体取决于实际查询结果（第三列）的 Java 类型。
或者，你也可以申报可通行（瓦夫尔可迭代等价），然后我们从实际返回值推导实现类。
也就是说，一个java.util.List变成了Vavr列表或序列一个java.util.Set成为一名VavrLinkedHashSet 设置，依此类推。
流式查询结果
你可以用Java 8增量处理查询方法的结果Stream<T>作为返回类型。
查询不是包裹，而是生成流，采用数据存储专用方法进行流式传输，如下示例所示：
Stream<T>@Query("select u from User u")
Stream<User> findAllByCustomQueryAndStream();
Stream<User> readAllByFirstnameNotNull();
@Query("select u from User u")
Stream<User> streamAllPaged(Pageable pageable);一个流可能会包裹底层数据存储的特定资源，因此必须在使用后关闭。
你可以手动关闭流通过使用接近（）方法或使用 Java 7资源尝试块，如下例所示： |
Stream<T>结果为资源尝试块try (Stream<User> stream = repository.findAllByCustomQueryAndStream()) {
stream.forEach(…);
}并非所有 Spring Data 模块目前都支持Stream<T>作为返回类型。 |
异步查询结果
你可以通过使用 Spring 的异步方法运行功能，异步运行仓库查询。
这意味着方法在调用时立即返回，而实际查询发生在已提交给 Spring 的任务中任务执行者.
异步查询不同于响应式查询，不应混合使用。
有关被动支持的更多细节，请参见门店专用文档。
以下示例展示了若干异步查询：
@Async
Future<User> findByFirstname(String firstname); (1)
@Async
CompletableFuture<User> findOneByFirstname(String firstname); (2)| 1 | 用java.util.concurrent.Future作为返回类型。 |
| 2 | 用Java 8java.util.concurrent.CompletableFuture作为返回类型。 |
分页、大结果迭代、排序与限制
要处理查询中的参数，请如前述示例中所述定义方法参数。
除此之外，基础设施还识别某些特定类型，比如可页面,排序和限制， 以动态方式应用分码、排序和限制。
以下示例展示了这些特性：
可页面,片,排序和限制在查询方法中Page<User> findByLastname(String lastname, Pageable pageable);
Slice<User> findByLastname(String lastname, Pageable pageable);
List<User> findByLastname(String lastname, Sort sort);
List<User> findByLastname(String lastname, Sort sort, Limit limit);
List<User> findByLastname(String lastname, Pageable pageable);API 接受排序,可页面和限制期待非——零这些值被赋予方法。
如果你不想应用任何排序或分页，可以用排序。未排序（）,Pageable.unpaged（）和Limit.unlimited（）. |
第一种方法是通过一个org.springframework.data.domain.Pageable实例映射到查询方法，动态地为你的静态定义查询添加分页。
一个页知道可用元素和页面的总数。
这通过基础设施触发计数查询来计算总数。
因为这可能很贵（取决于你用的店铺），你可以选择退货片.
一个片只知道下一个是否片可用，这在处理较大的结果集时可能足够。
排序选项通过可页面也一样。
如果你只需要排序，可以添加一个org.springframework.data.domain.Sort你方法的参数。
如你所见，返回列表也有可能。
在这种情况下，构建实际 所需的额外元数据页实例未被创建（这反过来意味着本应需要的额外计数查询未被发出）。
相反，它限制查询只能查找给定的实体范围。
| 要知道整个查询能得到多少页，你需要触发一个额外的计数查询。 默认情况下，这个查询是从你实际触发的查询推导出来的。 |
|
特殊参数在查询方法中只能使用一次。上述
这 |
哪种方法合适？
Spring Data 抽象提供的值或许可以通过下表中列出的可能查询方法返回类型来最好地展示。 表格显示了查询方法可以返回哪些类型
| 方法 | 获取的数据量 | 查询结构 | 约束 |
|---|---|---|---|
所有结果都是如此。 |
单查询。 |
查询结果可能会耗尽所有内存。获取所有数据可能耗时。 |
|
所有结果都是如此。 |
单查询。 |
查询结果可能会耗尽所有内存。获取所有数据可能耗时。 |
|
分块（逐个或批量分批）取决于 |
通常只用光标进行单查询。 |
使用后必须关闭流，以避免资源泄漏。 |
|
|
分块（逐个或批量分批）取决于 |
通常只用光标进行单查询。 |
存储模块必须提供响应式基础设施。 |
|
|
一到多查询，获取从以下开始的数据。 |
一个
|
|
|
一至多查询，从以下开始 |
很多时候，
|
分页与排序
你可以通过使用属性名称来定义简单的排序表达式。 你可以将表达式串接起来，将多个标准汇集成一个表达式。
Sort sort = Sort.by("firstname").ascending()
.and(Sort.by("lastname").descending());为了更安全类型地定义排序表达式，可以先确定定义排序表达式的类型，并使用方法引用定义排序的属性。
TypedSort<Person> person = Sort.sort(Person.class);
Sort sort = person.by(Person::getFirstname).ascending()
.and(person.by(Person::getLastname).descending());
TypedSort.by（...）通常通过使用 CGlib 来使用运行时代理，这可能会干扰使用 Graal VM Native 等工具时的本地图像编译。 |
如果你的存储实现支持 Querydsl，你也可以使用生成的元模型类型来定义排序表达式：
QSort sort = QSort.by(QPerson.firstname.asc())
.and(QSort.by(QPerson.lastname.desc()));限制查询结果
除了分页外，还可以使用专用的限制参数。
你还可以通过使用第一或返回页首关键词，你可以互换使用，但不能与限制参数。
你可以在返回页首或第一指定返回的最大结果大小。
如果省略该数字，则假设结果大小为1。
以下示例展示了如何限制查询大小：
返回页首和第一List<User> findByLastname(String lastname, Limit limit);
User findFirstByOrderByLastnameAsc();
User findTopByLastnameOrderByAgeDesc(String lastname);
Page<User> queryFirst10ByLastname(String lastname, Pageable pageable);
Slice<User> findTop3By(Pageable pageable);
List<User> findFirst10ByLastname(String lastname, Sort sort);
List<User> findTop10ByLastname(String lastname, Pageable pageable);极限表达式也支持不同关键词是支持不同查询的数据存储。
此外，对于将结果集限制为一个实例的查询，将结果包裹到自选支持关键词。
如果对极限查询分码（以及可用页数的计算）应用分页或切片，则会在有限结果内应用。
结合动态排序限制结果，使用一个排序参数允许你表达最小元素K和最大元素K的查询方法。 |