如何通过spring-boot-2.* + spring-data-elasticsearch构建基于 HighLevelRestClient 的 ElasticsearchRestTemplate,而不是基于 Transport 的 ElasticsearchTemplate?
1. 网上使用spring-boot + spring-data-elasticsearch 配置的文章,实际上都不是 ElasticsearchRestTemplate,而是 ElasticsearchTemplate。
几乎网上所有使用spring-boot + spring-data-elasticsearch 注解配置的文章,无论标题是否写着使用ElasticsearchRestTemplate,配置出来的都是使用 transport 的 ElasticsearchTemplate,而不是使用 HighLevelRestClient 的 ElasticsearchRestTemplate。只有少数几篇使用 xml 来配置的文章,配置出来的是 ElasticsearchRestTemplate。
我们来看看最常见的配法,它实际上配置出来的是基于 transport 的ElasticsearchTemplate。
ElasticsearchTemplate当然可以使用了。但是,ES 官方从 v6.* 开始就deprecated了这个接口,且宣称从 v8.* 开始,将不再支持基于 transport 的接口。所以我们暂时用用还行,新项目还是不要再用了,改为使用基于 rest 接口的 ElasticsearchRestTemplate 比较好。
首先,在 application.properties中配置
# 这里要配置你实际的cluster名字。我用的 ES 官方docker容器,因此其名字是:
spring.data.elasticsearch.cluster-name=docker-cluster
# 这里配置 ES node 地址。
spring.data.elasticsearch.cluster-nodes=localhost:9300
spring.data.elasticsearch.repositories.enable=true
注意到配置的地址是
localhost:9300
,9300端口根本不是 rest 接口使用的,而是 ES 内部节点之间进行管理使用的 tcp 接口。
- transport 接口就是使用 9300 端口将自己伪装成为 cluster 的一个节点,然后通过管理接口进行操作的。
- rest 接口使用的是 9200 端口,通过 restful 的http接口进行访问。
然后使用注解@EnableElasticsearchRepositories
来启用 spring-data-elasticsearch 的自动配置
@SpringBootApplication
@ComponentScan(basePackages= {"cn.fredworks"})
@EnableElasticsearchRepositories
public class WebApplicationQbank extends SpringBootServletInitializer {
接下来,我们就可以使用 ElasticsearchCrudRepository 或 ElasticsearchTemplate 了。
这是使用 ElasticsearchCrudRepository 的例子:
@Repository
public interface IQuestionDao extends ElasticsearchCrudRepository<Question, String> {
}
这是使用 ElasticsearchTemplate 的例子:
@RunWith(SpringRunner.class)
@SpringBootTest(classes=WebApplicationQbank.class)
class IQuestionMaintainServiceTest {
@Resource(name = "elasticsearchTemplate")
private ElasticsearchTemplate esRestTemplate;
这个注入本身就证明了 上面的配置生成的是 ElasticsearchTemplate 而不是 ElasticsearchRestTemplate,否则这个注入会因为类型转换失败而报错。
2. 一种正确的ElasticsearchRestTemplate配置
实际上,spring-data的所有自动配置,几乎都使用了类似 @ConditionalOnMissingBean/@ConditionalOnBean 这样的条件语句。spring-data-elasticsearch 自动配置 ElasticsearchTemplate 也是这样。因此,如果我们自己装配一个 ElasticsearchRestTemplate 实例出来,那么就可以阻止 ElasticsearchTemplate 的生成了。因为无论是 ElasticsearchOperation 还是 ElasticsearchTemplate 还是 ElasticsearchRestTemplate,其生成的bean都叫做 "elasticsearchTemplate",只能有一个。我们可以看看 ElasticsearchDataConfiguration.RestClientConfiguration
的内容:
@Configuration(proxyBeanMethods = false)
@ConditionalOnClass(RestHighLevelClient.class)
static class RestClientConfiguration {
@Bean
@ConditionalOnMissingBean(value = ElasticsearchOperations.class, name = "elasticsearchTemplate")
@ConditionalOnBean(RestHighLevelClient.class)
ElasticsearchRestTemplate elasticsearchTemplate(RestHighLevelClient client, ElasticsearchConverter converter,
ResultsMapper resultsMapper) {
return new ElasticsearchRestTemplate(client, converter, resultsMapper);
}
}
当满足如下两个条件时,才会生成 ElasticsearchRestTemplate
- 类路径中有 RestHighLevelClient
- 还没有名字叫做 elasticsearchTemplate ,且类型为 ElasticsearchOperations.class 的 bean 存在。实际上,ElasticsearchTemplate 和 ElasticsearchRestTemplate 都是 ElasticsearchOperation 的实现。
因为spring-data-elasticsearch 的自动配置具有最低的优先级,我们自己提供的@Configuration 优先级较高,因此我们提供一个自己的 @Configuratioin 去构建 ElasticsearchRestTemplate。它会先于spring-data-elasticsearch 自动组装的 ElasticsearchTemplate构建。因此,我们可以按照如下步骤来配置:
首先,在 application.properties 中配置访问端口 9200:
# 这里要配置你实际的cluster名字。我用的 ES 官方docker容器,因此其名字是:
spring.data.elasticsearch.cluster-name=docker-cluster
# 这里配置 ES node 地址,必须是 9200 端口。
spring.data.elasticsearch.cluster-nodes=localhost:9200
spring.data.elasticsearch.repositories.enable=true
然后,实现配置对象:
@Configuration
public class ElasticsearchConfig {
/**
* 使用sprnig-data-elasticsearch 自动提供的 RestHighLevelClient等构建 ElasticsearchRestTemplate
* 2020年3月18日 下午3:05:55 xx添加此方法
* @param client
* @param converter
* @param resultsMapper
* @return
*/
@Bean
public ElasticsearchRestTemplate elasticsearchTemplate(RestHighLevelClient client, ElasticsearchConverter converter,
ResultsMapper resultsMapper) {
return new ElasticsearchRestTemplate(client, converter, resultsMapper);
}
}
接下来我们就可以直接使用了:
@RunWith(SpringRunner.class)
@SpringBootTest(classes=WebApplicationQbank.class)
class IQuestionMaintainServiceTest {
@Resource(name = QbankModuleBeanNames.QbankModuleElasticsearchTemplate)
private ElasticsearchRestTemplate esRestTemplate;
/**
* 2020年3月12日 上午9:59:44 xx添加此方法
* @throws java.lang.Exception
*/
@BeforeEach
void setUp() throws Exception {
assertNotNull(this.esRestTemplate);
assertEquals(ElasticsearchRestTemplate.class, this.esRestTemplate.getClass());
}