Elastic Search搜索引擎在SpringBoot中的實踐
實驗環境
- ES版本:5.3.0
- spring bt版本:1.5.9
首先當然需要安裝好elastic search環境,最好再安裝上可視化插件 elasticsearch-head來便於我們直觀地查看數據。
當然這部分可以參考本人的帖子:
《centos7上elastic search安裝填坑記》
https://www.jianshu.com/p/04f4d7b4a1d3
我的ES安裝在http://113.209.119.170:9200/這個地址(該地址需要配到springboot項目中去)
Spring工程創建
這部分沒有特殊要交代的,但有幾個註意點一定要當心
- 註意在新建項目時記得勾選web和NoSQL中的Elasticsearch依賴,來張圖說明一下吧:
項目自動生成以後pom.xml中會自動添加spring-boot-starter-data-elasticsearch
的依賴:
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-data-elasticsearch</artifactId>
</dependency>
-
本項目中我們使用開源的基於restful的es java客戶端
jest
jest
依賴:<dependency> <groupId>io.searchbox</groupId> <artifactId>jest</artifactId> </dependency>
- 除此之外還必須添加
jna
的依賴:<dependency> <groupId>net.java.dev.jna</groupId> <artifactId>jna</artifactId> </dependency>
否則啟動spring項目的時候會報JNA not found. native methods will be disabled.
的錯誤:
- 項目的配置文件application.yml中需要把es服務器地址配置對
server: port: 6325
spring:
elasticsearch:
jest:
uris:
- http://113.209.119.170:9200 # ES服務器的地址!
read-timeout: 5000
代碼組織
我的項目代碼組織如下:
各部分代碼詳解如下,註釋都有:
- Entity.java
package com.hansonwang99.springboot_es_demo.entity;
import java.io.Serializable;
import org.springframework.data.elasticsearch.annotations.Document;
public class Entity implements Serializable{
private static final long serialVersionUID = -763638353551774166L;
public static final String INDEX_NAME = "index_entity";
public static final String TYPE = "tstype";
private Long id;
private String name;
public Entity() {
super();
}
public Entity(Long id, String name) {
this.id = id;
this.name = name;
}
public Long getId() {
return id;
}
public void setId(Long id) {
this.id = id;
}
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
}
- TestService.java
package com.hansonwang99.springboot_es_demo.service;
import com.hansonwang99.springboot_es_demo.entity.Entity;
import java.util.List;
public interface TestService {
void saveEntity(Entity entity);
void saveEntity(List<Entity> entityList);
List<Entity> searchEntity(String searchContent);
}
- TestServiceImpl.java
package com.hansonwang99.springboot_es_demo.service.impl;
import java.io.IOException;
import java.util.List;
import com.hansonwang99.springboot_es_demo.entity.Entity;
import com.hansonwang99.springboot_es_demo.service.TestService;
import org.elasticsearch.index.query.QueryBuilders;
import org.elasticsearch.search.builder.SearchSourceBuilder;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import io.searchbox.client.JestClient;
import io.searchbox.client.JestResult;
import io.searchbox.core.Bulk;
import io.searchbox.core.Index;
import io.searchbox.core.Search;
@Service
public class TestServiceImpl implements TestService {
private static final Logger LOGGER = LoggerFactory.getLogger(TestServiceImpl.class);
@Autowired
private JestClient jestClient;
@Override
public void saveEntity(Entity entity) {
Index index = new Index.Builder(entity).index(Entity.INDEX_NAME).type(Entity.TYPE).build();
try {
jestClient.execute(index);
LOGGER.info("ES 插入完成");
} catch (IOException e) {
e.printStackTrace();
LOGGER.error(e.getMessage());
}
}
/**
* 批量保存內容到ES
*/
@Override
public void saveEntity(List<Entity> entityList) {
Bulk.Builder bulk = new Bulk.Builder();
for(Entity entity : entityList) {
Index index = new Index.Builder(entity).index(Entity.INDEX_NAME).type(Entity.TYPE).build();
bulk.addAction(index);
}
try {
jestClient.execute(bulk.build());
LOGGER.info("ES 插入完成");
} catch (IOException e) {
e.printStackTrace();
LOGGER.error(e.getMessage());
}
}
/**
* 在ES中搜索內容
*/
@Override
public List<Entity> searchEntity(String searchContent){
SearchSourceBuilder searchSourceBuilder = new SearchSourceBuilder();
//searchSourceBuilder.query(QueryBuilders.queryStringQuery(searchContent));
//searchSourceBuilder.field("name");
searchSourceBuilder.query(QueryBuilders.matchQuery("name",searchContent));
Search search = new Search.Builder(searchSourceBuilder.toString())
.addIndex(Entity.INDEX_NAME).addType(Entity.TYPE).build();
try {
JestResult result = jestClient.execute(search);
return result.getSourceAsObjectList(Entity.class);
} catch (IOException e) {
LOGGER.error(e.getMessage());
e.printStackTrace();
}
return null;
}
}
- EntityController.java
package com.hansonwang99.springboot_es_demo.controller;
import java.util.ArrayList;
import java.util.List;
import com.hansonwang99.springboot_es_demo.entity.Entity;
import com.hansonwang99.springboot_es_demo.service.TestService;
import org.apache.commons.lang.StringUtils;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RestController;
@RestController
@RequestMapping("/entityController")
public class EntityController {
@Autowired
TestService cityESService;
@RequestMapping(value="/save", method=RequestMethod.GET)
public String save(long id, String name) {
System.out.println("save 接口");
if(id>0 && StringUtils.isNotEmpty(name)) {
Entity newEntity = new Entity(id,name);
List<Entity> addList = new ArrayList<Entity>();
addList.add(newEntity);
cityESService.saveEntity(addList);
return "OK";
}else {
return "Bad input value";
}
}
@RequestMapping(value="/search", method=RequestMethod.GET)
public List<Entity> save(String name) {
List<Entity> entityList = null;
if(StringUtils.isNotEmpty(name)) {
entityList = cityESService.searchEntity(name);
}
return entityList;
}
}
實際實驗
增加幾條數據,可以使用postman工具,也可以直接在瀏覽器中輸入,如增加以下5條數據:
http://localhost:6325/entityController/save?id=1&name=南京中山陵
http://localhost:6325/entityController/save?id=2&name=中國南京師範大學
http://localhost:6325/entityController/save?id=3&name=南京夫子廟
http://localhost:6325/entityController/save?id=4&name=杭州也非常不錯
http://localhost:6325/entityController/save?id=5&name=中國南邊好像沒有叫帶京字的城市了
數據插入效果如下(使用可視化插件elasticsearch-head觀看):
我們來做一下搜索的測試:例如我要搜索關鍵字“南京”
我們在瀏覽器中輸入:
http://localhost:6325/entityController/search?name=南京
搜索結果如下:
剛才插入的5條記錄中包含關鍵字“南京”的四條記錄均被搜索出來了!
當然這裏用的是standard分詞方式,將每個中文都作為了一個term,凡是包含“南”、“京”關鍵字的記錄都被搜索了出來,只是評分不同而已,當然還有其他的一些分詞方式,此時需要其他分詞插件的支持,此處暫不涉及,後文中再做探索。
Elastic Search搜索引擎在SpringBoot中的實踐