网站建设 艺麟盛世/中国职业技能培训中心官网
springboot 快速集成 es
- 环境准备
- 代码块
- pom依赖
- application.properties
- 实体定义
- 查询页码辅助定义
- es 工具
- controller 定义
- 测试
- kibana 查数据
环境准备
Mac 安装 es、kibana 请参考 Mac 搭建 ES
Windows 环境自行google
代码块
pom依赖
<!--es--><!-- https://mvnrepository.com/artifact/org.elasticsearch/elasticsearch --><dependency><groupId>org.elasticsearch</groupId><artifactId>elasticsearch</artifactId><version>6.8.6</version></dependency><!-- https://mvnrepository.com/artifact/org.elasticsearch.client/transport --><dependency><groupId>org.elasticsearch.client</groupId><artifactId>transport</artifactId><version>6.8.6</version><exclusions><exclusion><groupId>org.elasticsearch</groupId><artifactId>elasticsearch</artifactId></exclusion></exclusions></dependency><!-- fastjson --><dependency><groupId>com.alibaba</groupId><artifactId>fastjson</artifactId><version>1.2.39</version></dependency><dependency><groupId>org.apache.commons</groupId><artifactId>commons-lang3</artifactId><version>3.4</version></dependency><!-- https://mvnrepository.com/artifact/org.projectlombok/lombok --><dependency><groupId>org.projectlombok</groupId><artifactId>lombok</artifactId><version>1.16.20</version></dependency><dependency><groupId>commons-httpclient</groupId><artifactId>commons-httpclient</artifactId><version>3.1</version></dependency>
application.properties
# Elasticsearch
# 9200端口是用来让HTTP REST API来访问ElasticSearch,而9300端口是传输层监听的默认端口
elasticsearch.ip=127.0.0.1
elasticsearch.port=9300
elasticsearch.pool=1
#注意cluster.name需要与config/elasticsearch.yml中的cluster.name一致 (Mac brew install es config路径/usr/local/etc/elasticsearch/)
elasticsearch.cluster.name=elasticsearch_admin
实体定义
package com.example.demo.es;import lombok.Data;
import lombok.NoArgsConstructor;
import lombok.ToString;/*** @Description:Book实体 加上了@Document注解之后,默认情况下这个实体中所有的属性都会被建立索引、并且分词*/
@Data
@ToString
@NoArgsConstructor
public class Employee {private String id;private Long version;String firstName;String lastName;String age;String[] interests;
}
查询页码辅助定义
package com.example.demo.es;import lombok.Data;
import lombok.ToString;import java.util.List;
import java.util.Map;@Data
@ToString
public class EsPage {/*** 当前页*/private int currentPage;/*** 每页显示多少条*/private int pageSize;/*** 总记录数*/private int recordCount;/*** 本页的数据列表*/private List<Map<String, Object>> recordList;/*** 总页数*/private int pageCount;/*** 页码列表的开始索引(包含)*/private int beginPageIndex;/*** 页码列表的结束索引(包含)*/private int endPageIndex;/*** 只接受前4个必要的属性,会自动的计算出其他3个属性的值** @param currentPage* @param pageSize* @param recordCount* @param recordList*/public EsPage(int currentPage, int pageSize, int recordCount, List<Map<String, Object>> recordList) {this.currentPage = currentPage;this.pageSize = pageSize;this.recordCount = recordCount;this.recordList = recordList;// 计算总页码pageCount = (recordCount + pageSize - 1) / pageSize;// 计算 beginPageIndex 和 endPageIndex// >> 总页数不多于10页,则全部显示if (pageCount <= 10) {beginPageIndex = 1;endPageIndex = pageCount;}// 总页数多于10页,则显示当前页附近的共10个页码else {// 当前页附近的共10个页码(前4个 + 当前页 + 后5个)beginPageIndex = currentPage - 4;endPageIndex = currentPage + 5;// 当前面的页码不足4个时,则显示前10个页码if (beginPageIndex < 1) {beginPageIndex = 1;endPageIndex = 10;}// 当后面的页码不足5个时,则显示后10个页码if (endPageIndex > pageCount) {endPageIndex = pageCount;beginPageIndex = pageCount - 10 + 1;}}}
}
es 工具
package com.example.demo.es;import com.alibaba.fastjson.JSONObject;
import org.apache.commons.lang3.StringUtils;
import org.elasticsearch.action.admin.indices.create.CreateIndexResponse;
//import org.elasticsearch.action.admin.indices.delete.DeleteIndexResponse;
import org.elasticsearch.action.admin.indices.exists.indices.IndicesExistsRequest;
import org.elasticsearch.action.admin.indices.exists.indices.IndicesExistsResponse;
import org.elasticsearch.action.delete.DeleteResponse;
import org.elasticsearch.action.get.GetRequestBuilder;
import org.elasticsearch.action.get.GetResponse;
import org.elasticsearch.action.index.IndexResponse;
import org.elasticsearch.action.search.SearchRequestBuilder;
import org.elasticsearch.action.search.SearchResponse;
import org.elasticsearch.action.search.SearchType;
import org.elasticsearch.action.update.UpdateRequest;
import org.elasticsearch.client.transport.TransportClient;
import org.elasticsearch.common.settings.Settings;
import org.elasticsearch.common.text.Text;
import org.elasticsearch.common.transport.TransportAddress;
import org.elasticsearch.index.query.QueryBuilder;
import org.elasticsearch.search.SearchHit;
import org.elasticsearch.search.fetch.subphase.highlight.HighlightBuilder;
import org.elasticsearch.search.sort.SortOrder;
import org.elasticsearch.transport.client.PreBuiltTransportClient;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;import javax.annotation.PostConstruct;
import java.net.InetAddress;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.UUID;@Component
public class ElasticsearchUtil {private static final Logger LOGGER = LoggerFactory.getLogger(ElasticsearchUtil.class);private static TransportClient client;/*** elk集群地址*/@Value("${elasticsearch.ip}")private String hostName;/*** 端口*/@Value("${elasticsearch.port}")private String port;/*** 集群名称*/@Value("${elasticsearch.cluster.name}")private String clusterName;/*** 连接池*/@Value("${elasticsearch.pool}")private String poolSize;/*** @PostContruct是spring框架的注解 spring容器初始化的时候执行该方法*/@PostConstructpublic void init() {TransportClient transportClient = null;try {// 配置信息Settings esSetting = Settings.builder().put("cluster.name", clusterName) //集群名字.put("client.transport.sniff", true)//增加嗅探机制,找到ES集群.put("thread_pool.search.size", Integer.parseInt(poolSize))//增加线程池个数,暂时设为5.build();//配置信息Settings自定义transportClient = new PreBuiltTransportClient(esSetting);TransportAddress transportAddress = new TransportAddress(InetAddress.getByName(hostName), Integer.valueOf(port));transportClient.addTransportAddresses(transportAddress);} catch (Exception e) {LOGGER.error("elasticsearch TransportClient create error!!", e);}client = transportClient;}/*** 创建索引** @param index* @return*/public static boolean createIndex(String index) {if (!isIndexExist(index)) {LOGGER.info("Index is not exits!");}CreateIndexResponse indexresponse = client.admin().indices().prepareCreate(index).execute().actionGet();LOGGER.info("执行建立成功?" + indexresponse.isAcknowledged());return indexresponse.isAcknowledged();}/*** 删除索引** @param index* @return*/public static boolean deleteIndex(String index) {if (!isIndexExist(index)) {LOGGER.info("Index is not exits!");}
// DeleteIndexResponse dResponse = client.admin().indices().prepareDelete(index).execute().actionGet();
// if (dResponse.isAcknowledged()) {
// LOGGER.info("delete index " + index + " successfully!");
// } else {
// LOGGER.info("Fail to delete index " + index);
// }
// return dResponse.isAcknowledged();return false;}/*** 判断索引是否存在** @param index* @return*/public static boolean isIndexExist(String index) {IndicesExistsResponse inExistsResponse = client.admin().indices().exists(new IndicesExistsRequest(index)).actionGet();if (inExistsResponse.isExists()) {LOGGER.info("Index [" + index + "] is exist!");} else {LOGGER.info("Index [" + index + "] is not exist!");}return inExistsResponse.isExists();}/*** @Description: 判断inde下指定type是否存在*/public boolean isTypeExist(String index, String type) {return isIndexExist(index)? client.admin().indices().prepareTypesExists(index).setTypes(type).execute().actionGet().isExists(): false;}/*** 数据添加,正定ID** @param jsonObject 要增加的数据* @param index 索引,类似数据库* @param type 类型,类似表* @param id 数据ID* @return*/public static String addData(JSONObject jsonObject, String index, String type, String id) {IndexResponse response = client.prepareIndex(index, type, id).setSource(jsonObject).get();LOGGER.info("addData response status:{},id:{}", response.status().getStatus(), response.getId());return response.getId();}/*** 数据添加** @param jsonObject 要增加的数据* @param index 索引,类似数据库* @param type 类型,类似表* @return*/public static String addData(JSONObject jsonObject, String index, String type) {return addData(jsonObject, index, type, UUID.randomUUID().toString().replaceAll("-", "").toUpperCase());}/*** 通过ID删除数据** @param index 索引,类似数据库* @param type 类型,类似表* @param id 数据ID*/public static void deleteDataById(String index, String type, String id) {DeleteResponse response = client.prepareDelete(index, type, id).execute().actionGet();LOGGER.info("deleteDataById response status:{},id:{}", response.status().getStatus(), response.getId());}/*** 通过ID 更新数据** @param jsonObject 要增加的数据* @param index 索引,类似数据库* @param type 类型,类似表* @param id 数据ID* @return*/public static void updateDataById(JSONObject jsonObject, String index, String type, String id) {UpdateRequest updateRequest = new UpdateRequest();updateRequest.index(index).type(type).id(id).doc(jsonObject);client.update(updateRequest);}/*** 通过ID获取数据** @param index 索引,类似数据库* @param type 类型,类似表* @param id 数据ID* @param fields 需要显示的字段,逗号分隔(缺省为全部字段)* @return*/public static Map<String, Object> searchDataById(String index, String type, String id, String fields) {GetRequestBuilder getRequestBuilder = client.prepareGet(index, type, id);if (StringUtils.isNotEmpty(fields)) {getRequestBuilder.setFetchSource(fields.split(","), null);}GetResponse getResponse = getRequestBuilder.execute().actionGet();return getResponse.getSource();}/*** 使用分词查询,并分页** @param index 索引名称* @param type 类型名称,可传入多个type逗号分隔* @param startPage 当前页* @param pageSize 每页显示条数* @param query 查询条件* @param fields 需要显示的字段,逗号分隔(缺省为全部字段)* @param sortField 排序字段* @param highlightField 高亮字段* @return*/public static EsPage searchDataPage(String index, String type, int startPage, int pageSize, QueryBuilder query, String fields, String sortField, String highlightField) {SearchRequestBuilder searchRequestBuilder = client.prepareSearch(index);if (StringUtils.isNotEmpty(type)) {searchRequestBuilder.setTypes(type.split(","));}searchRequestBuilder.setSearchType(SearchType.QUERY_THEN_FETCH);// 需要显示的字段,逗号分隔(缺省为全部字段)if (StringUtils.isNotEmpty(fields)) {searchRequestBuilder.setFetchSource(fields.split(","), null);}//排序字段if (StringUtils.isNotEmpty(sortField)) {searchRequestBuilder.addSort(sortField, SortOrder.DESC);}// 高亮(xxx=111,aaa=222)if (StringUtils.isNotEmpty(highlightField)) {HighlightBuilder highlightBuilder = new HighlightBuilder();//highlightBuilder.preTags("<span style='color:red' >");//设置前缀//highlightBuilder.postTags("</span>");//设置后缀// 设置高亮字段highlightBuilder.field(highlightField);searchRequestBuilder.highlighter(highlightBuilder);}//searchRequestBuilder.setQuery(QueryBuilders.matchAllQuery());searchRequestBuilder.setQuery(query);// 分页应用searchRequestBuilder.setFrom(startPage).setSize(pageSize);// 设置是否按查询匹配度排序searchRequestBuilder.setExplain(true);//打印的内容 可以在 Elasticsearch head 和 Kibana 上执行查询LOGGER.info("\n{}", searchRequestBuilder);// 执行搜索,返回搜索响应信息SearchResponse searchResponse = searchRequestBuilder.execute().actionGet();long totalHits = searchResponse.getHits().totalHits;long length = searchResponse.getHits().getHits().length;LOGGER.debug("共查询到[{}]条数据,处理数据条数[{}]", totalHits, length);if (searchResponse.status().getStatus() == 200) {// 解析对象List<Map<String, Object>> sourceList = setSearchResponse(searchResponse, highlightField);return new EsPage(startPage, pageSize, (int) totalHits, sourceList);}return null;}/*** 使用分词查询** @param index 索引名称* @param type 类型名称,可传入多个type逗号分隔* @param query 查询条件* @param size 文档大小限制* @param fields 需要显示的字段,逗号分隔(缺省为全部字段)* @param sortField 排序字段* @param highlightField 高亮字段* @return*/public static List<Map<String, Object>> searchListData(String index, String type, QueryBuilder query, Integer size,String fields, String sortField, String highlightField) {SearchRequestBuilder searchRequestBuilder = client.prepareSearch(index);if (StringUtils.isNotEmpty(type)) {searchRequestBuilder.setTypes(type.split(","));}if (StringUtils.isNotEmpty(highlightField)) {HighlightBuilder highlightBuilder = new HighlightBuilder();// 设置高亮字段highlightBuilder.field(highlightField);searchRequestBuilder.highlighter(highlightBuilder);}searchRequestBuilder.setQuery(query);if (StringUtils.isNotEmpty(fields)) {searchRequestBuilder.setFetchSource(fields.split(","), null);}searchRequestBuilder.setFetchSource(true);if (StringUtils.isNotEmpty(sortField)) {searchRequestBuilder.addSort(sortField, SortOrder.DESC);}if (size != null && size > 0) {searchRequestBuilder.setSize(size);}//打印的内容 可以在 Elasticsearch head 和 Kibana 上执行查询LOGGER.info("\n{}", searchRequestBuilder);SearchResponse searchResponse = searchRequestBuilder.execute().actionGet();long totalHits = searchResponse.getHits().totalHits;long length = searchResponse.getHits().getHits().length;LOGGER.info("共查询到[{}]条数据,处理数据条数[{}]", totalHits, length);if (searchResponse.status().getStatus() == 200) {// 解析对象return setSearchResponse(searchResponse, highlightField);}return null;}/*** 高亮结果集 特殊处理** @param searchResponse* @param highlightField*/private static List<Map<String, Object>> setSearchResponse(SearchResponse searchResponse, String highlightField) {List<Map<String, Object>> sourceList = new ArrayList<Map<String, Object>>();StringBuffer stringBuffer = new StringBuffer();for (SearchHit searchHit : searchResponse.getHits().getHits()) {searchHit.getSourceAsMap().put("id", searchHit.getId());if (StringUtils.isNotEmpty(highlightField)) {System.out.println("遍历 高亮结果集,覆盖 正常结果集" + searchHit.getSourceAsMap());Text[] text = searchHit.getHighlightFields().get(highlightField).getFragments();if (text != null) {for (Text str : text) {stringBuffer.append(str.string());}//遍历 高亮结果集,覆盖 正常结果集searchHit.getSourceAsMap().put(highlightField, stringBuffer.toString());}}sourceList.add(searchHit.getSourceAsMap());}return sourceList;}
}
controller 定义
package com.example.demo.es;import com.alibaba.fastjson.JSONObject;
import org.apache.commons.httpclient.util.DateUtil;
import org.apache.commons.lang3.StringUtils;
import org.elasticsearch.index.query.BoolQueryBuilder;
import org.elasticsearch.index.query.QueryBuilder;
import org.elasticsearch.index.query.QueryBuilders;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;import java.util.Date;
import java.util.List;
import java.util.Map;
import java.util.Random;@RestController
@RequestMapping("/es")
public class EsController {/*** 测试索引*/private String indexName = "ym";/*** 类型*/private String esType = "employee";/*** 创建索引* http://127.0.0.1:8080/es/createIndex** @return*/@RequestMapping("/createIndex")public String createIndex() {if (!ElasticsearchUtil.isIndexExist(indexName)) {ElasticsearchUtil.createIndex(indexName);} else {return "索引已经存在";}return "索引创建成功";}/*** 插入记录** @return*/@RequestMapping("/insertJson")public String insertJson() {JSONObject jsonObject = new JSONObject();jsonObject.put("id", new Random().nextInt(1000000));jsonObject.put("age", 25);jsonObject.put("first_name", "ym-" + new Random().nextInt(1000000));jsonObject.put("last_name", "yuanmeng");jsonObject.put("about", "good good study, day day up");jsonObject.put("date", new Date());String id = ElasticsearchUtil.addData(jsonObject, indexName, esType, jsonObject.getString("id"));return id;}/*** 插入记录** @return*/@RequestMapping("/insertModel")public String insertModel() {Employee employee = new Employee();employee.setId("66");employee.setFirstName("m-" + new Random(100).nextInt());employee.setAge("24");JSONObject jsonObject = (JSONObject) JSONObject.toJSON(employee);String id = ElasticsearchUtil.addData(jsonObject, indexName, esType, jsonObject.getString("id"));return id;}/*** 删除记录** @return*/@RequestMapping("/delete")public String delete(String id) {if (StringUtils.isNotBlank(id)) {ElasticsearchUtil.deleteDataById(indexName, esType, id);return "删除id=" + id;} else {return "id为空";}}/*** 更新数据** @return*/@RequestMapping("/update")public String update(String id) {if (StringUtils.isNotBlank(id)) {JSONObject jsonObject = new JSONObject();jsonObject.put("id", id);jsonObject.put("age", 31);jsonObject.put("name", "修改");jsonObject.put("date", new Date());ElasticsearchUtil.updateDataById(jsonObject, indexName, esType, id);return "id=" + id;} else {return "id为空";}}/*** 获取数据* http://127.0.0.1:8080/es/getData?id=2018-04-25%2016:33:44** @param id* @return*/@RequestMapping("/getData")public String getData(String id) {if (StringUtils.isNotBlank(id)) {Map<String, Object> map = ElasticsearchUtil.searchDataById(indexName, esType, id, null);return JSONObject.toJSONString(map);} else {return "id为空";}}/*** 查询数据* 模糊查询** @return*/@RequestMapping("/queryMatchData")public String queryMatchData() {BoolQueryBuilder boolQuery = QueryBuilders.boolQuery();boolean matchPhrase = false;if (matchPhrase == Boolean.TRUE) {//不进行分词搜索boolQuery.must(QueryBuilders.matchPhraseQuery("first_name", "cici"));} else {boolQuery.must(QueryBuilders.matchQuery("last_name", "cici"));}List<Map<String, Object>> list = ElasticsearchUtil.searchListData(indexName, esType, boolQuery, 10, "first_name", null, "last_name");return JSONObject.toJSONString(list);}/*** 通配符查询数据* 通配符查询 ?用来匹配1个任意字符,*用来匹配零个或者多个字符** @return*/@RequestMapping("/queryWildcardData")public String queryWildcardData() {QueryBuilder queryBuilder = QueryBuilders.wildcardQuery("first_name.keyword", "cici");List<Map<String, Object>> list = ElasticsearchUtil.searchListData(indexName, esType, queryBuilder, 10, null, null, null);return JSONObject.toJSONString(list);}/*** 正则查询** @return*/@RequestMapping("/queryRegexpData")public String queryRegexpData() {QueryBuilder queryBuilder = QueryBuilders.regexpQuery("first_name.keyword", "m--[0-9]{1,11}");List<Map<String, Object>> list = ElasticsearchUtil.searchListData(indexName, esType, queryBuilder, 10, null, null, null);return JSONObject.toJSONString(list);}/*** 查询数字范围数据** @return*/@RequestMapping("/queryIntRangeData")public String queryIntRangeData() {BoolQueryBuilder boolQuery = QueryBuilders.boolQuery();boolQuery.must(QueryBuilders.rangeQuery("age").from(24).to(25));List<Map<String, Object>> list = ElasticsearchUtil.searchListData(indexName, esType, boolQuery, 10, null, null, null);return JSONObject.toJSONString(list);}/*** 查询日期范围数据** @return*/@RequestMapping("/queryDateRangeData")public String queryDateRangeData() {BoolQueryBuilder boolQuery = QueryBuilders.boolQuery();boolQuery.must(QueryBuilders.rangeQuery("age").from("20").to("50"));List<Map<String, Object>> list = ElasticsearchUtil.searchListData(indexName, esType, boolQuery, 10, null, null, null);return JSONObject.toJSONString(list);}/*** 查询分页** @param startPage 第几条记录开始* 从0开始* 第1页 :http://127.0.0.1:8080/es/queryPage?startPage=0&pageSize=2* 第2页 :http://127.0.0.1:8080/es/queryPage?startPage=2&pageSize=2* @param pageSize 每页大小* @return*/@RequestMapping("/queryPage")public String queryPage(String startPage, String pageSize) {if (StringUtils.isNotBlank(startPage) && StringUtils.isNotBlank(pageSize)) {BoolQueryBuilder boolQuery = QueryBuilders.boolQuery();boolQuery.must(QueryBuilders.rangeQuery("age").from("20").to("100"));EsPage list = ElasticsearchUtil.searchDataPage(indexName, esType, Integer.parseInt(startPage), Integer.parseInt(pageSize), boolQuery, null, null, null);return JSONObject.toJSONString(list);} else {return "startPage或者pageSize缺失";}}
}
测试
- 创建索引
http://127.0.0.1:8082/es/createIndex
- 插入数据
http://127.0.0.1:8082/es/insertJson
- 查询数据