springboot 与检索—使用、原理、整合ElasticSearch

朱雀 2022-05-08 09:04 314阅读 0赞

ElasticSearch--全文搜索引擎的首选：面向文档，它存储整个对象或文档。使用json作为文档的序列化格式（一个json文档就代表一个对象）。

springboot（版本：2.0.2.RELEASE）整合elasticsearch：

1、springboot默认支持有两种技术来和elasticsearch交互（Jest/SpringData ElasticSearch）

![70][]

Jest默认不生效@ConditionalOnClass(\{JestClient.class\}) 需要导入Jest工具包：io.searchbox.client.JestClient;

![70 1][]

2、使用SpringData ElasticSearch与ElasticSearch交互原理

![70 2][]

ElasticsearchAutoConfiguration ：自动配置了客户端TransportClient，需要配置节点信息 clusterName、clusterNodes

![70 3][]

写个接口继承该接口，就会有ElasticsearchCrudRepository （可以对elasticsearch的增删改查操作）

![70 4][]

ElasticsearchRepositoriesAutoConfiguration：启用了ElasticsearchRepository（类似于jpa的编程方式）的接口，可以编写一个ElasticsearchRepository的子接口来操作ES。

3、以Jest方式与ES交互测试

1）注释spring-boot-starter-data-elasticsearch ，引入Jest包

<dependency>
       	<groupId>io.searchbox</groupId>
       	<artifactId>jest</artifactId>
       	<version>6.3.0</version>
    </dependency>

2）引入Jest包后JestAutoConfiguration 该自动配置将生效，生效后需要配置相应的属性

#地址
    spring.elasticsearch.jest.uris=http://localhost:9200

3）启动项目

![70 5][]

4）测试（jest官方文档：https://github.com/searchbox-io/Jest/tree/master/jest）

package com.example.bean;
    
    import io.searchbox.annotations.JestId;
    
    public class Article {
        //给id字段添加注解，@JestId表示这是一个主键
        @JestId
        private Integer id;
        private String author;
        private String title;
        private String content;
    
        public Integer getId() {
            return id;
        }
    
        public void setId(Integer id) {
            this.id = id;
        }
    
        public String getAuthor() {
            return author;
        }
    
        public void setAuthor(String author) {
            this.author = author;
        }
    
        public String getTitle() {
            return title;
        }
    
        public void setTitle(String title) {
            this.title = title;
        }
    
        public String getContent() {
            return content;
        }
    
        public void setContent(String content) {
            this.content = content;
        }
    }

索引文档

@RunWith(SpringRunner.class)
    @SpringBootTest
    public class SpringbootApplicationTests implements Serializable {
        @Autowired
    	JestClient jestClient;
    
    	@Test
    	public void jestTest() {
    		//1、给ES中索引（保存）一个文档
    		Article article = new Article();
    		article.setId(1);
    		article.setTitle("好消息");
    		article.setAuthor("zhansan");
    		article.setContent("Hello World");
    
    		//构建一个索引功能 ：Index.Builder(保存的内容).index(指定索引位置).type(指定类型).id(指定id).build()
    		Index index = new Index.Builder(article).index("mytest").type("news").build();
    
    		try {
    			//执行
    			jestClient.execute(index);
    		} catch (Exception e) {
    			e.printStackTrace();
    		}
    	}
    }

根据索引/类型/id检索

![70 6][]

测试查询

@Test
    public void search(){
    	//查询表达式
    	String json = "{\n" +
    			"    \"query\" : {\n" +
    			"    	\"match\" : {\n" +
    			"    		\"content\" : \"hello\"\n" +
    			"    	}\n" +
    			"    }\n" +
    			"}";
    	//构建搜索功能
    	Search search = new Search.Builder(json).addIndex("mytest").addType("news").build();
    	try {
    		//执行
    		SearchResult result = jestClient.execute(search);
    		System.out.println(result.getJsonString());
    	} catch (Exception e) {
    		e.printStackTrace();
    	}
    }

运行结果如下 ：

![70 7][]

4、以Spring Data方式与ES交互测试

1）引入依赖

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

2）配置

spring.data.elasticsearch.cluster-name=elasticsearch
    spring.data.elasticsearch.cluster-nodes=localhost:9300

3）版本适配说明（https://github.com/spring-projects/spring-data-elasticsearch）

![70 8][]

如果版本不适配：升级springboot版本或安装对应版本的ES

package com.example.config;
    
    import org.springframework.context.annotation.Configuration;
    
    import javax.annotation.PostConstruct;
    
    @Configuration
    public class ElasticSearchConfig {
        @PostConstruct
        void init() {
            System.setProperty("es.set.netty.runtime.available.processors", "false");
        }
    }

4）编写一个ElasticRepository的子接口（参考文档：https://github.com/spring-projects/spring-data-elasticsearch）

package com.example.repository;
    
    import com.example.bean.BookTest;
    import org.springframework.data.elasticsearch.repository.ElasticsearchRepository;
    
    import java.util.List;
    
    public interface BookRepository extends ElasticsearchRepository <BookTest,Integer>{
        public List<BookTest> findByBookNameLike(String bookName);//自定义方法
    }

测试：

package com.example.bean;
    
    import org.springframework.data.elasticsearch.annotations.Document;
    //标注存储地址
    @Document(indexName = "mytest",type="book")
    public class BookTest {
        private Integer id;
        private String bookName;
        private String author;
    
        @Override
        public String toString() {
            return "BookTest{" +
                    "id=" + id +
                    ", bookName='" + bookName + '\'' +
                    ", author='" + author + '\'' +
                    '}';
        }
    
        public Integer getId() {
            return id;
        }
    
        public void setId(Integer id) {
            this.id = id;
        }
    
        public String getBookName() {
            return bookName;
        }
    
        public void setBookName(String bookName) {
            this.bookName = bookName;
        }
    
        public String getAuthor() {
            return author;
        }
    
        public void setAuthor(String author) {
            this.author = author;
        }
    }

运行测试方法：

@RunWith(SpringRunner.class)
    @SpringBootTest
    public class SpringbootApplicationTests implements Serializable {
        @Autowired
    	BookRepository bookRepository;
    
    	@Test
    	public void test03(){
    		/*for(BookTest bookTest : bookRepository.findByBookNameLike("游")){
    			System.out.println(bookTest);
    		}*///自定义方法测试
    		BookTest bookTest = new BookTest();
    		bookTest.setId(1);
    		bookTest.setBookName("西游记");
    		bookTest.setAuthor("吴承恩");
    		bookRepository.index(bookTest);
    	}
    }

查看elasticsearch中的值

![70 9][]

BookRepository中的基本方法：

![70 10][]

5）自定义方法命名规则参考参考文档https://docs.spring.io/spring-data/elasticsearch/docs/3.0.9.RELEASE/reference/html/

![70 11][]

[70]: /images/20220508/1a8623eccaa74d5b9c0afeea56d98d29.png
[70 1]: /images/20220508/8543c982a16a415b94363d6035053082.png
[70 2]: /images/20220508/058dbcce94dd473b938725db8fb4cea1.png
[70 3]: /images/20220508/3a23ffc48e3046a39837f994ed026af4.png
[70 4]: /images/20220508/4513bb928ea146e7be6a62f7676281d5.png
[70 5]: /images/20220508/1a712fe572eb455c8c2d49837ed52817.png
[70 6]: /images/20220508/8c8479b674bc4541b1b356347d88f34b.png
[70 7]: /images/20220508/01db900902924969b74be852abed1a66.png
[70 8]: /images/20220508/6514794a9a2f4c25990740b5d11eba07.png
[70 9]: /images/20220508/5a043d5bf71a40dda7034c9840fa4e43.png
[70 10]: /images/20220508/bd782d267ab443a68ef40e85d16481c5.png
[70 11]: /images/20220508/7a0ced5af30d4bcc9955ded013bca227.png