spring-boot-starter-elasticsearch xpack 问题

布满荆棘的人生 2022-04-18 02:14 309阅读 0赞

以下转载自博客: [https://my.oschina.net/lizaizhong/blog/1611182][https_my.oschina.net_lizaizhong_blog_1611182]

官方spring-boot-starter-elasticsearch的问题

前提：Spring Boot的版本用的是1.5.2.RELEASE  
Spring Boot官方提供了：

<dependency>  
            <groupId>org.springframework.boot</groupId>  
            <artifactId>spring-boot-starter-data-elasticsearch</artifactId>  
        </dependency>

但es client的版本用的竟然是令人发指的2.4.0，公司的es用的5.3，client的版本也是5.3。  
版本对应不上，导致出现很多问题，于是决定自己写一个starter。

样板

写一个starter还不是那么容易，找个样板来模仿一下，项目用到了dubbo，参照了spring-boot-starter-dubbo：[https://github.com/alibaba/spring-boot-starter-dubbo][https_github.com_alibaba_spring-boot-starter-dubbo]

开始

整体的项目截图如：  
输入图片说明  
先定义个pom.xml：

<project xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://maven.apache.org/POM/4.0.0" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
        <modelVersion>4.0.0</modelVersion>
        
        <groupId>org.elasticsearch.springboot</groupId>
        <artifactId>spring-boot-starter-elasticsearch</artifactId>
        <version>1.0.0</version>
        <packaging>jar</packaging>
        <name>spring-boot-starter-elasticsearch</name>
    
        <properties>
            <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
            <java.version>1.8</java.version>
            <maven.compiler.source>${java.version}</maven.compiler.source>
            <maven.compiler.target>${java.version}</maven.compiler.target>
            
            <elasticsearch.version>5.4.3</elasticsearch.version>
        </properties>
    
        <dependencies>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter</artifactId>
                <version>1.5.2.RELEASE</version>
            </dependency>
            <dependency>
                <groupId>org.elasticsearch</groupId>
                <artifactId>elasticsearch</artifactId>
                <version>${elasticsearch.version}</version>
            </dependency>
            <dependency>
                <groupId>org.elasticsearch.client</groupId>
                <artifactId>transport</artifactId>
                <version>${elasticsearch.version}</version>
            </dependency>
            <dependency>
                <groupId>org.elasticsearch.client</groupId>
                <artifactId>x-pack-transport</artifactId>
                <version>${elasticsearch.version}</version>
            </dependency>
            <dependency>
                <groupId>org.apache.logging.log4j</groupId>
                <artifactId>log4j-api</artifactId>
                <version>2.7</version>
            </dependency>
            <dependency>
                <groupId>org.apache.logging.log4j</groupId>
                <artifactId>log4j-core</artifactId>
                <version>2.7</version>
            </dependency>
        </dependencies>
    
    </project>

spring.factories的内容：

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
    org.elasticsearch.springboot.ElasticSearchAutoConfiguration

spring.provides的内容：

provides: spring-boot-starter-elasticsearch

下面是三个类：

package org.elasticsearch.springboot;
    
    public class XPack { 
        private String user;
        private String password;
    
        public String getUser() { 
            return user;
        }
    
        public void setUser(String user) { 
            this.user = user;
        }
    
        public String getPassword() { 
            return password;
        }
    
        public void setPassword(String password) { 
            this.password = password;
        }
    
    }

package org.elasticsearch.springboot;
    
    import java.util.HashMap;
    import java.util.Map;
    
    import org.springframework.boot.context.properties.ConfigurationProperties;
    
    @ConfigurationProperties(prefix = "spring.data.elasticsearch")
    public class ElasticSearchProperties { 
        private String clusterName;
        private String clusterNodes;
        private XPack xpack;
        private Map<String, String> properties = new HashMap<String, String>();
    
        public String getClusterName() { 
            return clusterName;
        }
    
        public void setClusterName(String clusterName) { 
            this.clusterName = clusterName;
        }
    
        public String getClusterNodes() { 
            return clusterNodes;
        }
    
        public void setClusterNodes(String clusterNodes) { 
            this.clusterNodes = clusterNodes;
        }
    
        public Map<String, String> getProperties() { 
            return properties;
        }
    
        public void setProperties(Map<String, String> properties) { 
            this.properties = properties;
        }
    
        public XPack getXpack() { 
            return xpack;
        }
    
        public void setXpack(XPack xpack) { 
            this.xpack = xpack;
        }
    
    }

package org.elasticsearch.springboot;
    
    import java.net.InetAddress;
    import java.net.UnknownHostException;
    
    import org.elasticsearch.client.transport.TransportClient;
    import org.elasticsearch.common.lease.Releasable;
    import org.elasticsearch.common.settings.Settings;
    import org.elasticsearch.common.settings.Settings.Builder;
    import org.elasticsearch.common.transport.InetSocketTransportAddress;
    import org.elasticsearch.transport.client.PreBuiltTransportClient;
    import org.elasticsearch.xpack.client.PreBuiltXPackTransportClient;
    import org.slf4j.Logger;
    import org.slf4j.LoggerFactory;
    import org.springframework.beans.factory.DisposableBean;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.boot.context.properties.EnableConfigurationProperties;
    import org.springframework.context.annotation.Bean;
    import org.springframework.context.annotation.Configuration;
    import org.springframework.util.ReflectionUtils;
    
    @Configuration
    @EnableConfigurationProperties(ElasticSearchProperties.class)
    public class ElasticSearchAutoConfiguration implements DisposableBean { 
        private static final Logger logger = LoggerFactory.getLogger(ElasticSearchAutoConfiguration.class);
    
        @Autowired
        private ElasticSearchProperties properties;
    
        private Releasable releasable;
    
        @Bean
        public TransportClient transportClient() throws UnknownHostException { 
            if (isNotBlank(properties.getClusterName()) && isNotBlank(properties.getClusterNodes())) { 
                Builder builder = Settings.builder();
                builder.put("cluster.name", properties.getClusterName());
                // 创建client
                String[] arr = properties.getClusterNodes().split(":");
                String host = arr[0];
                Integer port = Integer.valueOf(arr[1]);
                TransportClient client = null;
                if (properties.getXpack() != null && isNotBlank(properties.getXpack().getUser()) && isNotBlank(properties.getXpack().getPassword())) { 
                    builder.put("xpack.security.user", properties.getXpack().getUser() + ":" + properties.getXpack().getPassword());
                    client = new PreBuiltXPackTransportClient(builder.build()).addTransportAddress(new InetSocketTransportAddress(InetAddress.getByName(host), port));
                } else { 
                    client = new PreBuiltTransportClient(builder.build()).addTransportAddress(new InetSocketTransportAddress(InetAddress.getByName(host), port));
                }
                releasable = client;
                return client;
            }
            return null;
        }
    
        private boolean isNotBlank(String clusterName) { 
            return clusterName != null && clusterName.length() > 0;
        }
    
        @Override
        public void destroy() throws Exception { 
            if (this.releasable != null) { 
                try { 
                    if (logger.isInfoEnabled()) { 
                        logger.info("Closing Elasticsearch client");
                    }
                    try { 
                        this.releasable.close();
                    } catch (NoSuchMethodError ex) { 
                        // Earlier versions of Elasticsearch had a different method
                        // name
                        ReflectionUtils.invokeMethod(ReflectionUtils.findMethod(Releasable.class, "release"), this.releasable);
                    }
                } catch (final Exception ex) { 
                    if (logger.isErrorEnabled()) { 
                        logger.error("Error closing Elasticsearch client: ", ex);
                    }
                }
            }
        }
    }

使用

引用了这个Starter之后，配置文件如下：

spring.data.elasticsearch.cluster-name=CollectorDBCluster
    spring.data.elasticsearch.cluster-nodes=192.168.1.63:9300
    spring.data.elasticsearch.xpack.user=elastic
    spring.data.elasticsearch.xpack.password=changeme

注意到这里我使用了XPack，如果没有使用到的话后两行是可以不配置的。

[https_my.oschina.net_lizaizhong_blog_1611182]: https://my.oschina.net/lizaizhong/blog/1611182
[https_github.com_alibaba_spring-boot-starter-dubbo]: https://github.com/alibaba/spring-boot-starter-dubbo