快速入门：Elasticsearch与Spring框架的集成实践

本文还有配套的精品资源，点击获取

简介：本案例演示了如何将Elasticsearch 6.1.2与Spring框架集成，实现Java应用中的高效搜索功能。通过添加必要的依赖和配置数据源，介绍了在Spring项目中使用Elasticsearch进行基本的CRUD操作的方法，以及如何通过Spring Data Elasticsearch简化操作流程。案例包含使用注解定义实体类、操作接口的创建和简单增删改查操作。通过这种方式，开发者可以利用Elasticsearch的强大功能，快速构建具备高效搜索能力的Java应用。

1. Elasticsearch与Spring框架集成介绍

Elasticsearch是一个分布式的、RESTful风格的搜索和分析引擎，广泛应用于日志数据、实时数据处理以及全文搜索等场景。而Spring框架作为Java开发领域广泛应用的开源框架，提供了丰富的工具支持。将Elasticsearch与Spring框架集成，可以极大地简化搜索引擎功能的开发过程，提高开发效率和维护性。本章将介绍Elasticsearch与Spring框架集成的基本概念和集成流程，为接下来的深入配置和使用打下坚实基础。

2. Elasticsearch 6.1.2依赖配置

2.1 Maven依赖管理

2.1.1 Elasticsearch核心依赖配置

在开发基于Spring框架的应用程序时，集成Elasticsearch通常需要添加相应的依赖到项目的Maven pom.xml 文件中。对于Elasticsearch版本6.1.2，我们需要添加Elasticsearch客户端库的依赖。

<dependency>
    <groupId>org.elasticsearch.client</groupId>
    <artifactId>elasticsearch-rest-high-level-client</artifactId>
    <version>6.1.2</version>
</dependency>

上述依赖提供了对Elasticsearch REST API的高级封装，使得开发者可以以更简单的方式与Elasticsearch进行交互。

2.1.2 Spring Data Elasticsearch依赖配置

Spring Data Elasticsearch是一个独立的项目，它提供了与Spring Data项目相同的抽象层，允许开发者通过简单的注解来操作Elasticsearch。

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-data-elasticsearch</artifactId>
    <version>2.1.6.RELEASE</version>
</dependency>

请注意，Spring Data Elasticsearch 2.1.6.RELEASE与Elasticsearch 6.1.2版本兼容。这里还有一个重要的注意点，Elasticsearch的版本需要与Spring Data Elasticsearch的版本对应，否则可能会出现不兼容的问题。

2.2 集成开发环境搭建

2.2.1 IDE配置与插件安装

搭建集成开发环境（IDE）通常意味着选择合适工具和安装需要的插件。对于Elasticsearch集成开发，IntelliJ IDEA 和 Eclipse 都是很好的选择。以IntelliJ IDEA为例，推荐安装Elasticsearch插件，例如"Search with Elasticsearch"插件，它提供了方便的搜索和语法高亮功能。

2.2.2 Elasticsearch服务的搭建和连接

在本地开发环境中，需要有一个运行的Elasticsearch服务。Elasticsearch官方提供了方便的Docker镜像来快速启动一个服务实例。

docker pull docker.elastic.co/elasticsearch/elasticsearch:6.1.2
docker run -p 9200:9200 -p 9300:9300 -e "discovery.type=single-node" docker.elastic.co/elasticsearch/elasticsearch:6.1.2

上述命令会启动一个单节点的Elasticsearch实例，端口为默认的9200和9300。然后，我们可以添加RestHighLevelClient到Spring Boot应用程序的配置文件中，以连接到Elasticsearch实例。

@Configuration
public class ElasticsearchConfig {

    @Bean
    public RestHighLevelClient client() {
        RestHighLevelClient client = new RestHighLevelClient(
            RestClient.builder(new HttpHost("localhost", 9200, "http")));
        return client;
    }
}

这里使用了 RestClient.builder 来建立一个客户端，连接到了本地运行的Elasticsearch实例。这样的配置确保了我们的Spring Boot应用能够与Elasticsearch进行通信。

以上步骤完成了Maven依赖的管理以及开发环境的搭建，为接下来的深入操作打下了基础。在下一章节，我们将探讨如何配置Spring框架的数据源，以及如何在代码和配置文件中管理Elasticsearch数据源。

3. Spring数据源配置说明

3.1 Spring框架数据源概述

3.1.1 数据源的作用与配置方式

在应用开发中，数据源是连接应用和数据库的关键组件。它负责建立数据库连接，并将这些连接提供给应用程序使用。在Spring框架中，数据源的配置是必不可少的步骤，它不仅决定了应用程序与数据库的连接方式，还影响着数据访问的性能和效率。

配置数据源主要涉及以下几个方面：

• 数据库连接信息 ：包括数据库的URL、用户名、密码等，这是建立数据库连接的基本信息。
• 连接池管理 ：为了提高性能，通常会配置连接池来管理数据库连接，包括最大连接数、最小空闲连接数、连接超时时间等参数。
• 事务管理 ：在配置数据源时，需要考虑到事务管理的配置，以便在应用程序中使用声明式事务。

Spring提供了多种方式来配置数据源：

• XML配置文件 ：在传统的Spring应用中，通过编写XML文件来配置数据源是一种常见的方式。
• Java配置类 ：随着Spring Boot和Java配置的流行，通过配置类的方式来配置数据源越来越受到开发者的青睐。
• 外部配置文件 ：为了避免硬编码，可以将数据库连接信息放在外部配置文件中，如 application.properties 或 application.yml 。

下面是一个典型的XML配置数据源的例子：

<bean id="dataSource" class="org.apache.commons.dbcp.BasicDataSource">
    <property name="driverClassName" value="com.mysql.jdbc.Driver"/>
    <property name="url" value="jdbc:mysql://localhost:3306/springdb"/>
    <property name="username" value="root"/>
    <property name="password" value="password"/>
    <property name="initialSize" value="5"/>
    <property name="maxActive" value="10"/>
    <!-- 更多配置 -->
</bean>

在实际应用中，根据不同的需求和场景，可能还需要配置更多的数据源特性，例如连接测试、慢查询日志、事务超时设置等。

3.2 Elasticsearch数据源配置

3.2.1 配置Elasticsearch数据源的步骤

配置Elasticsearch数据源和传统的SQL数据库有所不同，因为Elasticsearch是一个分布式搜索引擎，它有自己的配置方式和连接策略。在Spring框架中集成Elasticsearch时，主要是通过Spring Data Elasticsearch模块来进行。

配置Elasticsearch数据源通常包含以下步骤：

• 添加依赖 ：首先需要在项目的构建配置中加入Spring Data Elasticsearch的依赖。
• 配置Elasticsearch客户端 ：通常通过配置 ElasticsearchOperations 接口的实现来建立与Elasticsearch集群的连接。
• 配置连接信息 ：需要配置Elasticsearch节点的地址以及可能的集群名称。
• 高级配置 ：根据需要，可能还需要进行一些高级配置，比如连接超时设置、连接池设置等。

下面是一个使用Spring配置类配置Elasticsearch数据源的例子：

@Configuration
@EnableElasticsearchRepositories(basePackages = "com.example.repository")
public class ElasticsearchConfig extends AbstractElasticsearchConfiguration {

    @Override
    @Bean
    public RestHighLevelClient elasticsearchClient() {
        final ClientConfiguration clientConfiguration = ClientConfiguration.builder()
                .connectedTo("localhost:9200")
                .build();

        return RestClients.create(clientConfiguration);
    }
}

3.2.2 配置文件与代码级别的数据源管理

在Spring框架中，数据源的管理既可以在配置文件中完成，也可以在代码中完成。使用配置文件的好处是方便管理和修改，而代码级别的管理则提供了更多的灵活性和动态配置的能力。

对于Elasticsearch来说，其数据源配置通常在代码中进行，尤其是在使用Spring Data Elasticsearch时。这样做的好处是可以在运行时动态地指定连接参数，更加灵活地管理多个Elasticsearch集群。

一个典型的配置文件示例，如 application.yml ：

spring:
  elasticsearch:
    rest:
      uris: "http://localhost:9200"

然后在Java代码中，可以这样获取配置：

@ConfigurationProperties(prefix = "spring.elasticsearch.rest")
public class ElasticsearchProperties {
    private List<String> uris = new ArrayList<>(Arrays.asList("http://localhost:9200"));

    // getters and setters
}

这种方式结合了配置文件的易管理性和代码配置的灵活性，让开发者可以更加方便地在不同的环境之间切换Elasticsearch连接配置。

接下来我们将具体探讨如何使用@Document注解定义Elasticsearch文档模型。

4. 使用@Document注解定义Elasticsearch文档模型

4.1 文档模型的重要性

4.1.1 文档模型在搜索引擎中的作用

在搜索引擎的背景下，文档模型起着至关重要的作用。文档模型是一种数据结构，它定义了数据在Elasticsearch中的存储方式。每个文档通常包含了一个或多个字段，而这些字段被映射为可搜索的数据类型。这些数据类型定义了如何索引和搜索字段，以及哪些分析器（用于文本字段）应该用于字段。

在Elasticsearch中，一切皆为JSON文档。这些文档通常存储在倒排索引中，它允许快速全文搜索。文档模型允许开发者定义具体字段的映射，例如，是否需要将字段视为一个全文搜索字段、一个数字字段或是其他类型。这种映射是搜索引擎理解如何查询和检索数据的关键。

文档模型的重要性还体现在它的灵活性上，开发者可以根据需要调整和优化数据模型来满足特定查询和性能需求。此外，合理的文档模型设计可以提升查询效率和存储利用率，还能简化数据的增删改查操作。

4.2 @Document注解详解

4.2.1 标记实体类为文档

在Spring Data Elasticsearch中，我们可以通过 @Document 注解来标记一个普通的Java实体类，使其映射为Elasticsearch中的一个文档类型。该注解不仅定义了实体类与Elasticsearch文档之间的关联，还可以附加一些特定的配置，比如索引名称、类型名称和分片策略等。

通过使用 @Document 注解，开发者可以轻松地将JPA/Hibernate等ORM框架的使用经验迁移到Elasticsearch中，因为很多映射概念是相似的。一旦一个实体被 @Document 注解标记，Spring Data Elasticsearch就会自动提供一些CRUD操作的支持，无需再编写重复的代码。

4.2.2 文档字段映射与类型定义

@Document 注解内可以包含字段映射和类型的定义。例如，我们可以使用 @Field 注解来声明某个字段的类型和分析器。这允许开发者精确地定义每个字段的索引方式。例如，一个可能用于全文搜索的文本字段，可以被设置为使用标准分析器进行分词处理。

字段类型可以是Elasticsearch提供的所有数据类型，包括但不限于：keyword, text, long, double, date, ip, boolean等。通过指定正确的字段类型，可以确保Elasticsearch以最优的方式存储和索引数据，这对于查询性能至关重要。

4.3 实体类与Elasticsearch文档映射案例

4.3.1 基本映射案例

在基本的映射案例中，一个简单的Java实体类可以如下所示：

@Document(indexName = "blog", createIndex = true)
public class Post {
    @Id
    private String id;

    @Field(type = FieldType.Text)
    private String title;

    @Field(type = FieldType.Text)
    private String content;
    // 其他字段和getter/setter方法...
}

在上述示例中， @Document 注解指定了索引名称为 blog ，并且当索引不存在时自动创建它。每个字段通过 @Field 注解来声明其类型，比如 title 和 content 都被定义为可搜索的 text 类型。

4.3.2 高级映射特性展示

在高级映射特性展示中，我们可以展示如何为字段添加更复杂的映射，如嵌套类型、对象类型和特殊字段类型等。

@Document(indexName = "ecommerce", createIndex = true)
public class Product {
    @Id
    private String id;

    @Field(type = FieldType.Text, analyzer = "my_analyzer")
    private String name;

    @Field(type = FieldType.Nested)
    private List<Review> reviews;
    // 其他字段和getter/setter方法...
    @Embeddable
    public static class Review {
        @Field(type = FieldType.Integer)
        private int rating;

        @Field(type = FieldType.Text)
        private String comment;
        // getter/setter方法...
    }
}

在这个例子中， Product 类拥有一个名为 reviews 的嵌套字段，表示这个产品的用户评论列表。通过使用 @Nested 注解，Elasticsearch能够理解每个评论是一个独立的文档，但与其他评论共同嵌套在一个 Product 文档中。这提供了高效处理复杂数据结构的能力，特别是在需要对嵌套字段进行查询和聚合操作时。

嵌套对象需要单独定义映射，因此 Review 类被标记为 @Embeddable ，表明它可以嵌入到另一个文档中。字段 name 还使用了自定义的分析器 my_analyzer 进行文本分析。

通过以上的步骤和代码段，开发者可以实现对Elasticsearch文档模型的定义和映射，从而构建出强大而灵活的数据结构，满足复杂的查询和搜索需求。

5. ElasticsearchRepository接口操作示例

5.1 ElasticsearchRepository接口概念

5.1.1 接口的继承与功能简介

ElasticsearchRepository是Spring Data Elasticsearch框架提供的一个接口，它继承自 CrudRepository 和 PagingAndSortingRepository ，专门用于与Elasticsearch进行交互。通过这个接口，开发者可以非常方便地执行基本的CRUD（创建、读取、更新、删除）操作，无需编写复杂的Elasticsearch DSL（Domain Specific Language）查询语句。

接口继承结构如下：

public interface ElasticsearchRepository<T, ID> extends CrudRepository<T, ID>, PagingAndSortingRepository<T, ID> {
    // 这里可以添加自定义查询方法
}

ElasticsearchRepository 提供了大量的默认实现方法，用于执行常规的CRUD操作。它还支持对数据进行分页和排序，以及通过自定义方法名来实现高级查询，这些方法名遵循Spring Data的命名规则。

5.1.2 常用CRUD操作方法

ElasticsearchRepository接口中包含了一系列预先定义的方法，例如：

• save(T entity) ：保存单个文档。
• saveAll(Iterable<T> entities) ：批量保存文档。
• T findById(ID id) ：根据ID查找文档。
• Iterable<T> findAll() ：查找所有文档。
• Iterable<T> findAll(Sort sort) ：根据排序规则查找所有文档。
• long count() ：统计文档数量。
• void deleteById(ID id) ：根据ID删除文档。
• void delete(T entity) ：删除指定的文档。
• void deleteAll(Iterable<? extends T> entities) ：批量删除文档。
• void deleteAll() ：清空所有文档。

5.2 常用CRUD操作介绍

5.2.1 基础CRUD操作方法

基础的CRUD操作是任何持久层框架的基础。在ElasticsearchRepository中，这些操作已经被Spring Data简化到极致。以下是一些基本操作的例子：

// 保存文档
Article article = new Article();
article.setTitle("Spring Data Elasticsearch");
articleRepository.save(article);

// 查询文档
Article foundArticle = articleRepository.findById(article.getId()).orElse(null);

// 更新文档
foundArticle.setTitle("Spring Data Elasticsearch Updated");
articleRepository.save(foundArticle);

// 删除文档
articleRepository.deleteById(foundArticle.getId());

5.2.2 条件查询与高级查询方法

在ElasticsearchRepository中，可以通过方法名约定来执行复杂的查询。例如，如果我们想要根据标题进行搜索，可以定义如下方法：

List<Article> findByTitle(String title);

这个方法的实现是由Spring Data自动完成的，开发者只需要定义方法名即可。

// 根据标题搜索
List<Article> articles = articleRepository.findByTitle("Spring");

ElasticsearchRepository还支持使用@Query注解来编写自定义的Elasticsearch查询语句，如下：

@Query("{\"match\":{\"title\":\"?0\"}}")
List<Article> searchByTitleCustom(String title);

5.3 接口操作的实现与实践

5.3.1 编写示例代码展示接口操作

要展示接口操作，首先需要创建一个实体类和一个对应的Repository接口。下面是一个简单的 Article 实体类和对应的 ArticleRepository 接口。

@Entity
public class Article {
    @Id
    private String id;
    private String title;
    private String content;

    // getters and setters
}

@Repository
public interface ArticleRepository extends ElasticsearchRepository<Article, String> {
    // 这里可以添加自定义查询方法
}

然后，可以通过以下示例代码来演示如何使用这些接口进行数据操作：

@Service
public class ArticleService {
    private final ArticleRepository articleRepository;

    public ArticleService(ArticleRepository articleRepository) {
        this.articleRepository = articleRepository;
    }

    public void performCRUDOperations() {
        Article article = new Article("1", "Spring Boot", "Introduction to Spring Boot");
        articleRepository.save(article);

        Article foundArticle = articleRepository.findById("1").orElse(null);
        if (foundArticle != null) {
            System.out.println("Found: " + foundArticle.getTitle());
        }

        article.setTitle("Updated Spring Boot");
        articleRepository.save(article);

        articleRepository.deleteById("1");
    }
}

5.3.2 实际应用中接口的拓展与维护

在实际应用中，你可能会需要执行更加复杂的查询和数据处理。此时可以通过以下几种方式来拓展ElasticsearchRepository的功能：

• 自定义方法 ：按照Spring Data的约定来定义方法名，创建更具体的查询。
• @Query注解 ：通过编写自定义的Elasticsearch查询语句来实现复杂查询。
• 实现自定义接口 ：创建自定义接口，并提供默认实现，这些默认实现可以利用ElasticsearchRepository来简化逻辑。
• 继承ElasticsearchRepository接口 ：如果有多个Repository需要相同的自定义方法，可以创建一个自定义接口并继承ElasticsearchRepository，然后让这些Repository接口继承这个自定义接口。

通过这些方式，你可以根据实际业务需求，灵活地对ElasticsearchRepository接口进行拓展和维护。

6. CRUD操作的实现与示例代码

在使用Spring Data Elasticsearch进行数据操作时，CRUD（创建、读取、更新、删除）是最基本也是最常用的操作之一。这一章节，我们将详细介绍如何使用Spring Data Elasticsearch实现这些基本操作，并通过示例代码展示这些操作的具体实现。

6.1 创建（Create）操作详解

创建操作在Elasticsearch中主要对应着索引数据的插入和更新。在Spring Data Elasticsearch中，这可以通过实现的ElasticsearchRepository接口中的相应方法来完成。

6.1.1 实现文档的创建与批量创建

使用ElasticsearchRepository提供的save方法可以创建新的文档或将更新的文档保存到Elasticsearch中。如果是批量操作，可以使用saveAll方法。以下是一个简单的示例代码，展示了如何创建单个文档和批量创建文档。

// 单个文档创建
Book book = new Book();
book.setId("1");
book.setTitle("The Art of War");
book.setAuthor("Sun Tzu");
bookRepository.save(book);

// 批量文档创建
List<Book> books = new ArrayList<>();
books.add(new Book("2", "The Prince", "Niccolo Machiavelli"));
books.add(new Book("3", "Leviathan", "Thomas Hobbes"));
bookRepository.saveAll(books);

6.2 读取（Read）操作详解

读取操作涉及从Elasticsearch中获取单个文档或执行查询以检索多个文档。Spring Data Elasticsearch为这些操作提供了相应的方法。

6.2.1 单个文档的获取与搜索

获取单个文档，可以使用Repository中的findOne方法。若需要执行搜索，可以使用Spring Data Elasticsearch提供的高级查询功能。

// 单个文档获取
Optional<Book> bookById = bookRepository.findById("1");
if (bookById.isPresent()) {
    System.out.println("Book found: " + bookById.get().getTitle());
}

// 搜索所有文档
Iterable<Book> books = bookRepository.findAll();
for (Book book : books) {
    System.out.println("Book title: " + book.getTitle());
}

6.2.2 多文档的聚合查询与结果解析

在Elasticsearch中可以执行各种聚合查询，例如term聚合，这些聚合可以用来组织数据或为分析目的提供洞察。下面的代码演示了如何执行一个简单的term聚合查询。

// 执行聚合查询
NativeSearchQuery searchQuery = new NativeSearchQueryBuilder()
    .withQuery(matchAllQuery())
    .addAggregation(termsAggregation("authors").field("author"))
    .build();

Aggregations aggregations = elasticsearchRestTemplate
    .search(searchQuery, Book.class, BookSearchHit.class)
    .getAggregations();

Terms authorsAgg = aggregations.get("authors");
for (Terms.Bucket bucket : authorsAgg.getBuckets()) {
    System.out.println(bucket.getKeyAsString());
}

6.3 更新（Update）操作详解

更新操作在Elasticsearch中可以理解为对现有文档的修改。Spring Data Elasticsearch为简单和复杂更新提供了不同的方法。

6.3.1 文档的部分更新与全量更新

部分更新可以通过Repository中的save方法实现，如果传入的文档中id字段存在，则为更新操作，否则为创建操作。全量更新则需使用ElasticsearchRepository的update方法。

// 部分更新
book.setPrice(25.99);
bookRepository.save(book);

// 全量更新
Book updatedBook = new Book();
updatedBook.setId("1");
updatedBook.setTitle("The Art of War Revised");
updatedBook.setAuthor("Sun Tzu");
updatedBook.setPrice(27.99);
bookRepository.update(updatedBook);

6.4 删除（Delete）操作详解

删除操作用于从Elasticsearch索引中移除文档。

6.4.1 文档的单个删除与批量删除

删除单个文档可以使用deleteById方法。批量删除可以使用deleteInBatch方法。

// 单个删除
bookRepository.deleteById("1");

// 批量删除
List<String> ids = Arrays.asList("2", "3");
bookRepository.deleteAllById(ids);

以上代码片段展示了Spring Data Elasticsearch中CRUD操作的实现方式。通过实际的示例，我们可以看到这些操作的直接应用，并理解如何在Spring项目中有效地使用这些接口。这些基本操作是构建复杂业务逻辑的基石，对于开发者来说是不可或缺的。

本文还有配套的精品资源，点击获取

简介：本案例演示了如何将Elasticsearch 6.1.2与Spring框架集成，实现Java应用中的高效搜索功能。通过添加必要的依赖和配置数据源，介绍了在Spring项目中使用Elasticsearch进行基本的CRUD操作的方法，以及如何通过Spring Data Elasticsearch简化操作流程。案例包含使用注解定义实体类、操作接口的创建和简单增删改查操作。通过这种方式，开发者可以利用Elasticsearch的强大功能，快速构建具备高效搜索能力的Java应用。

本文还有配套的精品资源，点击获取