Elasticsearch常用Java API编程


1 环境准备

预备知识:
1.ElasticSearch快速入门
2.SpringData ElasticSearch
3.ElasticSearch高级操作

要将搜索的功能与前端对接,我们必须要使用Java代码来实现对Elasticsearch的操作。由于之前这些文章中的?JavaApi都是散装的所以用这一篇进行汇总.

官网API地址:
https://www.elastic.co/guide/en/elasticsearch/client/java-rest/7.6/java-rest-high.html

1.1 准备IDEA项目结构

  1. 创建elasticsearch_example项目

  2. 创建包结构如下所示
    在这里插入图片描述

1.2 准备POM依赖

<repositories><!-- 代码库 -->
    <repository>
        <id>aliyun</id>
        <url>http://maven.aliyun.com/nexus/content/groups/public/</url>
        <releases>
            <enabled>true</enabled>
        </releases>
        <snapshots>
            <enabled>false</enabled>
            <updatePolicy>never</updatePolicy>
        </snapshots>
    </repository>
</repositories>

<dependencies>
    <dependency>
        <groupId>org.elasticsearch.client</groupId>
        <artifactId>elasticsearch-rest-high-level-client</artifactId>
        <version>7.6.1</version>
    </dependency>
    <dependency>
        <groupId>org.apache.logging.log4j</groupId>
        <artifactId>log4j-core</artifactId>
        <version>2.11.1</version>
    </dependency>
    <dependency>
        <groupId>com.alibaba</groupId>
        <artifactId>fastjson</artifactId>
        <version>1.2.62</version>
    </dependency>
    <dependency>
        <groupId>junit</groupId>
        <artifactId>junit</artifactId>
        <version>4.12</version>
        <scope>test</scope>
    </dependency>
    <dependency>
        <groupId>org.testng</groupId>
        <artifactId>testng</artifactId>
        <version>6.14.3</version>
        <scope>test</scope>
    </dependency>
</dependencies>

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-compiler-plugin</artifactId>
            <version>3.1</version>
            <configuration>
                <target>1.8</target>
                <source>1.8</source>
            </configuration>
        </plugin>
    </plugins>
</build>

1.3 创建用于保存职位信息的实体类

注意:
在id字段上添加一个 @JSONField注解,并配置注解的serialize为false,表示该字段无需转换为JSON,因为它就是文档的唯一ID。

参考代码:

public class JobDetail {

    // 因为此处无需将id序列化为文档中
    @JSONField(serialize = false)
    private long id;            // 唯一标识
    private String area;        // 职位所在区域
    private String exp;         // 岗位要求的工作经验
    private String edu;         // 学历要求
    private String salary;      // 薪资范围
    private String job_type;    // 职位类型(全职/兼职)
    private String cmp;         // 公司名
    private String pv;          // 浏览量
    private String title;       // 岗位名称
    private String jd;          // 职位描述

    public long getId() {
        return id;
    }

    public void setId(long id) {
        this.id = id;
    }

    public String getArea() {
        return area;
    }

    public void setArea(String area) {
        this.area = area;
    }

    public String getExp() {
        return exp;
    }

    public void setExp(String exp) {
        this.exp = exp;
    }

    public String getEdu() {
        return edu;
    }

    public void setEdu(String edu) {
        this.edu = edu;
    }

    public String getSalary() {
        return salary;
    }

    public void setSalary(String salary) {
        this.salary = salary;
    }

    public String getJob_type() {
        return job_type;
    }

    public void setJob_type(String job_type) {
        this.job_type = job_type;
    }

    public String getCmp() {
        return cmp;
    }

    public void setCmp(String cmp) {
        this.cmp = cmp;
    }

    public String getPv() {
        return pv;
    }

    public void setPv(String pv) {
        this.pv = pv;
    }

    public String getTitle() {
        return title;
    }

    public void setTitle(String title) {
        this.title = title;
    }

    public String getJd() {
        return jd;
    }

    public void setJd(String jd) {
        this.jd = jd;
    }

    @Override
    public String toString() {
        return "JobDetail{" +
                "id=" + id +
                ", area='" + area + '\'' +
                ", exp='" + exp + '\'' +
                ", edu='" + edu + '\'' +
                ", salary='" + salary + '\'' +
                ", job_type='" + job_type + '\'' +
                ", cmp='" + cmp + '\'' +
                ", pv='" + pv + '\'' +
                ", title='" + title + '\'' +
                ", jd='" + jd + '\'' +
                '}';
    }
}

1.4 编写接口和实现类

在cn.itcast.elasticsearch.service包中创建JobFullTextService接口,该接口中定义了职位全文检索相关的Java API接口。满足基本的增删改查

参考代码:

/**
 * 定义JobFullTextService
 */
public interface JobFullTextService {
    // 添加一个职位数据
    void add(JobDetail jobDetail);

    // 根据ID检索指定职位数据
    JobDetail findById(long id) throws IOException;

    // 修改职位薪资
    void update(JobDetail jobDetail) throws IOException;

    // 根据ID删除指定位置数据
    void deleteById(long id) throws IOException;

    // 根据关键字检索数据
    List<JobDetail> searchByKeywords(String keywords) throws IOException;

    // 分页检索
    Map<String, Object> searchByPage(String keywords, int pageNum, int pageSize) throws IOException;

    // scroll分页解决深分页问题
    Map<String, Object> searchByScrollPage(String keywords, String scrollId, int pageSize) throws IOException;

    // 关闭ES连接
    void close() throws IOException;
;
}


1.5 创建实现类

在cn.itcast.elasticsearch.service.impl包下创建一个实现类:JobFullTextServiceImpl,并实现上面的接口。

参考代码:

public class JobFullTextServiceImpl implements JobFullTextService {
    @Override
    public void add(JobDetail jobDetail) {
        
    }

    @Override
    public void update(JobDetail jobDetail) {

    }

    @Override
    public JobDetail findById(long id) {
        return null;
    }

    @Override
    public boolean deleteById(long id) {
        return false;
    }

    @Override
    public List<JobDetail> searchByKeywords(String keywords) {
        return null;
    }

    @Override
    public Map<String, Object> searchByPage(String keywords, int pageNum, int pageSize) {
        return null;
    }

    @Override
    public Map<String, Object> searchByScrollPage(String keywords, String scrollId, int pageSize) {
        return null;
    }
}

2 添加职位数据

2.1 初始化客户端连接

  1. 使用RestHighLevelClient构建客户端连接。
  2. 基于RestClient.builder方法来构建RestClientBuilder
  3. 用HttpHost来添加ES的节点

参考代码:

private RestHighLevelClient restHighLevelClient;
private static final String JOB_IDX_NAME = "job_idx";

public JobFullTextServiceImpl() {
    restHighLevelClient = new RestHighLevelClient(RestClient.builder(
            new HttpHost("node1.cn", 9200, "http")
            , new HttpHost("node2.cn", 9200, "http")
            , new HttpHost("node3.cn", 9200, "http")
    ));
}

2.2 实现关闭客户端连接

@Override
public void close() {
    try {
        restHighLevelClient.close();
    } catch (IOException e) {
        e.printStackTrace();
    }
}

2.3 编写代码实现新增职位数据

实现步骤:

  1. 构建IndexRequest对象,用来描述ES发起请求的数据。
  2. 设置文档ID。
  3. 使用FastJSON将实体类对象转换为JSON。
  4. 使用IndexRequest.source方法设置文档数据,并设置请求的数据为JSON格式。
  5. 使用ES High level client调用index方法发起请求,将一个文档添加到索引中。

参考代码:

@Override
public void add(JobDetail jobDetail) {
    // 1. 构建IndexRequest对象,用来描述ES发起请求的数据。
    IndexRequest indexRequest = new IndexRequest(JOB_IDX_NAME);

    // 2. 设置文档ID。
    indexRequest.id(jobDetail.getId() + "");

    // 3. 构建一个实体类对象,并使用FastJSON将实体类对象转换为JSON。
    String json = JSON.toJSONString(jobDetail);

    // 4. 使用IndexRequest.source方法设置请求数据。
    indexRequest.source(json);

    try {
        // 5. 使用ES High level client调用index方法发起请求
        restHighLevelClient.index(indexRequest, RequestOptions.DEFAULT);
    } catch (IOException e) {
        e.printStackTrace();
    }

    System.out.println("索引创建成功!");
}

常见错误:

java.lang.IllegalArgumentException: The number of object passed must be even but was [1]
	at org.elasticsearch.action.index.IndexRequest.source(IndexRequest.java:474)
	at org.elasticsearch.action.index.IndexRequest.source(IndexRequest.java:461)

原因:IndexRequest.source要求传递偶数个的参数,但只传递了1个

2.4 编写测试用例测试添加方法

  1. 在 test/java 目录中创建一个 cn.itcast.elasticsearch.service 包。
  2. 在cn.itcast.elasticsearch.service 包下创建一个JobFullTextServiceTest类。
  3. 在@BeforeTest中构建JobFullTextService对象,@AfterTest中调用close方法关闭连接。
  4. 编写测试用例,构建一个测试用的实体类,测试add方法。

参考代码:

public class JobFullTextServiceTest {

    private JobFullTextService jobFullTextService;

    @BeforeTest
    public void beforeTest() {
        jobFullTextService = new JobFullTextServiceImpl();
    }

    @Test
    public void addTest() {
        // 1. 测试新增索引文档
       jobFullTextService = new JobFullTextServiceImpl();

        JobDetail jobDetail = new JobDetail();
        jobDetail.setId(1);
        jobDetail.setArea("山东省");
        jobDetail.setCmp("山东大学");
        jobDetail.setEdu("本科及以上");
        jobDetail.setExp("五年工作经验");
        jobDetail.setTitle("大数据工程师");
        jobDetail.setJob_type("全职");
        jobDetail.setPv("1700次浏览");
        jobDetail.setJd("会Hadoop就行");
        jobDetail.setSalary("15k-19k/月");

        jobFullTextService.add(jobDetail);
    }

    @AfterTest
    public void afterTest() {
        jobFullTextService.close();
    }
}

3 根据ID检索指定职位数据

3.1 实现步骤

  1. 构建GetRequest请求。
  2. 使用RestHighLevelClient.get发送GetRequest请求,并获取到ES服务器的响应。
  3. 将ES响应的数据转换为JSON字符串
  4. 并使用FastJSON将JSON字符串转换为JobDetail类对象
  5. 记得:单独设置ID

参考代码:

@Override
public JobDetail findById(long id) throws IOException {
    // 1. 构建GetRequest请求。
    GetRequest getRequest = new GetRequest(JOB_IDX_NAME, id + "");

    // 2. 使用RestHighLevelClient.get发送GetRequest请求,并获取到ES服务器的响应。
    GetResponse response = restHighLevelClient.get(getRequest, RequestOptions.DEFAULT);

    // 3. 将ES响应的数据转换为JSON字符串
    String json = response.getSourceAsString();

    // 4. 并使用FastJSON将JSON字符串转换为JobDetail类对象
    JobDetail jobDetail = JSONObject.parseObject(json, JobDetail.class);

    // 5. 设置ID字段
    jobDetail.setId(id);

    return jobDetail;

}

3.2 编写测试用例

参考代码:

@Test
public void findByIdTest() throws IOException {
    JobDetail jobDetail = jobFullTextService.findById(1);
    System.out.println(jobDetail);
}

4 修改职位

4.1 实现步骤

  1. 判断对应ID的文档是否存在
    a) 构建GetRequest
    b) 执行client的exists方法,发起请求,判断是否存在
  2. 构建UpdateRequest请求
  3. 设置UpdateRequest的文档,并配置为JSON格式
  4. 执行client发起update请求

参考代码:

@Override
public void update(JobDetail jobDetail) throws IOException {
    // 1. 判断对应ID的文档是否存在
    // a) 构建GetRequest
    GetRequest getRequest = new GetRequest(JOB_IDX_NAME, jobDetail.getId() + "");

    // b) 执行client的exists方法,发起请求,判断是否存在
    boolean exists = restHighLevelClient.exists(getRequest, RequestOptions.DEFAULT);

    if(!exists) return;

    // 2. 构建UpdateRequest请求
    UpdateRequest updateRequest = new UpdateRequest(JOB_IDX_NAME, jobDetail.getId() + "");

    // 3. 设置UpdateRequest的文档,并配置为JSON格式
    updateRequest.doc(JSON.toJSONString(jobDetail), XContentType.JSON);

    // 4. 执行client发起update请求
    restHighLevelClient.update(updateRequest, RequestOptions.DEFAULT);
}

4.2 编写测试用例

  1. 将ID为1的职位信息查询出来
  2. 将职位的名称设置为:”大数据开发工程师”
  3. 执行更新操作
  4. 再打印查看职位的名称是否成功更新

参考代码:

@Test
public void updateTest() throws IOException {
    JobDetail jobDetail = jobFullTextService.findById(1);
    jobDetail.setTitle("大数据开发工程师");
    jobFullTextService.update(jobDetail);
    System.out.println(jobFullTextService.findById(1));
}

5 根据文档ID删除职位

5.1 实现步骤

  1. 构建delete请求
  2. 使用RestHighLevelClient执行delete请求

参考代码:

@Override
public void deleteById(long id) throws IOException {
    // 1. 构建delete请求
    DeleteRequest deleteRequest = new DeleteRequest(JOB_IDX_NAME, id + "");

    // 2. 使用client执行delete请求
    restHighLevelClient.delete(deleteRequest, RequestOptions.DEFAULT);
}


5.2 编写测试用例

  1. 在测试用例中执行根据ID删除文档操作
  2. 使用VSCode发送请求,查看指定ID的文档是否已经被删除

参考代码:

@Test
public void deleteByIdTest() throws IOException {
    jobFullTextService.deleteById(1);
}

6 根据关键字检索数据

6.1 实现步骤

  1. 构建SearchRequest检索请求
  2. 创建一个SearchSourceBuilder专门用于构建查询条件
  3. 使用QueryBuilders.multiMatchQuery构建一个查询条件(搜索title、jd),并配置到SearchSourceBuilder
  4. 调用SearchRequest.source将查询条件设置到检索请求
  5. 执行RestHighLevelClient.search发起请求
  6. 遍历结果
  1. 获取命中的结果
  2. 将JSON字符串转换为对象
  3. 使用SearchHit.getId设置文档ID

参考代码:

@Override
public List<JobDetail> searchByKeywords(String keywords) throws IOException {
    // 1. 构建SearchRequest检索请求
    SearchRequest searchRequest = new SearchRequest(JOB_IDX_NAME);

    // 2. 创建一个SearchSourceBuilder专门用于构建查询条件
    SearchSourceBuilder searchSourceBuilder = new SearchSourceBuilder();

    // 3. 使用QueryBuilders.multiMatchQuery构建一个查询条件,并配置到SearchSourceBuilder
    MultiMatchQueryBuilder queryBuilder = QueryBuilders.multiMatchQuery(keywords, "jd", "title");
    searchSourceBuilder.query(queryBuilder);

    // 4. 调用SearchRequest.source将查询条件设置到检索请求
    searchRequest.source(searchSourceBuilder);

    // 5. 执行RestHighLevelClient.search发起请求
    SearchResponse searchResponse = restHighLevelClient.search(searchRequest, RequestOptions.DEFAULT);

    // 6. 遍历结果
    SearchHits hits = searchResponse.getHits();

    List<JobDetail> jobDetailList = new ArrayList<>();

    for (SearchHit hit : hits) {
        // 1) 获取命中的结果
        String json = hit.getSourceAsString();
        // 2) 将JSON字符串转换为对象
        JobDetail jobDetail = JSON.parseObject(json, JobDetail.class);
        // 3) 使用SearchHit.getId设置文档ID
        jobDetail.setId(Long.parseLong(hit.getId()));

        jobDetailList.add(jobDetail);
    }

    return jobDetailList;
}

6.2 编写测试用例

搜索标题、职位描述中包含销售的职位。

@Test
public void searchByKeywordsTest() throws IOException {
    List<JobDetail> jobDetailList = jobFullTextService.searchByKeywords("销售");
    for (JobDetail jobDetail : jobDetailList) {
        System.out.println(jobDetail);
    }
}

7 分页检索

7.1 实现步骤

步骤和之前的关键字搜索类似,只不过构建查询条件的时候,需要加上分页的设置。


  1. 构建SearchRequest检索请求
  2. 创建一个SearchSourceBuilder专门用于构建查询条件
  3. 使用QueryBuilders.multiMatchQuery构建一个查询条件,并配置到SearchSourceBuilder
  4. 设置SearchSourceBuilder的from和size参数,构建分页
  5. 调用SearchRequest.source将查询条件设置到检索请求
  6. 执行RestHighLevelClient.search发起请求
  7. 遍历结果
  1. 获取命中的结果
  2. 将JSON字符串转换为对象
  3. 使用SearchHit.getId设置文档ID
  1. 将结果封装到Map结构中(带有分页信息)
    a) total -> 使用SearchHits.getTotalHits().value获取到所有的记录数
    b) content -> 当前分页中的数据
@Override
public Map<String, Object> searchByPage(String keywords, int pageNum, int pageSize) throws IOException {
    // 1. 构建SearchRequest检索请求
    SearchRequest searchRequest = new SearchRequest(JOB_IDX_NAME);

    // 2. 创建一个SearchSourceBuilder专门用于构建查询条件
    SearchSourceBuilder searchSourceBuilder = new SearchSourceBuilder();

    // 3. 使用QueryBuilders.multiMatchQuery构建一个查询条件,并配置到SearchSourceBuilder
    MultiMatchQueryBuilder queryBuilder = QueryBuilders.multiMatchQuery(keywords, "jd", "title");
    searchSourceBuilder.query(queryBuilder);

    // 4. 设置SearchSourceBuilder的from和size参数,构建分页
    searchSourceBuilder.from((pageNum – 1) * pageSize);
    searchSourceBuilder.size(pageSize);

    // 4. 调用SearchRequest.source将查询条件设置到检索请求
    searchRequest.source(searchSourceBuilder);

    // 5. 执行RestHighLevelClient.search发起请求
    SearchResponse searchResponse = restHighLevelClient.search(searchRequest, RequestOptions.DEFAULT);

    // 6. 遍历结果
    SearchHits hits = searchResponse.getHits();

    List<JobDetail> jobDetailList = new ArrayList<>();

    for (SearchHit hit : hits) {
        // 1) 获取命中的结果
        String json = hit.getSourceAsString();
        // 2) 将JSON字符串转换为对象
        JobDetail jobDetail = JSON.parseObject(json, JobDetail.class);
        // 3) 使用SearchHit.getId设置文档ID
        jobDetail.setId(Long.parseLong(hit.getId()));

        jobDetailList.add(jobDetail);
    }

    // 8.  将结果封装到Map结构中(带有分页信息)
    // a)  total -> 使用SearchHits.getTotalHits().value获取到所有的记录数
    // b)  content -> 当前分页中的数据
    Map<String, Object> result = new HashMap<>();
    result.put("total", hits.getTotalHits().value);
    result.put("content", jobDetailList);

    return result;
}

6.7.2 编写测试用例

  1. 搜索关键字为“销售”,查询第0页,每页显示10条数据
  2. 打印搜索结果总记录数、对应分页的记录

参考代码:

@Test
public void searchByPageTest() throws IOException {
    Map<String, Object> resultMap = jobFullTextService.searchByPage("销售", 0, 10);
    System.out.println("总共:" + resultMap.get("total"));
    List<JobDetail> jobDetailList = (List<JobDetail>)resultMap.get("content");

    for (JobDetail jobDetail : jobDetailList) {
        System.out.println(jobDetail);
    }
}

8 scroll分页检索

8.1 实现步骤

判断scrollId是否为空
a) 如果为空,那么首次查询要发起scroll查询,设置滚动快照的有效时间
b) 如果不为空,就表示之前应发起了scroll,直接执行scroll查询就可以

步骤和之前的关键字搜索类似,只不过构建查询条件的时候,需要加上分页的设置。


scrollId为空:

  1. 构建SearchRequest检索请求
  2. 创建一个SearchSourceBuilder专门用于构建查询条件
  3. 使用QueryBuilders.multiMatchQuery构建一个查询条件,并配置到SearchSourceBuilder
  4. 调用SearchRequest.source将查询条件设置到检索请求
  5. 设置每页多少条记录,调用SearchRequest.scroll设置滚动快照有效时间
  6. 执行RestHighLevelClient.search发起请求
  7. 遍历结果
  1. 获取命中的结果
  2. 将JSON字符串转换为对象
  3. 使用SearchHit.getId设置文档ID
  1. 将结果封装到Map结构中(带有分页信息)
    a) scroll_id -> 从SearchResponse中调用getScrollId()方法获取scrollId
    b) content -> 当前分页中的数据

scollId不为空:

  1. 用之前查询出来的scrollId,构建SearchScrollRequest请求
  2. 设置scroll查询结果的有效时间
  3. 使用RestHighLevelClient执行scroll请求
@Override
public Map<String, Object> searchByScrollPage(String keywords, String scrollId, int pageSize) {

    Map<String, Object> result = new HashMap<>();
    List<JobDetail> jobList = new ArrayList<>();

    try {
            SearchResponse searchResponse = null;

            if(scrollId == null) {
                // 1. 创建搜索请求
                SearchRequest searchRequest = new SearchRequest("job_idx");
                // 2. 构建查询条件
                SearchSourceBuilder searchSourceBuilder = new SearchSourceBuilder();
                searchSourceBuilder.query(QueryBuilders.multiMatchQuery(keywords, "title", "jd"));
                // 3. 设置分页大小
                searchSourceBuilder.size(pageSize);
                // 4. 设置查询条件、并设置滚动快照有效时间
                searchRequest.source(searchSourceBuilder);
                searchRequest.scroll(TimeValue.timeValueMinutes(1));
                // 5. 发起请求
                searchResponse = client.search(searchRequest, RequestOptions.DEFAULT);
            }
            else {
                SearchScrollRequest searchScrollRequest = new SearchScrollRequest(scrollId);
                searchScrollRequest.scroll(TimeValue.timeValueMinutes(1));
                searchResponse = client.scroll(searchScrollRequest, RequestOptions.DEFAULT);
            }

            // 6. 迭代响应结果
            SearchHits hits = searchResponse.getHits();
            for (SearchHit hit : hits) {
                JobDetail jobDetail = JSONObject.parseObject(hit.getSourceAsString(), JobDetail.class);
                jobDetail.setId(Long.parseLong(hit.getId()));
                jobList.add(jobDetail);
            }

            result.put("content", jobList);
            result.put("scroll_id", searchResponse.getScrollId());

        }
    catch (IOException e) {
        e.printStackTrace();
    }

    return result;
}

8.2 编写测试用例

  1. 编写第一个测试用例,不带scrollId查询
  2. 编写第二个测试用例,使用scrollId查询
@Test
public void searchByScrollPageTest1() throws IOException {
    Map<String, Object> result = jobFullTextService.searchByScrollPage("销售", null, 10);
    System.out.println("scrollId: " + result.get("scrollId"));
    List<JobDetail> content = (List<JobDetail>)result.get("content");

    for (JobDetail jobDetail : content) {
        System.out.println(jobDetail);
    }
}

@Test
public void searchByScrollPageTest2() throws IOException {
    Map<String, Object> result = jobFullTextService.searchByScrollPage("销售", "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAA0WRG4zZFVwODJSU2Uxd1BOWkQ4cFdCQQ==", 10);
    System.out.println("scrollId: " + result.get("scrollId"));
    List<JobDetail> content = (List<JobDetail>)result.get("content");

    for (JobDetail jobDetail : content) {
        System.out.println(jobDetail);
    }
}

9 高亮查询

9.1 高亮查询简介

在进行关键字搜索时,搜索出的内容中的关键字会显示不同的颜色,称之为高亮。百度搜索关键字"csdn"
在这里插入图片描述
京东商城搜索"笔记本"
在这里插入图片描述

9.2 高亮显示的html分析

通过开发者工具查看高亮数据的html代码实现:
在这里插入图片描述
ElasticSearch可以对查询出的内容中关键字部分进行标签和样式的设置,但是你需要告诉ElasticSearch使用什么标签对高亮关键字进行包裹

9.3 实现高亮查询

  1. 在我们构建查询请求时,我们需要构建一个HighLightBuilder,专门来配置高亮查询。
    a) 构建一个HighlightBuilder
    b) 设置高亮字段(title、jd)
    c) 设置高亮前缀(
    d) 设置高亮后缀(

    e) 将高亮添加到SearchSourceBuilder

代码如下:

// 设置高亮
HighlightBuilder highlightBuilder = new HighlightBuilder();
highlightBuilder.field("title");
highlightBuilder.field("jd");
highlightBuilder.preTags("<font color='red'>");
highlightBuilder.postTags("</font>");
searchSourceBuilder.highlighter(highlightBuilder);

  1. 我们将高亮的查询结果取出,并替换掉原先没有高亮的结果
    a) 获取高亮字段
    i. 获取title高亮字段
    ii. 获取jd高亮字段
    b) 将高亮字段进行替换普通字段
    i. 处理title高亮,判断高亮是否为空,不为空则将高亮碎片拼接在一起
    ii. 替换原有普通字段

参考代码:

// 1. 获取高亮字段
Map<String, HighlightField> highlightFieldMap = hit.getHighlightFields();
// 1.1 获取title高亮字段
HighlightField titleHl = highlightFieldMap.get("title");
// 1.2 获取jd高亮字段
HighlightField jdHl = highlightFieldMap.get("jd");
// 2. 将高亮字段进行替换普通字段
// 2.1 处理title高亮,判断高亮是否为空,不为空则将高亮Fragment(碎片)拼接在一起,替换原有普通字段
if(titleHl != null) {
    Text[] fragments = titleHl.getFragments();
    StringBuilder stringBuilder = new StringBuilder();
    for (Text fragment : fragments) {
        stringBuilder.append(fragment.string());
    }
    jobDetail.setTitle(stringBuilder.toString());
}

// 2.2 处理jd高亮
if(jdHl != null) {
    Text[] fragments = jdHl.getFragments();
    StringBuilder stringBuilder = new StringBuilder();
    for (Text fragment : fragments) {
        stringBuilder.append(fragment.string());
    }
    jobDetail.setJd(stringBuilder.toString());
}

我们再查询,发现查询的结果中就都包含了高亮。
在这里插入图片描述

10 完整参考代码

public class JobFullTextServiceImpl implements JobFullTextService {

    private RestHighLevelClient restHighLevelClient;
    private static final String JOB_IDX_NAME = "job_idx";

    public JobFullTextServiceImpl() {
        restHighLevelClient = new RestHighLevelClient(RestClient.builder(
                new HttpHost("node1.itcast.cn", 9200, "http")
                , new HttpHost("node2.itcast.cn", 9200, "http")
                , new HttpHost("node3.itcast.cn", 9200, "http")
        ));
    }

    @Override
    public void add(JobDetail jobDetail) {
        // 1. 构建IndexRequest对象,用来描述ES发起请求的数据。
        IndexRequest indexRequest = new IndexRequest(JOB_IDX_NAME);

        // 2. 设置文档ID。
        indexRequest.id(jobDetail.getId() + "");

        // 3. 构建一个实体类对象,并使用FastJSON将实体类对象转换为JSON。
        String json = JSON.toJSONString(jobDetail);

        // 4. 使用IndexRequest.source方法设置请求数据。
        indexRequest.source(json, XContentType.JSON);

        try {
            // 5. 使用ES High level client调用index方法发起请求
            restHighLevelClient.index(indexRequest, RequestOptions.DEFAULT);
        } catch (IOException e) {
            e.printStackTrace();
        }

        System.out.println("索引创建成功!");
    }

    @Override
    public void update(JobDetail jobDetail) throws IOException {
        // 1. 判断对应ID的文档是否存在
        // a) 构建GetRequest
        GetRequest getRequest = new GetRequest(JOB_IDX_NAME, jobDetail.getId() + "");

        // b) 执行client的exists方法,发起请求,判断是否存在
        boolean exists = restHighLevelClient.exists(getRequest, RequestOptions.DEFAULT);

        if(!exists) return;

        // 2. 构建UpdateRequest请求
        UpdateRequest updateRequest = new UpdateRequest(JOB_IDX_NAME, jobDetail.getId() + "");

        // 3. 设置UpdateRequest的文档,并配置为JSON格式
        updateRequest.doc(JSON.toJSONString(jobDetail), XContentType.JSON);

        // 4. 执行client发起update请求
        restHighLevelClient.update(updateRequest, RequestOptions.DEFAULT);
    }

    @Override
    public JobDetail findById(long id) throws IOException {
        // 1. 构建GetRequest请求。
        GetRequest getRequest = new GetRequest(JOB_IDX_NAME, id + "");

        // 2. 使用RestHighLevelClient.get发送GetRequest请求,并获取到ES服务器的响应。
        GetResponse response = restHighLevelClient.get(getRequest, RequestOptions.DEFAULT);

        // 3. 将ES响应的数据转换为JSON字符串
        String json = response.getSourceAsString();

        // 4. 并使用FastJSON将JSON字符串转换为JobDetail类对象
        JobDetail jobDetail = JSONObject.parseObject(json, JobDetail.class);

        // 5. 设置ID字段
        jobDetail.setId(id);

        return jobDetail;

    }

    @Override
    public void deleteById(long id) throws IOException {
        // 1. 构建delete请求
        DeleteRequest deleteRequest = new DeleteRequest(JOB_IDX_NAME, id + "");

        // 2. 使用client执行delete请求
        restHighLevelClient.delete(deleteRequest, RequestOptions.DEFAULT);
    }

    @Override
    public List<JobDetail> searchByKeywords(String keywords) throws IOException {
        // 1. 构建SearchRequest检索请求
        SearchRequest searchRequest = new SearchRequest(JOB_IDX_NAME);

        // 2. 创建一个SearchSourceBuilder专门用于构建查询条件
        SearchSourceBuilder searchSourceBuilder = new SearchSourceBuilder();

        // 3. 使用QueryBuilders.multiMatchQuery构建一个查询条件,并配置到SearchSourceBuilder
        MultiMatchQueryBuilder queryBuilder = QueryBuilders.multiMatchQuery(keywords, "jd", "title");
        searchSourceBuilder.query(queryBuilder);

        // 4. 调用SearchRequest.source将查询条件设置到检索请求
        searchRequest.source(searchSourceBuilder);

        // 5. 执行RestHighLevelClient.search发起请求
        SearchResponse searchResponse = restHighLevelClient.search(searchRequest, RequestOptions.DEFAULT);

        // 6. 遍历结果
        SearchHits hits = searchResponse.getHits();

        List<JobDetail> jobDetailList = new ArrayList<>();

        for (SearchHit hit : hits) {
            // 1) 获取命中的结果
            String json = hit.getSourceAsString();
            // 2) 将JSON字符串转换为对象
            JobDetail jobDetail = JSON.parseObject(json, JobDetail.class);
            // 3) 使用SearchHit.getId设置文档ID
            jobDetail.setId(Long.parseLong(hit.getId()));

            jobDetailList.add(jobDetail);
        }

        return jobDetailList;
    }

    @Override
    public Map<String, Object> searchByPage(String keywords, int pageNum, int pageSize) throws IOException {
        // 1. 构建SearchRequest检索请求
        SearchRequest searchRequest = new SearchRequest(JOB_IDX_NAME);

        // 2. 创建一个SearchSourceBuilder专门用于构建查询条件
        SearchSourceBuilder searchSourceBuilder = new SearchSourceBuilder();

        // 3. 使用QueryBuilders.multiMatchQuery构建一个查询条件,并配置到SearchSourceBuilder
        MultiMatchQueryBuilder queryBuilder = QueryBuilders.multiMatchQuery(keywords, "jd", "title");
        searchSourceBuilder.query(queryBuilder);

        // 4. 设置SearchSourceBuilder的from和size参数,构建分页
        searchSourceBuilder.from(pageNum);
        searchSourceBuilder.size(pageSize);

        // 4. 调用SearchRequest.source将查询条件设置到检索请求
        searchRequest.source(searchSourceBuilder);

        // 5. 执行RestHighLevelClient.search发起请求
        SearchResponse searchResponse = restHighLevelClient.search(searchRequest, RequestOptions.DEFAULT);

        // 6. 遍历结果
        SearchHits hits = searchResponse.getHits();

        List<JobDetail> jobDetailList = new ArrayList<>();

        for (SearchHit hit : hits) {
            // 1) 获取命中的结果
            String json = hit.getSourceAsString();
            // 2) 将JSON字符串转换为对象
            JobDetail jobDetail = JSON.parseObject(json, JobDetail.class);
            // 3) 使用SearchHit.getId设置文档ID
            jobDetail.setId(Long.parseLong(hit.getId()));

            jobDetailList.add(jobDetail);
        }

        // 8.  将结果封装到Map结构中(带有分页信息)
        // a)  total -> 使用SearchHits.getTotalHits().value获取到所有的记录数
        // b)  content -> 当前分页中的数据
        Map<String, Object> result = new HashMap<>();
        result.put("total", hits.getTotalHits().value);
        result.put("content", jobDetailList);

        return result;
    }

    @Override
    public Map<String, Object> searchByScrollPage(String keywords, String scrollId, int pageSize) throws IOException {
        SearchResponse searchResponse = null;

        if(scrollId == null) {
            // 1. 构建SearchRequest检索请求
            SearchRequest searchRequest = new SearchRequest(JOB_IDX_NAME);

            // 2. 创建一个SearchSourceBuilder专门用于构建查询条件
            SearchSourceBuilder searchSourceBuilder = new SearchSourceBuilder();

            // 3. 使用QueryBuilders.multiMatchQuery构建一个查询条件,并配置到SearchSourceBuilder
            MultiMatchQueryBuilder queryBuilder = QueryBuilders.multiMatchQuery(keywords, "jd", "title");
            searchSourceBuilder.query(queryBuilder);
            searchSourceBuilder.size(pageSize);

            // 设置高亮查询
            HighlightBuilder highlightBuilder = new HighlightBuilder();
            highlightBuilder.preTags("<font color='red'>");
            highlightBuilder.postTags("</font>");
            highlightBuilder.field("title");
            highlightBuilder.field("jd");

            searchSourceBuilder.highlighter(highlightBuilder);

            // 4. 调用searchRequest.scroll设置滚动快照有效时间
            searchRequest.scroll(TimeValue.timeValueMinutes(10));

            // 5. 调用SearchRequest.source将查询条件设置到检索请求
            searchRequest.source(searchSourceBuilder);

            // 6. 执行RestHighLevelClient.search发起请求
            searchResponse = restHighLevelClient.search(searchRequest, RequestOptions.DEFAULT);
        }
        else {
            SearchScrollRequest searchScrollRequest = new SearchScrollRequest(scrollId);
            searchScrollRequest.scroll(TimeValue.timeValueMinutes(10));
            searchResponse = restHighLevelClient.scroll(searchScrollRequest, RequestOptions.DEFAULT);
        }


        if(searchResponse != null) {
            // 7. 遍历结果
            SearchHits hits = searchResponse.getHits();

            List<JobDetail> jobDetailList = new ArrayList<>();

            for (SearchHit hit : hits) {

                // 1) 获取命中的结果
                String json = hit.getSourceAsString();
                // 2) 将JSON字符串转换为对象
                JobDetail jobDetail = JSON.parseObject(json, JobDetail.class);
                // 3) 使用SearchHit.getId设置文档ID
                jobDetail.setId(Long.parseLong(hit.getId()));


                // 1. 获取高亮字段
                Map<String, HighlightField> highlightFieldMap = hit.getHighlightFields();
                // 1.1 获取title高亮字段
                HighlightField titleHl = highlightFieldMap.get("title");
                // 1.2 获取jd高亮字段
                HighlightField jdHl = highlightFieldMap.get("jd");
                // 2. 将高亮字段进行替换普通字段
                // 2.1 处理title高亮,判断高亮是否为空,不为空则将高亮Fragment(碎片)拼接在一起,替换原有普通字段
                if(titleHl != null) {
                    Text[] fragments = titleHl.getFragments();
                    StringBuilder stringBuilder = new StringBuilder();
                    for (Text fragment : fragments) {
                        stringBuilder.append(fragment.string());
                    }
                    jobDetail.setTitle(stringBuilder.toString());
                }

                // 2.2 处理jd高亮
                if(jdHl != null) {
                    Text[] fragments = jdHl.getFragments();
                    StringBuilder stringBuilder = new StringBuilder();
                    for (Text fragment : fragments) {
                        stringBuilder.append(fragment.string());
                    }
                    jobDetail.setJd(stringBuilder.toString());
                }

                jobDetailList.add(jobDetail);
            }

            // 8.  将结果封装到Map结构中(带有分页信息)
            // a)  total -> 使用SearchHits.getTotalHits().value获取到所有的记录数
            // b)  content -> 当前分页中的数据
            Map<String, Object> result = new HashMap<>();
            result.put("scrollId", searchResponse.getScrollId());
            result.put("content", jobDetailList);

            return result;
        }

        return null;
    }

    @Override
    public void close() {
        try {
            restHighLevelClient.close();
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}

评论 2
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

赵广陆

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值