在Spring Boot中整合Elasticsearch并实现高亮搜索-Toy模板网

这篇具有很好参考价值的文章主要介绍了在Spring Boot中整合Elasticsearch并实现高亮搜索。希望对大家有所帮助。如果存在错误或未考虑完全的地方，请大家不吝赐教，您也可以点击"举报违法"按钮提交疑问。

前言在现代软件开发中，高效的数据搜索和检索是至关重要的。Elasticsearch作为一款强大的开源搜索引擎，为我们提供了快速、准确的搜索能力。而Spring Boot作为一种常用的Java开发框架，提供了快速构建应用程序的能力。本文将为您详细展示如何将这两者结合，通过Spring Boot实现Elasticsearch的高亮搜索功能。版本匹配的重要性在开始整合之前，我们首先要明确一个重要的问题：版本匹配。Spring Boot Data Elasticsearch提供的API与Elasticsearch的版本相关联，版本不匹配可能导致不兼容的问题。确保您的Spring Boot Data Elasticsearch版本与实际Elasticsearch服务器版本匹配，这一步至关重要。文章中建议，不仅要注意版本匹配，还要特别关注与团队提供的版本保持一致，以避免不必要的问题。实体类注解：为搜索数据做准备在开始编写代码之前，我们需要为要在Elasticsearch中搜索的数据实体类添加注解。在示例中，作者以一个名为User的实体类为例，详细解释了如何通过注解为不同字段指定索引、存储和分词等属性。这些注解将为搜索数据的准备工作奠定基础。实现高亮搜索功能的整体步骤作者在文章中提供了一个清晰的实现步骤，让读者能够轻松上手整合并实现高亮搜索功能。以下是整体步骤的概要：添加依赖：通过在项目的pom.xml文件中添加相关依赖，引入Spring Boot Data Elasticsearch的功能。配置信息：在application.properties或application.yml文件中配置Elasticsearch的连接信息。实体类注解：为要搜索的实体类添加注解，指定索引名称、字段的分词方式等属性。创建Repository：在Repository接口中定义搜索方法，用于执行搜索逻辑。编写Service：在Service层中编写搜索逻辑，使用elasticsearchRestTemplate执行搜索操作，并处理高亮字段。验证示例：通过一个RESTful API端点，演示如何使用搜索功能，并获取包含高亮字段的搜索结果。实战示例：高亮搜索效果展示在文章末尾，作者为读者提供了一个验证示例，展示了整合后的高亮搜索效果。通过调用API端点，您可以轻松搜索包含关键字的数据，并获得高亮字段的结果展示。这个实战示例不仅帮助您理解了实现步骤，还为您提供了一个实际应用的场景。前言结语本文详细阐述了如何在Spring Boot项目中整合Elasticsearch，并实现高亮搜索功能。从版本匹配的重要性到实体类注解的使用，再到整体步骤的解释，我们为您呈现了一个完整的实现过程。希望本文能够帮助您在实际项目中成功整合Spring Boot与Elasticsearch，并为您的应用程序提供强大的高亮搜索功能。本文将详细介绍如何使用Spring Boot整合Elasticsearch并实现高亮搜索功能。首先，为了确保顺利整合，需注意Spring Boot Data Elasticsearch的版本与实际Elasticsearch服务器版本的匹配。版本不匹配可能导致API不兼容，因此在开始前务必查阅官方文档确认匹配的版本。第一步：添加依赖

在项目的pom.xml文件中，添加如下依赖配置：



    org.springframework.boot
    spring-boot-starter-data-elasticsearch

第二步：修改Spring Boot配置文件

在application.properties或application.yml文件中，添加Elasticsearch的配置信息：

spring.elasticsearch.uris=http://192.168.88.187:9200
spring.data.elasticsearch.repositories.enabled=true

第三步：为操作的实体Bean添加注解

对于要操作的实体数据，在其类定义上添加相关注解，示例中是一个User类：

package com.wy.scjg.bean;

import org.springframework.data.annotation.Id;
import org.springframework.data.elasticsearch.annotations.Document;
import org.springframework.data.elasticsearch.annotations.Field;
import org.springframework.data.elasticsearch.annotations.FieldType;
import org.springframework.format.annotation.DateTimeFormat;
import java.io.Serializable;
import java.util.Date;

@Document(indexName = "users")
public class User implements Serializable {
    /**
     * 主键ID
     */
    @Id
    private Long id;

    /**
     * 姓名
     */
    @Field(index = true, store = true, analyzer = "ik_max_word", searchAnalyzer = "ik_max_word", type = FieldType.Text)
    private String name;

    /**
     * 年龄
     */
    private Integer age;

    /**
     * 邮箱
     */
    private String email;

    /**
     * 生日
     */
    @DateTimeFormat(pattern = "yyyy-MM-dd")
    private Date birth;

    private Integer did;

    // 表中不存在的字段
}

以上示例中，@Document注解用于指定索引名称，@Id注解标识主键字段。@Field注解用于指定字段的索引、存储、分词等属性。

实现高亮搜索

在使用Spring Boot Data Elasticsearch进行高亮搜索时，可以按以下步骤进行：

在Repository接口中添加方法，定义搜索逻辑。

package com.wy.scjg.repository;

import com.wy.scjg.bean.User;
import org.springframework.data.elasticsearch.repository.ElasticsearchRepository;

public interface UserRepository extends ElasticsearchRepository {
    List findByName(String name);
}

在Service层调用Repository中的方法，执行搜索操作。

package com.wy.scjg.service;

import com.wy.scjg.bean.User;
import com.wy.scjg.repository.UserRepository;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import org.springframework.data.elasticsearch.core.SearchHits;
import org.springframework.data.elasticsearch.core.ElasticsearchRestTemplate;
import org.springframework.data.elasticsearch.core.SearchHit;

import java.util.List;
import java.util.stream.Collectors;

@Service
public class UserService {

    @Autowired
    private UserRepository userRepository;

    @Autowired
    private ElasticsearchRestTemplate elasticsearchRestTemplate;

    public List searchUsers(String keyword) {
        SearchHits searchHits = elasticsearchRestTemplate.search(
                elasticsearchQueryService -> elasticsearchQueryService
                        .forPageable(PageRequest.of(0, 10))
                        .highlightFields(highlightBuilder ->
                                highlightBuilder.field("name"))
                        .must(QueryBuilders.matchQuery("name", keyword)),
                User.class
        );

        return searchHits.get().map(SearchHit::getContent).collect(Collectors.toList());
    }
}

以上示例中，UserService中的searchUsers方法使用elasticsearchRestTemplate执行搜索操作，并添加了高亮字段。

验证示例

接下来，我们通过一个简单的验证示例来演示上述步骤的整合效果。假设我们在Elasticsearch中已经有一批用户数据，现在我们要在这些数据中搜索并高亮显示包含某关键字的用户名。

@RestController
@RequestMapping("/api")
public class UserController {

    @Autowired
    private UserService userService;

    @GetMapping("/search")
    public List searchUsers(@RequestParam String keyword) {
        return userService.searchUsers(keyword);
    }
}

在这个示例中，我们创建了一个RESTful API端点，通过传递关键字参数来执行用户搜索。搜索结果会返回一个包含高亮字段的用户列表。

这篇文章详细介绍了如何在Spring Boot中整合Elasticsearch，并实现了高亮搜索的功能。通过添加依赖、配置Spring Boot以及在实体类中添加注解，我们能够轻松地操作Elasticsearch中的数据。同时，我们还演示了如何在Service层实现高亮搜索，并提供了一个简单的验证示例来展示整合的效果。希望这篇文章能够帮助你成功实现Spring Boot与Elasticsearch的整合和高亮搜索功能。

当然，接下来我们将继续完善验证示例，并说明如何在该示例中实现高亮搜索的效果。

验证示例

在上文中，我们创建了一个UserController，其中包含一个用于搜索用户的RESTful API端点。现在，我们将在这个端点中实现高亮搜索的功能。

@RestController
@RequestMapping("/api")
public class UserController {

    @Autowired
    private UserService userService;

    @GetMapping("/search")
    public List> searchUsers(@RequestParam String keyword) {
        List users = userService.searchUsers(keyword);
        
        // 将搜索结果转换为包含高亮字段的Map列表
        List> highlightedUsers = users.stream()
                .map(user -> {
                    Map userMap = new HashMap();
                    userMap.put("id", user.getId());
                    
                    // 获取高亮字段
                    HighlightField highlightField = user.getHighlightFields().get("name");
                    if (highlightField != null) {
                        userMap.put("name", highlightField.fragments()[0].toString());
                    } else {
                        userMap.put("name", user.getName());
                    }
                    
                    userMap.put("age", user.getAge());
                    userMap.put("email", user.getEmail());
                    userMap.put("birth", user.getBirth());
                    userMap.put("did", user.getDid());
                    
                    return userMap;
                })
                .collect(Collectors.toList());

        return highlightedUsers;
    }
}

在上述示例中，我们通过userService调用searchUsers方法来获取包含高亮字段的用户列表。对于每个用户，我们会检查其highlightFields，获取名为“name”的高亮字段，如果存在，就使用高亮的文本，否则使用原始的文本。最后，将转换后的用户列表返回给API调用者。

通过这个验证示例，我们已经成功地实现了在Spring Boot中整合Elasticsearch并进行高亮搜索的功能。现在，你可以通过调用/api/search?keyword=关键字的API端点来搜索并获取包含高亮字段的用户列表。

这篇文章详细地介绍了如何在Spring Boot项目中整合Elasticsearch，实现高亮搜索功能，并通过验证示例展示了整合效果。希望这篇文章对你有所帮助，让你更好地理解如何在实际项目中应用这些概念和技术。文章来源地址https://www.toymoban.com/news/detail-458386.html

到了这里，关于在Spring Boot中整合Elasticsearch并实现高亮搜索的文章就介绍完了。如果您还想了解更多内容，请在右上角搜索TOY模板网以前的文章或继续浏览下面的相关文章，希望大家以后多多支持TOY模板网！