从 3.2.x 升级到 4.0.x
本节介绍从版本 3.2.x 到 4.0.x 的重大更改,以及如何将已删除的功能替换为新引入的功能。
移除使用过的 Jackson Mapper
版本 4.0.x 中的一个变化是 Spring Data Elasticsearch 不再使用 Jackson Mapper 将实体映射到 Elasticsearch 所需的 JSON 表示形式(参见 Elasticsearch 对象映射)。
在版本 3.2.x 中,Jackson Mapper 是使用的默认版本。
可以通过显式配置(元模型对象映射)切换到基于元模型的转换器(命名)。ElasticsearchEntityMapper
在 4.0.x 版本中,基于元模型的转换器是唯一可用的转换器,不需要显式配置。 如果你有一个自定义配置来启用元模型转换器,通过提供这样的 bean:
@Bean
@Override
public EntityMapper entityMapper() {
ElasticsearchEntityMapper entityMapper = new ElasticsearchEntityMapper(
elasticsearchMappingContext(), new DefaultConversionService()
);
entityMapper.setConversions(elasticsearchCustomConversions());
return entityMapper;
}
您现在必须删除此 bean,该接口已被删除。ElasticsearchEntityMapper
一些用户在实体类上具有自定义 Jackson 注释,例如,为了在 Elasticsearch 中为映射文档定义自定义名称或配置日期转换。
这些不再被考虑在内。
现在,Spring Data Elasticsearch 的 annotation 提供了所需的功能。
有关详细信息,请参阅映射注释概述。@Field
从查询对象中删除隐式索引名称
在 3.2.x 中,不同的查询类 like 或 has 属性采用它们所操作的索引名称或索引名称。如果未设置这些值,则检查传入的实体以检索在注释中设置的索引名称。
在 4.0.x 中,索引名称现在必须在 type 的附加参数中提供。通过分离这一点,现在可以对不同的索引使用一个 query 对象。IndexQuery
SearchQuery
@Document
IndexCoordinates
例如以下代码:
IndexQuery indexQuery = new IndexQueryBuilder()
.withId(person.getId().toString())
.withObject(person)
.build();
String documentId = elasticsearchOperations.index(indexQuery);
必须更改为:
IndexCoordinates indexCoordinates = elasticsearchOperations.getIndexCoordinatesFor(person.getClass());
IndexQuery indexQuery = new IndexQueryBuilder()
.withId(person.getId().toString())
.withObject(person)
.build();
String documentId = elasticsearchOperations.index(indexQuery, indexCoordinates);
为了更轻松地使用实体并使用实体注释中包含的索引名称,添加了如下新方法:@Document
DocumentOperations.save(T entity)
;
新的 Operations 界面
在版本 3.2 中,有一个接口定义了类的所有方法。在版本 4 中,这些函数被拆分为不同的接口,使这些接口与 Elasticsearch API 保持一致:ElasticsearchOperations
ElasticsearchTemplate
-
DocumentOperations
是与文档相关的功能,例如保存或删除 -
SearchOperations
包含要在 Elasticsearch 中搜索的函数 -
IndexOperations
定义要对索引操作的函数,例如索引创建或映射创建。
ElasticsearchOperations
现在扩展 and and 让方法访问实例。DocumentOperations
SearchOperations
IndexOperations
版本 3.2 中 interface 现在移动到 interface 的所有函数仍然可用,它们被标记为已弃用,并且具有委托给新 implementation的默认实现:ElasticsearchOperations IndexOperations |
/**
* Create an index for given indexName.
*
* @param indexName the name of the index
* @return {@literal true} if the index was created
* @deprecated since 4.0, use {@link IndexOperations#create()}
*/
@Deprecated
default boolean createIndex(String indexName) {
return indexOps(IndexCoordinates.of(indexName)).create();
}
弃用
方法和类
许多函数和类已被弃用。这些函数仍然有效,但 Javadocs 显示了它们应该被替换的内容。
/*
* Retrieves an object from an index.
*
* @param query the query defining the id of the object to get
* @param clazz the type of the object to be returned
* @return the found object
* @deprecated since 4.0, use {@link #get(String, Class, IndexCoordinates)}
*/
@Deprecated
@Nullable
<T> T queryForObject(GetQuery query, Class<T> clazz);
清除
-
如前所述,该接口已被删除。
ElasticsearchEntityMapper
-
该接口已合并到其基本接口中,因此它的出现次数可以替换为 。
SearchQuery
Query
Query
-
方法和接口已被删除。 这些可用于解析来自 Elasticsearch 的结果,以防使用基于 Jackson 的映射器完成的响应映射不够。 从 4.0 版本开始,有新的搜索结果类型可以从 Elasticsearch 响应中返回信息,因此无需公开此低级功能。
org.springframework.data.elasticsearch.core.ElasticsearchOperations.query(SearchQuery query, ResultsExtractor<T> resultsExtractor);
org.springframework.data.elasticsearch.core.ResultsExtractor
-
的 低级方法 和 已从界面中删除。 对于低级滚动 API 访问,类上现在有 和 方法。
startScroll
continueScroll
clearScroll
ElasticsearchOperations
searchScrollStart
searchScrollContinue
searchScrollClear
ElasticsearchRestTemplate