此版本仍在开发中,尚不被认为是稳定的。对于最新的稳定版本,请使用 Spring Data Elasticsearch 5.5.2! |
弹性搜索运营
Spring Data Elasticsearch 使用多个接口来定义可以针对 Elasticsearch 索引调用的作(有关响应式接口的描述,请参阅响应式 Elasticsearch作)。
-
IndexOperations
定义索引级别的作,例如创建或删除索引。 -
DocumentOperations
定义基于实体 ID 存储、更新和检索实体的作。 -
SearchOperations
定义使用查询搜索多个实体的作 -
ElasticsearchOperations
将DocumentOperations
和SearchOperations
接口。
这些接口对应于 Elasticsearch API 的结构。
接口的默认实现提供:
-
索引管理功能。
-
对域类型的读/写映射支持。
-
丰富的查询和条件 API。
-
资源管理和异常转换。
索引管理和索引和映射的自动创建。
这 这些作都不是由 使用 Spring Data Elasticsearch 存储库时,支持自动创建索引和写入映射,请参阅使用相应映射自动创建索引 |
使用示例
该示例展示了如何使用注入的ElasticsearchOperations
实例。该示例假设Person
是一个用@Document
,@Id
等(参见映射注释概述)。
@RestController
@RequestMapping("/")
public class TestController {
private ElasticsearchOperations elasticsearchOperations;
public TestController(ElasticsearchOperations elasticsearchOperations) { (1)
this.elasticsearchOperations = elasticsearchOperations;
}
@PostMapping("/person")
public String save(@RequestBody Person person) { (2)
Person savedEntity = elasticsearchOperations.save(person);
return savedEntity.getId();
}
@GetMapping("/person/{id}")
public Person findById(@PathVariable("id") Long id) { (3)
Person person = elasticsearchOperations.get(id.toString(), Person.class);
return person;
}
}
1 | 让 Spring 注入提供的ElasticsearchOperations bean 的 bean 在构造函数中。 |
2 | 将一些实体存储在 Elasticsearch 集群中。从返回的实体中读取 id,因为它在person 对象,并由 Elasticsearch 创建。 |
3 | 检索具有 get by id 的实体。 |
要了解ElasticsearchOperations
请参阅 API 文档。
搜索结果类型
当使用DocumentOperations
接口时,将仅返回找到的实体。当使用SearchOperations
接口,则每个实体都提供了其他信息,例如找到的实体的分数或 sortValues。
为了返回此信息,每个实体都包装在SearchHit
包含此实体特定附加信息的对象。 这些SearchHit
对象本身在SearchHits
对象,该对象还包含有关整个搜索的信息,例如 maxScore 或请求的聚合或完成请求所需的执行持续时间。现在可以使用以下类和接口:
包含以下信息:
-
同上
-
得分
-
对值进行排序
-
突出显示字段
-
内部命中(这是嵌入式
SearchHits
包含最终返回的内部命中的对象) -
检索到的实体类型为 <T>
包含以下信息:
-
总点击数
-
总点击数关系
-
最高分
-
列表
SearchHit<T>
对象 -
返回的聚合
-
返回的建议结果
定义 Spring 数据Page
其中包含一个SearchHits<T>
元素,可用于使用存储库方法进行分页访问。
由ElasticsearchRestTemplate
,它丰富了SearchHits<T>
替换为 Elasticsearch 滚动 ID。
流式函数返回的迭代器SearchOperations
接口。
ReactiveSearchOperations
有返回Mono<ReactiveSearchHits<T>>
,则包含与SearchHits<T>
对象,但将提供包含的SearchHit<T>
对象作为Flux<SearchHit<T>>
而不是作为列表。
查询
几乎所有在SearchOperations
和ReactiveSearchOperations
接口采用Query
定义要执行的查询以进行搜索的参数。Query
是一个接口,Spring Data Elasticsearch 提供了三种实现:CriteriaQuery
,StringQuery
和NativeQuery
.
条件查询
CriteriaQuery
基于查询允许创建查询以搜索数据,而无需了解 Elasticsearch 查询的语法或基础知识。它们允许用户通过简单地链接和组合来构建查询Criteria
指定搜索文档必须满足的条件的对象。
在谈论 AND 或 OR 时,当组合条件时请记住,在 Elasticsearch 中,AND 被转换为 must 条件,OR 转换为 should |
Criteria
它们的用法最好通过示例来解释(假设我们有一个Book
实体,并带有price
属性):
Criteria criteria = new Criteria("price").is(42.0);
Query query = new CriteriaQuery(criteria);
同一字段的条件可以链接,它们将与逻辑 AND 组合:
Criteria criteria = new Criteria("price").greaterThan(42.0).lessThan(34.0);
Query query = new CriteriaQuery(criteria);
链接时Criteria
,默认情况下使用 AND 逻辑:
Criteria criteria = new Criteria("lastname").is("Miller") (1)
.and("firstname").is("James") (2)
Query query = new CriteriaQuery(criteria);
1 | 第一个Criteria |
2 | and() 创建一个新的Criteria 并将其链接到第一个。 |
如果要创建嵌套查询,则需要为此使用子查询。 假设我们想找到所有姓氏为 Miller 且名字为 Jack 或 John 的人:
Criteria miller = new Criteria("lastName").is("Miller") (1)
.subCriteria( (2)
new Criteria().or("firstName").is("John") (3)
.or("firstName").is("Jack") (4)
);
Query query = new CriteriaQuery(criteria);
1 | 创建第一个Criteria 对于姓氏 |
2 | 这与 AND 组合到子标准 |
3 | 此子条件是名字 John 的 OR 组合 |
4 | 和名字杰克 |
请参阅Criteria
class 以完整概述不同的可用作。
字符串查询
此类将 Elasticsearch 查询作为 JSON 字符串。 以下代码显示了一个查询,用于搜索名字为“Jack”的人:
Query query = new StringQuery("{ \"match\": { \"firstname\": { \"query\": \"Jack\" } } } ");
SearchHits<Person> searchHits = operations.search(query, Person.class);
用StringQuery
如果您已经有要使用的 Elasticsearch 查询,则可能是合适的。
原生查询
NativeQuery
是当你有一个复杂的查询,或者一个查询不能通过使用Criteria
API,例如在构建查询和使用聚合时。
它允许使用所有不同的co.elastic.clients.elasticsearch._types.query_dsl.Query
因此,Elasticsearch 库中的实现被命名为“native”。
以下代码显示了如何使用给定的firstName
对于找到的文档,有一个术语聚合,用于计算lastName
对于这些人:
Query query = NativeQuery.builder()
.withAggregation("lastNames", Aggregation.of(a -> a
.terms(ta -> ta.field("lastName").size(10))))
.withQuery(q -> q
.match(m -> m
.field("firstName")
.query(firstName)
)
)
.withPageable(pageable)
.build();
SearchHits<Person> searchHits = operations.search(query, Person.class);
搜索模板查询
这是Query
与存储的搜索模板结合使用的界面。
有关详细信息,请参阅搜索模板支持。