此版本仍在开发中,尚不被认为是稳定的。对于最新的稳定版本,请使用 Spring Data Elasticsearch 5.5.2! |
从 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 的@Field
注解。
有关详细信息,请参阅映射注释概述。
从查询对象中删除隐式索引名称
在 3.2.x 中,不同的查询类(例如IndexQuery
或SearchQuery
具有采用索引名称或它们正在作的索引名称的属性。如果未设置这些,则检查传入的实体以检索在@Document
注解。
在 4.0.x 中,现在必须在类型为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)
;
新的作界面
在 3.2 版本中,有ElasticsearchOperations
定义了ElasticsearchTemplate
类。在版本 4 中,这些函数被拆分为不同的接口,使这些接口与 Elasticsearch API 保持一致:
-
DocumentOperations
是与文档相关的功能,例如保存或删除 -
SearchOperations
包含要在 Elasticsearch 中搜索的函数 -
IndexOperations
定义要对索引进行作的函数,例如索引创建或映射创建。
ElasticsearchOperations
现在扩展DocumentOperations
和SearchOperations
并且有方法可以访问IndexOperations
实例。
来自ElasticsearchOperations 3.2 版中的接口,现在已移至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
. -
方法
org.springframework.data.elasticsearch.core.ElasticsearchOperations.query(SearchQuery query, ResultsExtractor<T> resultsExtractor);
和org.springframework.data.elasticsearch.core.ResultsExtractor
接口已被删除。 这些可用于解析 Elasticsearch 的结果,以应对使用基于 Jackson 的映射器完成的响应映射不够的情况。 从 4.0 版本开始,有了新的搜索结果类型来返回 Elasticsearch 响应中的信息,因此无需公开这种低级功能。 -
低级方法
startScroll
,continueScroll
和clearScroll
已从ElasticsearchOperations
接口。 对于低级滚动 API 访问,现在有searchScrollStart
,searchScrollContinue
和searchScrollClear
方法ElasticsearchRestTemplate
类。