Elasticsearch 存储库

本章包括 Elasticsearch 存储库实施的详细信息。spring-doc.cadn.net.cn

示例 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 ...
}

使用相应的映射自动创建索引

这@Documentannotation 有一个参数createIndex. 如果此参数设置为 true（这是默认值），则 Spring Data Elasticsearch 将在引导存储库支持期间，在应用程序启动时检查由@Document注释存在。spring-doc.cadn.net.cn

如果不存在，则将创建索引，并将从实体注释派生的映射（请参阅 Elasticsearch 对象映射）写入新创建的索引。可以使用@Settingannotation 中，请参阅 Index settings 以了解更多信息。spring-doc.cadn.net.cn

存储库方法的注释

@Highlight

这@HighlightRepository 方法上的注释定义应包含返回的实体突出显示的哪些字段。要在Book的名称或摘要，并突出显示找到的数据，则可以使用以下存储库方法：spring-doc.cadn.net.cn

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 以获取可能的配置选项。spring-doc.cadn.net.cn

在搜索结果中，可以从SearchHit类。spring-doc.cadn.net.cn

@SourceFilters

有时，用户不需要从搜索中返回实体的所有属性，而只需要返回一个子集。 Elasticsearch 提供源筛选功能，以减少通过网络传输到应用。spring-doc.cadn.net.cn

使用Queryimplementations 和ElasticsearchOperations这可以通过设置 source 筛选条件。spring-doc.cadn.net.cn

当使用仓库方法时，有@SourceFilters注解：spring-doc.cadn.net.cn

interface BookRepository extends Repository<Book, String> {

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

在此示例中，返回的Book对象将是null除了名字。spring-doc.cadn.net.cn

基于注释的配置

Spring Data Elasticsearch 存储库支持可以通过 JavaConfig 使用注释来激活。spring-doc.cadn.net.cn

示例 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`annotation 激活存储库支持。如果未配置基础包，它将使用它所放置的配置类之一。
2	提供一个名为`elasticsearchTemplate`的类型`ElasticsearchOperations`通过使用 Elasticsearch Operations 章节中显示的配置之一。
3	让 Spring 将 Repository bean 注入到你的类中。

Spring 命名空间

Spring Data Elasticsearch 模块包含一个自定义命名空间，允许定义存储库 bean 以及用于实例化ElasticsearchServer.spring-doc.cadn.net.cn

使用repositories元素查找 Spring Data 存储库，如创建存储库实例中所述。spring-doc.cadn.net.cn

例 3.使用 Namespace 设置 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在上下文中。spring-doc.cadn.net.cn

示例 4.使用 Namespace 的传输客户端

<?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.使用 Namespace 的 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>