Spring集成ElasticSearch搜索引擎

2023-08-16,,

目录
前期安装
Maven支持库安装
添加log4j的配置文件
创建Client客户端
实现增删改查以及符合查询
实现查询数据
实现添加数据
实现删除数据
实现修改数据
实现复合查询数据

ElasticSearch是一个基于Lucene的搜索服务器。它提供了一个分布式多用户能力的全文搜索引擎,基于RESTful web接口。Elasticsearch是用Java开发的,并作为Apache许可条款下的开放源码发布,是当前流行的企业级搜索引擎。设计用于云计算中,能够达到实时搜索,稳定,可靠,快速,安装使用方便。

我们建立一个网站或应用程序,并要添加搜索功能,但是想要完成搜索工作的创建是非常困难的。我们希望搜索解决方案要运行速度快,我们希望能有一个零配置和一个完全免费的搜索模式,我们希望能够简单地使用JSON通过HTTP来索引数据,我们希望我们的搜索服务器始终可用,我们希望能够从一台开始并扩展到数百台,我们要实时搜索,我们要简单的多租户,我们希望建立一个云的解决方案。因此我们利用Elasticsearch来解决所有这些问题以及可能出现的更多其它问题。

我们需要将这中搜索模式集中到我们的项目中去,从而实现大量数据的搜索功能,性能远远超越数据库查询!

ElasticSearch : You Know, for Search!

前期安装

这里安装不在过多的赘述,这里推荐官方的中文文档,安装指引 安装完成之后,运行启动,打开浏览器,访问http://localhost:9200 将看到一下信息(cluster_name非常重要后面的代码要用到):

{
"name" : "2g-ucq2",
"cluster_name" : "elasticsearch",
"cluster_uuid" : "tpMpsSenRpaBPugKlG7QaA",
"version" : {
"number" : "5.5.0",
"build_hash" : "260387d",
"build_date" : "2017-06-30T23:16:05.735Z",
"build_snapshot" : false,
"lucene_version" : "6.6.0"
},
"tagline" : "You Know, for Search"
}

Maven支持库安装

我们使用Maven,因此需要修改POM文件内容,添加如下依赖即可。

        <!--ElasticSearch支持文件-->
<dependency>
<groupId>org.elasticsearch.client</groupId>
<artifactId>transport</artifactId>
<version>5.5.0</version>
</dependency> <dependency>
<groupId>org.apache.logging.log4j</groupId>
<artifactId>log4j-core</artifactId>
<version>2.7</version>
</dependency>

添加log4j的配置文件

在classpath源目录下创建log4j2.properties文件,内容信息如下

appender.console.type =Console
appender.console.name =Console
appender.console.layout.type =PatternLayout
appender.console.layout.pattern = [%t] %-5p %c - %m%n rootLogger.lever = info
rootLogger.appenderRef.console.ref = Console

创建Client客户端

我们将核心的client对象,使用配置注解进行配置,方便日后取用

package com.tao.spring.config;

import org.elasticsearch.client.transport.TransportClient;
import org.elasticsearch.common.settings.Settings;
import org.elasticsearch.common.transport.InetSocketTransportAddress;
import org.elasticsearch.transport.client.PreBuiltTransportClient;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration; import java.net.InetAddress;
import java.net.UnknownHostException; /**
* 本文件由周涛创建,位于com.tao.spring.config包下
* 创建时间2018/1/26 20:42
* 邮箱:zhoutao@xiaodouwangluo.com
* 作用:创建ES的client对象,方便后期使用
*/ @Configuration
public class ElasticSearchConfig { @Bean
public TransportClient client() throws UnknownHostException{
//注意这里的端口是TCP端口9300,而非HTTP接口9200
InetSocketTransportAddress node = new InetSocketTransportAddress(InetAddress.getByName("localhost"),9300);
//机器名称,可以首页查询,这个不能出现错误,否则无法连接ES
Settings settings=Settings.builder().put("cluster.name","elasticsearch").build();
TransportClient client = new PreBuiltTransportClient( settings);
client.addTransportAddress(node);
return client;
}
}

实现增删改查以及符合查询

下面将依次实现数据的增删改查,以及符合查询,这里我们的的类型是book,其具有两个属性分别是bookid和bookprice,具体说明参考注释。

首先需要注入对象

    @Autowired
TransportClient client;

实现查询数据

需求:实现根据bookid获取数据的信息

/**
* 使用ES进行简单的搜索操作
* @param bookid
* @return
*/
@RequestMapping(value = "/get",method = RequestMethod.GET,produces = MediaType.APPLICATION_JSON_UTF8_VALUE)
@ResponseBody
public String getInfoById(@RequestParam(name = "bookid") String bookid){
if (Strings.isNullOrEmpty(bookid)){
return "缺少参数,或参数格式不正确";
}
//tao指定的书索引,book指的是类型,后面相同,不在做叙述
GetResponse getFields = client.prepareGet("tao", "book", bookid).get();
//这里需要做些判断,没有没有判断,在没有查到的情况,会抛出异常信息
if ( getFields ==null || !getFields.isExists()){
return "没有查询到结果信息";
}else{
return getFields.getSource().toString();
}
}

实现添加数据

需求:提供bookid和bookprice来插入数据到ES

/**
* 插入一条数据到ES中
* @param bookid
* @param bookprice
* @return
**/
@RequestMapping(value = "/add",method = RequestMethod.GET,produces = MediaType.APPLICATION_JSON_UTF8_VALUE)
@ResponseBody
public String addInfoToES(String bookid,float bookprice){
if (Strings.isNullOrEmpty(bookid) || bookprice <= 0){
return "参数不存在或者参数格式异常!";
} try {
//构造JSON数据,方便使用
XContentBuilder xContentBuilder = XContentFactory.jsonBuilder().startObject()
.field("bookid", bookid)
.field("bookprice", bookprice)
.endObject();
IndexResponse indexResponse = client.prepareIndex("tao","book").setSource(xContentBuilder).get();
return "新增图书信息完成,图书信息ID为:"+indexResponse.getId(); }catch (IOException ex){
ex.printStackTrace();
return "新增图书信息失败,失败信息:"+ex.getMessage();
} }

实现删除数据

需求:根据给定的id,来删除数据信息

    /**
* 从ES中删除一条数据
* @param bookid
* @return
*/
@RequestMapping(value = "/del",method = RequestMethod.GET,produces = MediaType.APPLICATION_JSON_UTF8_VALUE)
@ResponseBody
public String delInfo(String bookid){
if (Strings.isNullOrEmpty(bookid)){
return "参数不存在或者参数异常";
}
DeleteResponse deleteResponse = client.prepareDelete("tao", "book", bookid).get();
//将会返回两个结果:NOT_FOUND 未发现 DELETED 已删除
return deleteResponse.getResult().toString() ;
}

实现修改数据

修改指定id的数据信息

    /**
* 根据Id简单的修改信息
* @param bookid
* @param bookprice
* @return
*/
@RequestMapping(value = "/modify",method = RequestMethod.GET,produces = MediaType.APPLICATION_JSON_UTF8_VALUE)
@ResponseBody
public String nodify(String bookid,@RequestParam(required = false) Float bookprice){ UpdateRequest request = new UpdateRequest("tao","book",bookid);
try {
XContentBuilder xContentBuilder = XContentFactory.jsonBuilder().startObject();
if (bookprice.floatValue() <= 0){
return "参数异常或者参数格式错误!";
}else {
xContentBuilder.field("bookprice",bookprice).endObject();
}
request.doc(xContentBuilder);
UpdateResponse updateResponse = client.update(request).get();
return updateResponse.getResult().toString(); }catch (Exception e) {
e.printStackTrace();
return "更新数据出现异常,异常信息:"+e.getMessage();
}
}

实现复合查询数据

需求:精准查询bookid,范围查询bookprice,gt_bookprice 最小的价格,lt_bookprice 最大价格

    /**
* 使用ES进行复杂查询
* @param bookid
* @param gt_bookprice
* @param lt_bookprice
* @return
*/
@RequestMapping(value = "/getConditon",method = RequestMethod.GET,produces = MediaType.APPLICATION_JSON_UTF8_VALUE)
@ResponseBody
public String querty(@RequestParam(required = false) String bookid,@RequestParam(defaultValue = "0.0") Float gt_bookprice,@RequestParam(required = false)Float lt_bookprice){
//构造查询条件
BoolQueryBuilder boolQueryBuilder = QueryBuilders.boolQuery();
if (!Strings.isNullOrEmpty(bookid)){
boolQueryBuilder.must(QueryBuilders.matchQuery( "bookid",bookid));
} //构造范围查询
RangeQueryBuilder rangeQuery = QueryBuilders.rangeQuery("bookprice").from(gt_bookprice,true);
if(lt_bookprice!=null && lt_bookprice.floatValue() > 0){
rangeQuery.to(lt_bookprice);
}
//整合为一个查询条件
boolQueryBuilder.filter(rangeQuery); SearchRequestBuilder searchRequestBuilder = client.prepareSearch("tao")
.setTypes("book")
.setSearchType(SearchType.DFS_QUERY_THEN_FETCH)
.setQuery(boolQueryBuilder)
.setFrom(0)
.setSize(10);
//可以直接输出,方便查看请求体
System.out.println("查询条件:"+searchRequestBuilder);
SearchResponse searchResponse = searchRequestBuilder.get();
List<Map> result = new ArrayList<>();
//从查询接口中遍历数据进行封装操作
for (SearchHit hitFields:searchResponse.getHits()){
result.add(hitFields.getSource());
}
return result.toString();
}

Spring集成ElasticSearch搜索引擎的相关教程结束。

《Spring集成ElasticSearch搜索引擎.doc》

下载本文的Word格式文档,以方便收藏与打印。