spring boot 集成 elastic search

妖狐艹你老母 2023-03-03 08:58 12阅读 0赞

参考文档 [spring boot 官方文档][spring boot]

elastic search 更新的很快，不管是国内的还是国外的网上的好多教程都是比较老的版本，好多类和方法都被废弃了。找了个 spring boot 官方的教程中途还报错了，后来根据报错信息结合 spring-boot-autoconfigure jar 包里的源码找到了解决办法。

源码可以在 [github][] 下载。

### 1. 添加依赖 ###

<?xml version="1.0" encoding="UTF-8"?>
    <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 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>
    
        <parent>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-parent</artifactId>
            <version>2.3.1.RELEASE</version>
            <relativePath/> 
        </parent>
    
        <groupId>org.example</groupId>
        <artifactId>spring-boot-es</artifactId>
        <version>1.0-SNAPSHOT</version>
    
        <properties>
            <java.version>1.8</java.version>
        </properties>
    
        <dependencies>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-web</artifactId>
            </dependency>
    
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-data-elasticsearch</artifactId>
            </dependency>
    
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-validation</artifactId>
            </dependency>
    
            <dependency>
                <groupId>javax.validation</groupId>
                <artifactId>validation-api</artifactId>
                <version>1.1.0.Final</version>
            </dependency>
    
    
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-test</artifactId>
                <scope>test</scope>
            </dependency>
    
            <dependency>
                <groupId>org.projectlombok</groupId>
                <artifactId>lombok</artifactId>
            </dependency>
    
    
        </dependencies>
    
        <build>
            <plugins>
                <plugin>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-maven-plugin</artifactId>
                </plugin>
            </plugins>
        </build>
    
        <repositories>
            <repository>
                <id>spring-milestones</id>
                <name>Spring Milestones</name>
                <url>https://repo.spring.io/milestone</url>
            </repository>
            <repository>
                <id>spring-snapshots</id>
                <name>Spring Snapshots</name>
                <url>https://repo.spring.io/snapshot</url>
                <snapshots>
                    <enabled>true</enabled>
                </snapshots>
            </repository>
        </repositories>
        <pluginRepositories>
            <pluginRepository>
                <id>spring-milestones</id>
                <name>Spring Milestones</name>
                <url>https://repo.spring.io/milestone</url>
            </pluginRepository>
            <pluginRepository>
                <id>spring-snapshots</id>
                <name>Spring Snapshots</name>
                <url>https://repo.spring.io/snapshot</url>
                <snapshots>
                    <enabled>true</enabled>
                </snapshots>
            </pluginRepository>
    
        </pluginRepositories>
    
    
    </project>

### 2. 定义 spring boot 的启动类 ###

package demo;
    
    import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    
    /** * @Author:shifengqiang * @Date:2020/7/30 3:42 下午 */
    @SpringBootApplication
    public class App { 
        public static void main(String[] args) { 
            SpringApplication.run(App.class, args);
        }
    }

### 3. 定义 User 类 ###

package demo.document;
    
    import lombok.Data;
    import org.springframework.data.annotation.Id;
    import org.springframework.data.elasticsearch.annotations.Document;
    
    /** * @Author:shifengqiang * @Date:2020/7/30 4:31 下午 */
    @Document(indexName = "users")
    @Data
    public class User { 
        @Id
        private Long id;
        private String name;
        private Integer age;
    }

### 4. 定义 ElasticSearchConfig 类。 ###

package demo.config;
    
    import org.elasticsearch.client.RestHighLevelClient;
    import org.springframework.beans.factory.annotation.Value;
    import org.springframework.context.annotation.Bean;
    import org.springframework.context.annotation.Configuration;
    import org.springframework.data.elasticsearch.client.ClientConfiguration;
    import org.springframework.data.elasticsearch.client.RestClients;
    import org.springframework.data.elasticsearch.config.ElasticsearchConfigurationSupport;
    
    /** * @Author:shifengqiang * @Date:2020/7/30 3:59 下午 */
    @Configuration
    public class ElasticSearchConfig extends ElasticsearchConfigurationSupport { 
        @Value("${es_host}")
        private String esHost;
    
        @Value("${es_port}")
        private String esPort;
    
        @Bean
        public RestHighLevelClient elasticsearchClient() { 
            ClientConfiguration.ClientConfigurationBuilderWithRequiredEndpoint builder = ClientConfiguration.builder();
            final ClientConfiguration clientConfiguration = ClientConfiguration.builder()
                    .connectedTo(esHost + ":" + esPort)
                    .build();
    
            return RestClients.create(clientConfiguration).rest();
        }
    }

在这一步中，官方给的例子是有问题的，我是根据报错提示并结合 spring-boot-autoconfigure 里的源码找到解决办法的，最近在读 rocketmq 的源码，详细过程就不写了，如果大家在集成的过程中遇到问题可以给我留言。

### 5. 定义 UserController 。 ###

package demo.controller;
    
    import demo.document.User;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.data.elasticsearch.core.ElasticsearchRestTemplate;
    import org.springframework.data.elasticsearch.core.mapping.IndexCoordinates;
    import org.springframework.data.elasticsearch.core.query.IndexQuery;
    import org.springframework.data.elasticsearch.core.query.IndexQueryBuilder;
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.ResponseBody;
    import org.springframework.web.bind.annotation.RestController;
    
    /** * @Author:shifengqiang * @Date:2020/7/30 5:50 下午 */
    @RestController
    public class UserController { 
        @Autowired
        private ElasticsearchRestTemplate elasticsearchTemplate;
    
        @RequestMapping("/query")
        @ResponseBody
        public User queryUser() { 
            User user = elasticsearchTemplate
                    .get("3", User.class);
            return user;
        }
        @RequestMapping("/save")
        @ResponseBody
        public User saveUser() { 
            User user = new User();
            user.setId(3L);
            user.setAge(3223);
            user.setName("shifengqiang3");
    
    
            IndexCoordinates indexOperations = IndexCoordinates.of("users");
    
            IndexQuery indexQuery = new IndexQueryBuilder()
                    .withId("3")
                    .withObject(user)
                    .build();
            String documentId = elasticsearchTemplate.index(indexQuery, indexOperations);
    
            return user;
        }
    }

### 6. 在 application.properties 添加 es 的 ip 地址和端口号。 ###

server.port=8080
    es_host=localhost
    es_port=9200

到此就完成了，可以打开浏览器测试了。

[spring boot]: https://docs.spring.io/spring-data/elasticsearch/docs/current-SNAPSHOT/reference/html/#elasticsearch.operations.resttemplate
[github]: https://github.com/fengsmith/spring-boot-es