Elasticsearch 仓库

本章包含 Elasticsearch 仓库实现的详细信息。

示例 1. 示例 Book 实体

@Document(indexName="books")
class Book {
    @Id
    private String id;

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

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

    @Field(type = FieldType.Integer)
    private Integer price;

	// getter/setter ...
}

自动创建索引及相应的映射

@Document 注解有一个参数 createIndex。如果此参数设置为 true（这是默认值），则 Spring Data Elasticsearch 在应用程序启动时引导仓库支持期间，会检查 @Document 注解定义的索引是否存在。如果不存在，则会创建索引，并将从实体注解派生的映射（请参阅Elasticsearch 对象映射）写入新创建的索引中。

可以使用 @Setting 注解来设置将要创建的索引的详细信息，更多信息请参阅索引设置。

仓库方法的注解

@Highlight

@Highlight 注解在仓库方法上定义了返回实体中的哪些字段应包含高亮显示。要在 Book 的名称或摘要中搜索某些文本并高亮显示找到的数据，可以使用以下仓库方法：

interface BookRepository extends Repository<Book, String> {

    @Highlight(fields = {
        @HighlightField(name = "name"),
        @HighlightField(name = "summary")
    })
    SearchHits<Book> findByNameOrSummary(String text, String summary);
}

可以像上面那样定义多个需要高亮的字段，并且 @Highlight 和 @HighlightField 注解都可以通过 @HighlightParameters 注解进行进一步定制。请查阅 Javadocs 以了解可能的配置选项。

在搜索结果中，可以从 SearchHit 类中检索高亮数据显示。

@SourceFilters

有时用户不需要搜索返回实体中的所有属性，而只需要一部分。Elasticsearch 提供了源过滤（source filtering）来减少通过网络传输到应用程序的数据量。

在使用 Query 实现和 ElasticsearchOperations 时，通过在查询中设置源过滤器可以轻松实现这一点。

使用仓库方法时，可以使用 @SourceFilters 注解

interface BookRepository extends Repository<Book, String> {

    @SourceFilters(includes = "name")
    SearchHits<Book> findByName(String text);
}

在此示例中，返回的 Book 对象的所有属性都将是 null，除了 name。

基于注解的配置

Spring Data Elasticsearch 仓库支持可以通过 JavaConfig 使用注解激活。

示例 2. 使用 JavaConfig 的 Spring Data Elasticsearch 仓库

@Configuration
@EnableElasticsearchRepositories(                             (1)
  basePackages = "org.springframework.data.elasticsearch.repositories"
  )
static class Config {

  @Bean
  public ElasticsearchOperations elasticsearchTemplate() {    (2)
      // ...
  }
}

class ProductService {

  private ProductRepository repository;                       (3)

  public ProductService(ProductRepository repository) {
    this.repository = repository;
  }

  public Page<Product> findAvailableBookByName(String name, Pageable pageable) {
    return repository.findByAvailableTrueAndNameStartingWith(name, pageable);
  }
}

1	`EnableElasticsearchRepositories` 注解激活了仓库支持。如果没有配置基础包，它将使用应用该注解的配置类所在的包。
2	通过使用 Elasticsearch 操作一章中显示的配置之一，提供一个名为 `elasticsearchTemplate`、类型为 `ElasticsearchOperations` 的 Bean。
3	让 Spring 将仓库 Bean 注入到您的类中。

Spring 命名空间

Spring Data Elasticsearch 模块包含一个自定义命名空间，允许定义仓库 Bean 以及实例化 ElasticsearchServer 的元素。

使用 repositories 元素查找 Spring Data 仓库，如创建仓库实例中所述。

示例 3. 使用命名空间设置 Elasticsearch 仓库

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xmlns:elasticsearch="http://www.springframework.org/schema/data/elasticsearch"
       xsi:schemaLocation="http://www.springframework.org/schema/beans
       https://www.springframework.org/schema/beans/spring-beans-3.1.xsd
       http://www.springframework.org/schema/data/elasticsearch
       https://www.springframework.org/schema/data/elasticsearch/spring-elasticsearch-1.0.xsd">

  <elasticsearch:repositories base-package="com.acme.repositories" />

</beans>

使用 Transport Client 或 Rest Client 元素在上下文中注册一个 Elasticsearch Server 实例。

示例 4. 使用命名空间的 Transport Client

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xmlns:elasticsearch="http://www.springframework.org/schema/data/elasticsearch"
       xsi:schemaLocation="http://www.springframework.org/schema/beans
       https://www.springframework.org/schema/beans/spring-beans-3.1.xsd
       http://www.springframework.org/schema/data/elasticsearch
       https://www.springframework.org/schema/data/elasticsearch/spring-elasticsearch-1.0.xsd">

  <elasticsearch:transport-client id="client" cluster-nodes="localhost:9300,someip:9300" />

</beans>

示例 5. 使用命名空间的 Rest Client

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xmlns:elasticsearch="http://www.springframework.org/schema/data/elasticsearch"
       xsi:schemaLocation="http://www.springframework.org/schema/data/elasticsearch
       https://www.springframework.org/schema/data/elasticsearch/spring-elasticsearch.xsd
       http://www.springframework.org/schema/beans
       https://www.springframework.org/schema/beans/spring-beans.xsd">

  <elasticsearch:rest-client id="restClient" hosts="http://localhost:9200">

</beans>