2020-03-18 通过spring-boot-2.* + spring-data-elasticsearch 使用 ElasticsearchRestTemplate

如何通过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());
    }
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 213,417评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,921评论 3 387
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 158,850评论 0 349
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,945评论 1 285
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,069评论 6 385
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,188评论 1 291
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,239评论 3 412
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,994评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,409评论 1 304
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,735评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,898评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,578评论 4 336
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,205评论 3 317
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,916评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,156评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,722评论 2 363
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,781评论 2 351

推荐阅读更多精彩内容