springboot整合elasticsearch,增删改查，亲测可用

谁践踏了优雅 2024-04-17 05:29 94阅读 0赞

### springboot整合elasticsearch,亲测可用 ###

1。 最近公司项目要做一个搜索引擎服务，立马就想到了elasticsearch。对于elasticsearch,百度百科是这样解释的：ElasticSearch 是一个分布式、高扩展、高实时的搜索与数据分析引擎。它能很方便的使大量数据具有搜索、分析和探索的能力。充分利用ElasticSearch的水平伸缩性，能使数据在生产环境变得更有价值。ElasticSearch 的实现原理主要分为以下几个步骤，首先用户将数据提交到Elastic Search 数据库中，再通过分词控制器去将对应的语句分词，将其权重和分词结果一并存入数据，当用户搜索数据时候，再根据权重将结果排名，打分，再将返回结果呈现给用户。

2.注意：步入正题：大家知道，es的版本更新很快，每个版本之间的迭代又比较大。所以当我们在项目中引入es的时候，会有版本冲突和版本不兼容的问题。这里，我列举一下springboot中es版本问题,这是官网的描述。https://github.com/spring-projects/spring-data-elasticsearch/wiki/Spring-Data-Elasticsearch—Spring-Boot—version-matrix  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L1pfX1NoZW5n_size_16_color_FFFFFF_t_70]  
3.项目代码  
**pom配置**

<dependencies>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-web</artifactId>
            </dependency>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter</artifactId>
            </dependency>
            
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-data-elasticsearch</artifactId>
            </dependency>
            
            <dependency>
                <groupId>org.elasticsearch.client</groupId>
                <artifactId>transport</artifactId>
            </dependency>
            <dependency>
                <groupId>com.alibaba</groupId>
                <artifactId>fastjson</artifactId>
                <version>1.2.13</version>
            </dependency>
            <dependency>
                <groupId>com.microsoft.sqlserver</groupId>
                <artifactId>sqljdbc4</artifactId>
                <version>4.0</version>
            </dependency>
    
            <dependency>
                <groupId>org.mybatis.spring.boot</groupId>
                <artifactId>mybatis-spring-boot-starter</artifactId>
                <version>1.3.1</version>
            </dependency>
            <dependency>
                <groupId>mysql</groupId>
                <artifactId>mysql-connector-java</artifactId>
            </dependency>
            <dependency>
                <groupId>org.projectlombok</groupId>
                <artifactId>lombok</artifactId>
                <optional>true</optional>
            </dependency>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-test</artifactId>
            </dependency>
        </dependencies>

**yml配置：**  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L1pfX1NoZW5n_size_16_color_FFFFFF_t_70 1]  
**实体类，并且指定数据库名称，其中 @Document(indexName = “sunyardelasticsearchoption”)是指定数据库名称**

package com.sunyard.dictionarysearchengine.entity;
    
    import lombok.Data;
    import org.springframework.data.annotation.Id;
    import org.springframework.data.elasticsearch.annotations.Document;
    import org.springframework.stereotype.Component;
    
    import java.io.Serializable;
    
    /**
     * @Author: Mr sheng.z
     * @Description:搜索引擎实体类
     * 加上了@Document注解之后，默认情况下这个实体中所有的属性都会被建立索引、并且分词
     * 在Elasticsearch 6.X 版本中，不建议使用type，而且在7.X版本中将会彻底废弃type
     * @Date: Create in 9:47 2019/8/20
     */
    @Data
    @Document(indexName = "sunyardelasticsearchoption")
    @Component
    public class ElasticsearchOption  implements Serializable {
    
        /**
         * 系统自增ID
         * 为了防止重复被替换掉
         */
        @Id
        private String uuid;
    
        /**
         * 字典Id
         */
        private String  did;
    
    
        /**
         * 字典值描述
         */
        private String valueDescription;
    
        /**
         * 字典值key
         */
        private String value;
    
    }

**我们需要写一个接口，继承ElasticsearchRepository方法，这样，我们可以在项目中引入这个接口，自定义操作搜索引擎数据库的方法：**

package com.sunyard.dictionarysearchengine.configdao;
    
    import com.sunyard.dictionarysearchengine.entity.ElasticsearchOption;
    import org.springframework.data.elasticsearch.repository.ElasticsearchRepository;
    import org.springframework.stereotype.Repository;
    
    
    /**
     * @Author: Mr sheng.z
     * @Description: 继承搜索引擎的ElasticsearchRepository方法
     * @Date: Create in 15:12 2019/8/16
     */
    @Repository
    public interface ElasticsearchOptionSearchRepository extends ElasticsearchRepository<ElasticsearchOption,String> {
    
    }

测试类：这里面你们可以根据自己需要，封装实体类

package com.sunyard.dictionarysearchengine.controller;
    
    import com.sunyard.dictionarysearchengine.entity.ElasticsearchOption;
    import com.sunyard.dictionarysearchengine.server.ElasticsearchOptionServer;
    import com.sunyard.dictionarysearchengine.utils.IdGenerator;
    import org.junit.Test;
    import org.junit.runner.RunWith;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.boot.test.context.SpringBootTest;
    import org.springframework.data.domain.Page;
    import org.springframework.test.context.junit4.SpringRunner;
    
    import java.util.HashMap;
    import java.util.List;
    import java.util.Map;
    
    /**
     * @Author: Mr sheng.z
     * @Description:
     * @Date: Create in 10:23 2019/8/19
     */
    @RunWith(SpringRunner.class)
    @SpringBootTest
    public class ElasticsearchExampleApplicationTest {
    
        @Autowired
        private ElasticsearchOptionServer elasticsearchOptionServer;
    
        @Test
        public void contextLoads() {
            System.out.println(elasticsearchOptionServer.count());
        }
    
        @Test
        public void testInsert() {
            ElasticsearchOption elasticsearchOption = new ElasticsearchOption();
            elasticsearchOption.setDid("1");
            elasticsearchOption.setValueDescription("1");
            elasticsearchOption.setUuid(IdGenerator.PrimaryKey());
            elasticsearchOptionServer.save(elasticsearchOption);
    
    
    
            ElasticsearchOption elasticsearchOption2 = new ElasticsearchOption();
            elasticsearchOption2.setDid("2");
            elasticsearchOption2.setValueDescription("2");
            elasticsearchOption2.setUuid(IdGenerator.PrimaryKey());
            elasticsearchOptionServer.save(elasticsearchOption2);
    
    
    
        }
    
        @Test
        public void testDelete() {
            ElasticsearchOption elasticsearchOption = new ElasticsearchOption();
            elasticsearchOption.setDid("2");
            elasticsearchOptionServer.delete(elasticsearchOption);
        }
    
        @Test
        public void testGetAll() {
            Iterable<ElasticsearchOption> iterable = elasticsearchOptionServer.getAll();
            iterable.forEach(e->System.out.println(e.toString()));
        }
    
        /**
         * 单个条件查询
         */
        @Test
        public void testGetByName() {
            List<ElasticsearchOption> list = elasticsearchOptionServer.getByName("0-否");
        }
    
        /**
         * 多个条件查询
         */
        @Test
        public void testGetByMoreName() {
            Map map=new HashMap<>(2);
            map.put("did","17389");
            map.put("dvalue","20146");
            List<ElasticsearchOption> list = elasticsearchOptionServer.getByMoreName(map);
            System.out.println(list);
        }
    
        @Test
        public void testPage() {
            Page<ElasticsearchOption> page = elasticsearchOptionServer.pageQuery(0, 10, "切片");
            System.out.println(page.getTotalPages());
            System.out.println(page.getNumber());
            System.out.println(page.getContent());
        }
    }

**service**

package com.sunyard.dictionarysearchengine.server;
    
    import com.sunyard.dictionarysearchengine.entity.DataDictionaryOption;
    import com.sunyard.dictionarysearchengine.entity.ElasticsearchOption;
    import org.springframework.data.domain.Page;
    
    import java.util.List;
    import java.util.Map;
    
    /**
     * @Author: Mr sheng.z
     * @Description:
     * @Date: Create in 16:43 2019/8/16
     */
    public interface ElasticsearchOptionServer {
        long count();
    
        ElasticsearchOption save(ElasticsearchOption elasticsearchOption);
    
        List<ElasticsearchOption> saveAll(List<ElasticsearchOption> elasticsearchOptionList);
    
        void delete(ElasticsearchOption dataDictionaryOption);
    
        void deleteAll();
    
        Iterable<ElasticsearchOption> getAll();
    
        List<ElasticsearchOption> getByName(String name);
    
        Page<ElasticsearchOption> pageQuery(Integer pageNo, Integer pageSize, String kw);
    
        /**
         * 多个条件查询
         * @param map
         * @return
         */
        List<ElasticsearchOption> getByMoreName(Map<String,String> map);
    }

**servicesImpl**

package com.sunyard.dictionarysearchengine.server.impl;
    
    import com.alibaba.fastjson.JSON;
    import com.alibaba.fastjson.JSONObject;
    import com.sunyard.dictionarysearchengine.configdao.ElasticsearchOptionSearchRepository;
    import com.sunyard.dictionarysearchengine.entity.ElasticsearchOption;
    import com.sunyard.dictionarysearchengine.server.ElasticsearchOptionServer;
    import org.apache.commons.lang.StringUtils;
    import org.elasticsearch.action.search.SearchRequestBuilder;
    import org.elasticsearch.action.search.SearchResponse;
    import org.elasticsearch.client.transport.TransportClient;
    import org.elasticsearch.index.query.QueryBuilder;
    import org.elasticsearch.index.query.QueryBuilders;
    import org.elasticsearch.index.query.TermQueryBuilder;
    import org.elasticsearch.search.SearchHit;
    import org.elasticsearch.search.SearchHits;
    import org.slf4j.Logger;
    import org.slf4j.LoggerFactory;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.data.domain.Page;
    import org.springframework.data.domain.PageRequest;
    import org.springframework.data.elasticsearch.core.query.NativeSearchQueryBuilder;
    import org.springframework.data.elasticsearch.core.query.SearchQuery;
    import org.springframework.stereotype.Service;
    import java.util.ArrayList;
    import java.util.List;
    import java.util.Map;
    
    /**
     * @Author: Mr sheng.z
     * @Description:
     * @Date: Create in 16:44 2019/8/16
     */
    @Service
    public class ElasticsearchOptionServerImpl implements ElasticsearchOptionServer {
        private static  final Logger logger= LoggerFactory.getLogger(ElasticsearchOptionServerImpl.class);
        @Autowired
        private ElasticsearchOptionSearchRepository elasticsearchOptionSearchRepository;
    
        @Autowired
        private  TransportClient transportClient;
    
    
        @Override
        public long count() {
            return elasticsearchOptionSearchRepository.count();
        }
    
        @Override
        public ElasticsearchOption save(ElasticsearchOption elasticsearchOption) {
            return elasticsearchOptionSearchRepository.save(elasticsearchOption);
        }
    
        @Override
        public List<ElasticsearchOption> saveAll(List<ElasticsearchOption> elasticsearchOptionList) {
            return (List<ElasticsearchOption>) elasticsearchOptionSearchRepository.saveAll(elasticsearchOptionList);
        }
    
        @Override
        public void delete(ElasticsearchOption elasticsearchOption) {
            elasticsearchOptionSearchRepository.delete(elasticsearchOption);
        }
    
        @Override
        public void deleteAll() {
            elasticsearchOptionSearchRepository.deleteAll();
        }
    
        @Override
        public Iterable<ElasticsearchOption> getAll() {
            return elasticsearchOptionSearchRepository.findAll();
        }
    
        /**
         * 单字段匹配
         *
         * @param name
         * @return
         */
        @Override
        public List<ElasticsearchOption> getByName(String name) {
            //其中QueryBuilder是一个接口，常用的实现类有MatchQueryBuilder、RangeQueryBuilder范围、FuzzyQueryBuilder模糊、WildcardQueryBuilder模糊。
            List<ElasticsearchOption> list = new ArrayList<>();
            TermQueryBuilder termQuery = new TermQueryBuilder("did", name);
            Iterable<ElasticsearchOption> iterable = elasticsearchOptionSearchRepository.search(termQuery);
            iterable.forEach(e -> list.add(e));
            return list;
        }
    
    
        @Override
        public Page<ElasticsearchOption> pageQuery(Integer pageNo, Integer pageSize, String kw) {
            SearchQuery searchQuery = new NativeSearchQueryBuilder()
                    .withQuery(QueryBuilders.matchPhraseQuery("name", kw))
                    .withPageable(PageRequest.of(pageNo, pageSize))
                    .build();
            return elasticsearchOptionSearchRepository.search(searchQuery);
        }
    
        /**
         * 多个条件查询
         * 使用QueryBuilder
         * termQuery("key", obj) 完全匹配
         * termsQuery("key", obj1, obj2..)   一次匹配多个值
         * matchQuery("key", Obj) 单个匹配, field不支持通配符, 前缀具高级特性
         * multiMatchQuery("text", "field1", "field2"..);  匹配多个字段, field有通配符忒行
         * matchAllQuery();     匹配所有文件
         * @param map
         * @return
         */
        @Override
        public List<ElasticsearchOption> getByMoreName(Map<String, String> map) {
            SearchRequestBuilder srb = transportClient.prepareSearch("sunyardelasticsearchoption").setTypes("elasticsearchoption");
            QueryBuilder queryBuilder = QueryBuilders.termQuery("did", map.get("did"));
            QueryBuilder queryBuilder2 = QueryBuilders.matchPhraseQuery("valueDescription", map.get("valueDescription"));
            SearchResponse sr = srb.setQuery(QueryBuilders.boolQuery()
                    .must(queryBuilder)
                    .must(queryBuilder2))
                    .execute()
                    .actionGet();
            SearchHits hits = sr.getHits();
            List<ElasticsearchOption> elasticsearchOptionList=new ArrayList<>();
            for (SearchHit hit : hits) {
                if (StringUtils.isNotBlank(hit.getSourceAsString())) {
                    //使用ES的java接口将实体类对应的内容转换为json字符串
                    String content = hit.getSourceAsString();
                    JSONObject elasticJson = JSONObject.parseObject(content);
                    ElasticsearchOption elasticsearchOption = JSON.toJavaObject(elasticJson,ElasticsearchOption.class);
                    elasticsearchOptionList.add(elasticsearchOption);
                }
    
            }
            return elasticsearchOptionList;
        }
    
    }

4.下载elasticsearch服务端程序，https://www.elastic.co/cn/downloads/。 我这是windows系统，直接下载ZIP包，解压以后，需要改几处配置文件：  
将elasticsearch.yml里面的部分配置文件注释去掉：  
cluster.name: 集群名称，需要跟代码的配置里面保持一致  
node.name: 节点名称  
network.host： ip地址，写本机ip即可  
http.port： http协议走的端口，需要跟yml配置一致，默认是9200  
新加两个配置： tcp协议走的端口  
transport.tcp.port: 9300  
transport.tcp.compress: true

5。先启动elasticsearch服务（elasticsearch.bat），服务正常启动以后。启动我们的程序，程序里面有test方法，可以进行测试，增删改查都有。  
elasticsearch启动成功以后，访问ip+端口，出现如下界面，代表启动成功  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L1pfX1NoZW5n_size_16_color_FFFFFF_t_70 2]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L1pfX1NoZW5n_size_16_color_FFFFFF_t_70]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/11/0082e72325394d8a85cba3235e004edd.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L1pfX1NoZW5n_size_16_color_FFFFFF_t_70 1]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/11/6bf594094ffc442899a6f4f49adc764e.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L1pfX1NoZW5n_size_16_color_FFFFFF_t_70 2]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/11/69fd50ebd519484a93cdf806afb017fc.png