从 4.3.x 升级到 4.4.x

本节介绍从版本 4.3.x 到 4.4.x 的重大更改,以及如何将已删除的功能替换为新引入的功能。spring-doc.cadn.net.cn

弃用

org.springframework.data.elasticsearch.core.ReactiveElasticsearchOperations

方法<T> Publisher<T> execute(ClientCallback<Publisher<T>> callback)已被弃用。 由于现在有多个使用不同客户端库的实现,executemethod 在不同的 implementations 中仍然可用,但接口中没有更多的 method,因为不同的 Client 端没有通用的回调接口。spring-doc.cadn.net.cn

重大更改

删除已弃用的类

org.springframework.data.elasticsearch.core.ElasticsearchTemplate已被删除

从版本 4.4 开始, Spring Data Elasticsearch 不使用TransportClient从 Elasticsearch 开始(自 Elasticsearch 7.0 起已弃用)。 这意味着org.springframework.data.elasticsearch.core.ElasticsearchTemplate自 Spring Data Elasticsearch 4.0 以来已弃用的类已被删除。 这就是ElasticsearchOperations使用TransportClient. 必须使用命令式ElasticsearchRestTemplate或反应式ReactiveElasticsearchTemplate.spring-doc.cadn.net.cn

套餐更改

在 4.3 中,两个类 (ElasticsearchAggregationsElasticsearchAggregation) 已移至org.springframework.data.elasticsearch.core.clients.elasticsearch7包中为集成新的 Elasticsearch 客户端做准备。 的 被移回了org.springframework.data.elasticsearch.corepackage 一起使用它们所在的旧 Elasticsearch 客户端。spring-doc.cadn.net.cn

行为改变

ReactiveElasticsearchTemplate,当直接创建或通过 Spring Boot 配置创建时,默认刷新策略为 IMMEDIATE。 这可能会导致大量索引的性能问题,并且与 Elasticsearch 的默认行为不同。 这已更改为现在默认刷新策略为 NONE。 当ReactiveElasticsearchTemplate通过使用 Reactive REST Client 中描述的配置提供,则默认刷新策略已设置为 NONE。spring-doc.cadn.net.cn

新的 Elasticsearch 客户端

Elasticsearch 推出了它的新功能ElasticsearchClient并废弃了之前的RestHighLevelClient. Spring Data Elasticsearch 4.4 仍然使用旧客户端作为默认客户端,原因如下:spring-doc.cadn.net.cn

  • 新客户端强制应用程序使用jakarta.json.spi.JsonProvider包,而 Spring Boot 将坚持javax.json.spi.JsonProvider直到版本 3。因此,在 Spring Data Elasticsearch 中切换默认实现只能随 Spring Data Elasticsearch 5(Spring Data 3、Spring 6)一起提供。spring-doc.cadn.net.cn

  • Elasticsearch 客户端中仍有一些 bug 需要解决spring-doc.cadn.net.cn

  • 由于资源有限,在 Spring Data Elasticsearch 中使用新客户端的实现尚未完成 - 请记住,Spring Data Elasticsearch 是一个社区驱动的项目,它依赖于公众贡献。spring-doc.cadn.net.cn

如何使用新客户端

使用新客户端的实现不完整,部分作会抛出java.lang.UnsupportedOperationException或者可能会抛出 NPE(例如,当 Elasticsearch 无法解析来自服务器的响应时,这种情况有时仍然会发生)
使用新客户端来测试实现,但暂时不要在生产代码中使用它!

为了尝试使用新客户端,需要执行以下步骤:spring-doc.cadn.net.cn

确保不要配置现有的默认客户端

如果使用 Spring Boot,请从自动配置中排除 Spring Data Elasticsearchspring-doc.cadn.net.cn

@SpringBootApplication(exclude = ElasticsearchDataAutoConfiguration.class)
public class SpringdataElasticTestApplication {
	// ...
}

从应用程序配置中删除 Spring Data Elasticsearch 相关属性。 如果 Spring Data Elasticsearch 是使用编程配置配置的(请参阅 Elasticsearch 客户端),请从 Spring 应用程序上下文中删除这些 bean。spring-doc.cadn.net.cn

添加依赖项

新 Elasticsearch 客户端的依赖项在 Spring Data Elasticsearch 中仍然是可选的,因此需要显式添加它们:spring-doc.cadn.net.cn

<dependencies>
    <dependency>
        <groupId>co.elastic.clients</groupId>
        <artifactId>elasticsearch-java</artifactId>
        <version>7.17.3</version>
        <exclusions>
            <exclusion>
                <groupId>commons-logging</groupId>
                <artifactId>commons-logging</artifactId>
            </exclusion>
        </exclusions>
    </dependency>
    <dependency>
        <groupId>org.elasticsearch.client</groupId>
        <artifactId>elasticsearch-rest-client</artifactId> <!-- is Apache 2-->
        <version>7.17.3</version>
        <exclusions>
            <exclusion>
                <groupId>commons-logging</groupId>
                <artifactId>commons-logging</artifactId>
            </exclusion>
        </exclusions>
    </dependency>
</dependencies>

使用 Spring Boot 时,需要在 pom.xml中设置以下属性。spring-doc.cadn.net.cn

<properties>
    <jakarta-json.version>2.0.1</jakarta-json.version>
</properties>

新的配置类

命令式样式

为了将 Spring Data Elasticsearch 配置为使用新客户端,必须创建一个派生自org.springframework.data.elasticsearch.client.elc.ElasticsearchConfiguration:spring-doc.cadn.net.cn

@Configuration
public class NewRestClientConfig extends ElasticsearchConfiguration {

	@Override
	public ClientConfiguration clientConfiguration() {
		return ClientConfiguration.builder() //
			.connectedTo("localhost:9200") //
			.build();
	}
}

配置以与旧 Client 端相同的方式完成,但不再需要创建除配置 bean 之外的更多内容。 使用此配置,以下 bean 将在 Spring 应用程序上下文中可用:spring-doc.cadn.net.cn

  • 一个RestClientbean,即配置的低级别RestClient由 Elasticsearch 客户端使用spring-doc.cadn.net.cn

  • ElasticsearchClientbean,这是使用RestClientspring-doc.cadn.net.cn

  • ElasticsearchOperationsbean,可通过 bean 名称 elasticsearchOperationselasticsearchTemplate 获得,它使用ElasticsearchClientspring-doc.cadn.net.cn

反应式风格

要在反应式环境中使用新客户端,唯一的区别是要从中派生配置的类:spring-doc.cadn.net.cn

@Configuration
public class NewRestClientConfig extends ReactiveElasticsearchConfiguration {

	@Override
	public ClientConfiguration clientConfiguration() {
		return ClientConfiguration.builder() //
			.connectedTo("localhost:9200") //
			.build();
	}
}

使用此配置,以下 bean 将在 Spring 应用程序上下文中可用:spring-doc.cadn.net.cn

  • 一个RestClientbean,即配置的低级别RestClient由 Elasticsearch 客户端使用spring-doc.cadn.net.cn

  • ReactiveElasticsearchClientbean,这是使用RestClientspring-doc.cadn.net.cn

  • ReactiveElasticsearchOperationsbean,可通过 bean 名称 reactiveElasticsearchOperationsreactiveElasticsearchTemplate 获得,它使用ReactiveElasticsearchClientspring-doc.cadn.net.cn