|
此版本仍在开发中，尚未被视为稳定版本。对于最新的稳定版本，请使用 Spring Data Elasticsearch 5.4.0！ |
查询方法
查询查找策略
Elasticsearch 模块支持所有基本的查询构建功能，如字符串查询、原生搜索查询、基于条件的查询，或者从方法名称派生。
声明的查询
从方法名称派生查询并不总是足够的，并且/或可能导致方法名称不可读。
在这种情况下，可以使用注释（请参阅 使用 @Query Comments ）。@Query
查询创建
通常，Elasticsearch 的查询创建机制的工作方式如 定义查询方法. 下面是一个简短的示例，说明了 Elasticsearch 查询方法的转换方式：
interface BookRepository extends Repository<Book, String> {
List<Book> findByNameAndPrice(String name, Integer price);
}上面的方法名称将转换为以下 Elasticsearch json 查询
{
"query": {
"bool" : {
"must" : [
{ "query_string" : { "query" : "?", "fields" : [ "name" ] } },
{ "query_string" : { "query" : "?", "fields" : [ "price" ] } }
]
}
}
}Elasticsearch 支持的关键字列表如下所示。
| 关键词 | 样本 | Elasticsearch 查询字符串 |
|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
不支持用于构建采用参数的 Geo-shape 查询的方法名称。
如果您需要在存储库中使用此类函数，请在自定义存储库实现中使用 with。GeoJsonElasticsearchOperationsCriteriaQuery |
方法返回类型
可以将存储库方法定义为具有以下返回类型，用于返回多个 Element：
-
List<T> -
Stream<T> -
SearchHits<T> -
List<SearchHit<T>> -
Stream<SearchHit<T>> -
SearchPage<T>
使用 @Query 注释
@Query传递给该方法的参数可以插入到查询字符串的占位符中。占位符的格式为 ， ， 等，用于第一个、第二个、第三个参数等。?0?1?2
interface BookRepository extends ElasticsearchRepository<Book, String> {
@Query("{\"match\": {\"name\": {\"query\": \"?0\"}}}")
Page<Book> findByName(String name,Pageable pageable);
}设置为 annotation 参数的 String 必须是有效的 Elasticsearch JSON 查询。 它将作为 query 元素的值发送到 Easticsearch;例如，如果使用参数 John 调用函数，它将生成以下查询正文：
{
"query": {
"match": {
"name": {
"query": "John"
}
}
}
}@Query存储库方法（如
@Query("{\"ids\": {\"values\": ?0 }}")
List<SampleEntity> getByIds(Collection<String> ids);将进行 IDs 查询以返回所有匹配的文档。因此，使用 of 调用该方法将生成查询正文List["id1", "id2", "id3"]
{
"query": {
"ids": {
"values": ["id1", "id2", "id3"]
}
}
}使用 SPEL 表达式
@Query在 中定义查询时，也支持 SPEL 表达式。@Query
interface BookRepository extends ElasticsearchRepository<Book, String> {
@Query("""
{
"bool":{
"must":[
{
"term":{
"name": "#{#name}"
}
}
]
}
}
""")
Page<Book> findByName(String name, Pageable pageable);
}例如，如果使用参数 John 调用函数，它将生成以下查询正文：
{
"bool":{
"must":[
{
"term":{
"name": "John"
}
}
]
}
}假设我们有以下类作为查询参数类型：
public record QueryParameter(String value) {
}通过符号访问参数很容易，然后用一个简单的 ：#value.
interface BookRepository extends ElasticsearchRepository<Book, String> {
@Query("""
{
"bool":{
"must":[
{
"term":{
"name": "#{#parameter.value}"
}
}
]
}
}
""")
Page<Book> findByName(QueryParameter parameter, Pageable pageable);
}我们现在可以作为参数传递，它将生成与上述相同的查询字符串。new QueryParameter("John")
还支持访问 Bean 属性。假设有一个名为 type 的 bean，我们可以使用 symbol 而不是 来访问 bean，并且不需要在查询方法中声明 type 的参数：queryParameterQueryParameter@#QueryParameter
interface BookRepository extends ElasticsearchRepository<Book, String> {
@Query("""
{
"bool":{
"must":[
{
"term":{
"name": "#{@queryParameter.value}"
}
}
]
}
}
""")
Page<Book> findByName(Pageable pageable);
}CollectionCollectionparameter 也受支持，并且与 Normal 一样易于使用，例如以下查询：Stringterms
interface BookRepository extends ElasticsearchRepository<Book, String> {
@Query("""
{
"bool":{
"must":[
{
"terms":{
"name": #{#names}
}
}
]
}
}
""")
Page<Book> findByName(Collection<String> names, Pageable pageable);
}| 声明 Elasticsearch JSON 查询时，不应引用集合值。 |
like 的集合将生成以下 terms 查询：namesList.of("name1", "name2")
{
"bool":{
"must":[
{
"terms":{
"name": ["name1", "name2"]
}
}
]
}
}Collection当参数中的值不是普通的时， SpEL Collection Projection 使用起来很方便：CollectionString
interface BookRepository extends ElasticsearchRepository<Book, String> {
@Query("""
{
"bool":{
"must":[
{
"terms":{
"name": #{#parameters.![value]}
}
}
]
}
}
""")
Page<Book> findByName(Collection<QueryParameter> parameters, Pageable pageable);
}这会将所有属性值提取为 new from collection，因此具有与上述相同的效果。valueCollectionQueryParameter
@Param当通过 SpEL 访问参数时，通过在 Sping Data 中通过 annotation 将参数名称更改为另一个参数名称也很有用：@Param
interface BookRepository extends ElasticsearchRepository<Book, String> {
@Query("""
{
"bool":{
"must":[
{
"terms":{
"name": #{#another.![value]}
}
}
]
}
}
""")
Page<Book> findByName(@Param("another") Collection<QueryParameter> parameters, Pageable pageable);
}