从 4.2.x 升级到 4.3.x
本节介绍从 4.2.x 版本到 4.3.x 版本的破坏性变更,以及如何用新引入的特性替代被移除的特性。
Elasticsearch 正在开发一个新的客户端,用于取代 RestHighLevelClient,因为 RestHighLevelClient 使用了 Elasticsearch 核心库中的代码,而这些代码已不再采用 Apache 2 许可。Spring Data Elasticsearch 也在为此变更做准备。这意味着 *Operations 接口的内部实现需要更改——如果您是针对 ElasticsearchOperations 或 ReactiveElasticsearchOperations 等接口进行编程,这应该不成问题。如果您直接使用 ElasticsearchRestTemplate 等实现类,则需要适应这些变更。
Spring Data Elasticsearch 还在其 API 类和方法中移除或替换了对 org.elasticsearch 包下类的使用,仅在实现 Elasticsearch 访问的实现代码中使用它们。对用户而言,这意味着原先使用的某些枚举类被替换为位于 org.springframework.data.elasticsearch 中、具有相同值的枚举,这些枚举在内部映射到对应的 Elasticsearch 枚举。
对于那些使用了无法轻易替换的类的地方,该用法已标记为弃用,我们正在开发替代方案。
弃用项
suggest 方法
在 SearchOperations 中(因而也在 ElasticsearchOperations 中),接受 org.elasticsearch.search.suggest.SuggestBuilder 作为参数并返回 org.elasticsearch.action.search.SearchResponse 的 suggest 方法已被弃用。请改用 SearchHits<T> search(Query query, Class<T> clazz),传入一个可以包含 SuggestBuilder 的 NativeSearchQuery,并从返回的 SearchHit<T> 中读取补全建议结果。
在 ReactiveSearchOperations 中,新的 suggest 方法现在返回 Mono<org.springframework.data.elasticsearch.core.suggest.response.Suggest>。同样,旧方法已被弃用。
破坏性变更
从 API 中移除 org.elasticsearch 类
-
在
org.springframework.data.elasticsearch.annotations.CompletionContext注解中,属性type()已从org.elasticsearch.search.suggest.completion.context.ContextMapping.Type更改为org.springframework.data.elasticsearch.annotations.CompletionContext.ContextMappingType,可用的枚举值相同。 -
在
org.springframework.data.elasticsearch.annotations.Document注解中,属性versionType()已更改为org.springframework.data.elasticsearch.annotations.Document.VersionType,可用的枚举值相同。 -
在
org.springframework.data.elasticsearch.core.query.Query接口中,属性searchType()已更改为org.springframework.data.elasticsearch.core.query.Query.SearchType,可用的枚举值相同。 -
在
org.springframework.data.elasticsearch.core.query.Query接口中,timeout()的返回值已更改为java.time.Duration。 -
SearchHits<T>类不再包含org.elasticsearch.search.aggregations.Aggregations。相反,它现在包含org.springframework.data.elasticsearch.core.AggregationsContainer<T>类的一个实例,其中T是所用底层客户端的具体聚合类型。目前这会是一个org.springframework.data.elasticsearch.core.clients.elasticsearch7.ElasticsearchAggregations对象;稍后将提供不同的实现。ReactiveSearchOperations.aggregate()函数也做了同样的更改,现在返回Flux<AggregationContainer<?>>。使用聚合的程序需要做出更改,将返回值强制转换为相应的类以进一步处理。 -
过去可能抛出
org.elasticsearch.ElasticsearchStatusException的方法,现在将改为抛出org.springframework.data.elasticsearch.RestStatusException。
Query 的 field 与 sourceFilter 属性的处理
在 4.2 版本之前,Query 的 fields 属性会被解析并添加到 sourceFilter 的包含列表中。这是不正确的,因为对 Elasticsearch 而言这是两个不同的概念。现已更正。因此,依赖使用 fields 来指定应从文档的 _source 返回哪些字段的代码可能无法再正常工作,应改为使用 sourceFilter。
search_type 默认值
Elasticsearch 中 search_type 的默认值是 query_then_fetch。现在这也被设为 Query 实现中的默认值;此前它被设为 dfs_query_then_fetch。
BulkOptions 变更
org.springframework.data.elasticsearch.core.query.BulkOptions 类的某些属性已更改其类型:
-
timeout属性的类型已更改为java.time.Duration。 -
refreshPolicy属性的类型已更改为org.springframework.data.elasticsearch.core.RefreshPolicy。
IndicesOptions 变更
Spring Data Elasticsearch 现在使用 org.springframework.data.elasticsearch.core.query.IndicesOptions 而非 org.elasticsearch.action.support.IndicesOptions。
补全类
包 org.springframework.data.elasticsearch.core.completion 中的类已移至 org.springframework.data.elasticsearch.core.suggest。
其他重命名
org.springframework.data.elasticsearch.core.mapping.ElasticsearchPersistentPropertyConverter 接口已重命名为 org.springframework.data.elasticsearch.core.mapping.PropertyValueConverter。同样,名为 XXPersistentPropertyConverter 的实现类已重命名为 XXPropertyValueConverter。