其他 Elasticsearch 操作支持

本章涵盖了无法通过 repository 接口直接访问的 Elasticsearch 操作的其他支持。建议按照自定义 Repository 实现中所述将这些操作添加为自定义实现。

索引设置

在使用 Spring Data Elasticsearch 创建 Elasticsearch 索引时，可以通过使用 @Setting 注解定义不同的索引设置。以下参数可用

useServerConfiguration 不发送任何设置参数，因此 Elasticsearch 服务器配置决定它们。
settingPath 指的是一个 JSON 文件，其中定义了必须在 classpath 中可解析的设置
shards 要使用的分片数量，默认为 1
replicas 副本数量，默认为 1
refreshIntervall，默认为 "1s"
indexStoreType，默认为 "fs"

还可以定义索引排序（请查阅链接的 Elasticsearch 文档以了解可能的字段类型和值）

@Document(indexName = "entities")
@Setting(
  sortFields = { "secondField", "firstField" },                                  (1)
  sortModes = { Setting.SortMode.max, Setting.SortMode.min },                    (2)
  sortOrders = { Setting.SortOrder.desc, Setting.SortOrder.asc },
  sortMissingValues = { Setting.SortMissing._last, Setting.SortMissing._first })
class Entity {
    @Nullable
    @Id private String id;

    @Nullable
    @Field(name = "first_field", type = FieldType.Keyword)
    private String firstField;

    @Nullable @Field(name = "second_field", type = FieldType.Keyword)
    private String secondField;

    // getter and setter...
}

1	定义排序字段时，使用 Java 属性的名称 (firstField)，而不是可能为 Elasticsearch 定义的名称 (first_field)
2	`sortModes`、`sortOrders` 和 `sortMissingValues` 是可选的，但如果设置了它们，条目数量必须与 `sortFields` 元素的数量匹配

索引映射

当 Spring Data Elasticsearch 使用 IndexOperations.createMapping() 方法创建索引映射时，它使用映射注解概述中描述的注解，特别是 @Field 注解。此外，还可以向类添加 @Mapping 注解。此注解具有以下属性

mappingPath 一个 JSON 格式的 classpath 资源；如果此不为空，则将其用作映射，不进行其他映射处理。
enabled 当设置为 false 时，此标志将写入映射，并且不再进行进一步处理。
dateDetection 和 numericDetection 在未设置为 DEFAULT 时，设置映射中相应的属性。
dynamicDateFormats 当此字符串数组不为空时，它定义了用于自动日期检测的日期格式。
runtimeFieldsPath 一个 JSON 格式的 classpath 资源，包含写入索引映射的运行时字段定义，例如

{
  "day_of_week": {
    "type": "keyword",
    "script": {
      "source": "emit(doc['@timestamp'].value.dayOfWeekEnum.getDisplayName(TextStyle.FULL, Locale.ROOT))"
    }
  }
}

过滤器构建器

过滤器构建器提高了查询速度。

private ElasticsearchOperations operations;

IndexCoordinates index = IndexCoordinates.of("sample-index");

Query query = NativeQuery.builder()
	.withQuery(q -> q
		.matchAll(ma -> ma))
	.withFilter( q -> q
		.bool(b -> b
			.must(m -> m
				.term(t -> t
					.field("id")
					.value(documentId))
			)))
	.build();

SearchHits<SampleEntity> sampleEntities = operations.search(query, SampleEntity.class, index);

使用滚动获取大结果集

Elasticsearch 有一个滚动 API，用于分块获取大结果集。Spring Data Elasticsearch 内部使用它来提供 <T> SearchHitsIterator<T> SearchOperations.searchForStream(Query query, Class<T> clazz, IndexCoordinates index) 方法的实现。

IndexCoordinates index = IndexCoordinates.of("sample-index");

Query searchQuery = NativeQuery.builder()
    .withQuery(q -> q
        .matchAll(ma -> ma))
    .withFields("message")
    .withPageable(PageRequest.of(0, 10))
    .build();

SearchHitsIterator<SampleEntity> stream = elasticsearchOperations.searchForStream(searchQuery, SampleEntity.class,
index);

List<SampleEntity> sampleEntities = new ArrayList<>();
while (stream.hasNext()) {
  sampleEntities.add(stream.next());
}

stream.close();

SearchOperations API 中没有访问滚动 ID 的方法，如果需要访问它，可以使用 AbstractElasticsearchTemplate 的以下方法（这是不同 ElasticsearchOperations 实现的基础实现）

@Autowired ElasticsearchOperations operations;

AbstractElasticsearchTemplate template = (AbstractElasticsearchTemplate)operations;

IndexCoordinates index = IndexCoordinates.of("sample-index");

Query query = NativeQuery.builder()
    .withQuery(q -> q
        .matchAll(ma -> ma))
    .withFields("message")
    .withPageable(PageRequest.of(0, 10))
    .build();

SearchScrollHits<SampleEntity> scroll = template.searchScrollStart(1000, query, SampleEntity.class, index);

String scrollId = scroll.getScrollId();
List<SampleEntity> sampleEntities = new ArrayList<>();
while (scroll.hasSearchHits()) {
  sampleEntities.addAll(scroll.getSearchHits());
  scrollId = scroll.getScrollId();
  scroll = template.searchScrollContinue(scrollId, 1000, SampleEntity.class);
}
template.searchScrollClear(scrollId);

要将滚动 API 与 repository 方法一起使用，返回类型必须在 Elasticsearch Repository 中定义为 Stream。该方法的实现将使用 ElasticsearchTemplate 中的滚动方法。

interface SampleEntityRepository extends Repository<SampleEntity, String> {

    Stream<SampleEntity> findBy();

}

排序选项

除了分页和排序中描述的默认排序选项外，Spring Data Elasticsearch 还提供了 org.springframework.data.elasticsearch.core.query.Order 类，该类派生自 org.springframework.data.domain.Sort.Order。它提供了在指定结果排序时可以发送到 Elasticsearch 的附加参数（请参阅 www.elastic.co/guide/en/elasticsearch/reference/7.15/sort-search-results.html）。

还有一个 org.springframework.data.elasticsearch.core.query.GeoDistanceOrder 类，可用于按地理距离对搜索操作的结果进行排序。

如果要检索的类具有名为 location 的 GeoPoint 属性，则以下 Sort 将按与给定点的距离对结果进行排序

Sort.by(new GeoDistanceOrder("location", new GeoPoint(48.137154, 11.5761247)))

运行时字段

从版本 7.12 开始，Elasticsearch 添加了运行时字段功能（www.elastic.co/guide/en/elasticsearch/reference/7.12/runtime.html）。Spring Data Elasticsearch 以两种方式支持此功能

索引映射中的运行时字段定义

定义运行时字段的第一种方法是将定义添加到索引映射中（请参阅 www.elastic.co/guide/en/elasticsearch/reference/7.12/runtime-mapping-fields.html）。要在 Spring Data Elasticsearch 中使用此方法，用户必须提供一个包含相应定义的 JSON 文件，例如

示例 1. runtime-fields.json

{
  "day_of_week": {
    "type": "keyword",
    "script": {
      "source": "emit(doc['@timestamp'].value.dayOfWeekEnum.getDisplayName(TextStyle.FULL, Locale.ROOT))"
    }
  }
}

然后必须在实体的 @Mapping 注解中设置此 JSON 文件的路径，该文件必须存在于 classpath 中

@Document(indexName = "runtime-fields")
@Mapping(runtimeFieldsPath = "/runtime-fields.json")
public class RuntimeFieldEntity {
	// properties, getter, setter,...
}

在查询上设置的运行时字段定义

定义运行时字段的第二种方法是将定义添加到搜索查询中（请参阅 www.elastic.co/guide/en/elasticsearch/reference/7.12/runtime-search-request.html）。以下代码示例展示了如何使用 Spring Data Elasticsearch 执行此操作

使用的实体是一个简单的对象，它有一个 price 属性

@Document(indexName = "some_index_name")
public class SomethingToBuy {

	private @Id @Nullable String id;
	@Nullable @Field(type = FieldType.Text) private String description;
	@Nullable @Field(type = FieldType.Double) private Double price;

	// getter and setter
}

以下查询使用一个运行时字段，通过将价格增加 19% 来计算 priceWithTax 值，并在搜索查询中使用此值查找所有 priceWithTax 高于或等于给定值的实体

RuntimeField runtimeField = new RuntimeField("priceWithTax", "double", "emit(doc['price'].value * 1.19)");
Query query = new CriteriaQuery(new Criteria("priceWithTax").greaterThanEqual(16.5));
query.addRuntimeField(runtimeField);

SearchHits<SomethingToBuy> searchHits = operations.search(query, SomethingToBuy.class);

这适用于 Query 接口的每个实现。

时间点 (PIT) API

ElasticsearchOperations 支持 Elasticsearch 的时间点 API（请参阅 www.elastic.co/guide/en/elasticsearch/reference/8.3/point-in-time-api.html）。以下代码片段展示了如何将此功能与虚构的 Person 类一起使用

ElasticsearchOperations operations; // autowired
Duration tenSeconds = Duration.ofSeconds(10);

String pit = operations.openPointInTime(IndexCoordinates.of("person"), tenSeconds); (1)

// create query for the pit
Query query1 = new CriteriaQueryBuilder(Criteria.where("lastName").is("Smith"))
    .withPointInTime(new Query.PointInTime(pit, tenSeconds))                        (2)
    .build();
SearchHits<Person> searchHits1 = operations.search(query1, Person.class);
// do something with the data

// create 2nd query for the pit, use the id returned in the previous result
Query query2 = new CriteriaQueryBuilder(Criteria.where("lastName").is("Miller"))
    .withPointInTime(
        new Query.PointInTime(searchHits1.getPointInTimeId(), tenSeconds))          (3)
    .build();
SearchHits<Person> searchHits2 = operations.search(query2, Person.class);
// do something with the data

operations.closePointInTime(searchHits2.getPointInTimeId());                        (4)

1	为索引（可以有多个名称）和保持活动持续时间创建时间点，并检索其 ID
2	将该 ID 传递给查询以进行搜索，以及下一个保持活动值
3	对于下一个查询，使用上次搜索返回的 ID
4	完成后，使用最后返回的 ID 关闭时间点

搜索模板支持

支持使用搜索模板 API。为此，首先需要创建一个存储脚本。ElasticsearchOperations 接口扩展了 ScriptOperations，后者提供了必要的功能。这里使用的示例假设我们有一个带有名为 firstName 属性的 Person 实体。搜索模板脚本可以这样保存

import org.springframework.data.elasticsearch.core.ElasticsearchOperations;
import org.springframework.data.elasticsearch.core.script.Script;

operations.putScript(                            (1)
  Script.builder()
    .withId("person-firstname")                  (2)
    .withLanguage("mustache")                    (3)
    .withSource("""                              (4)
      {
        "query": {
          "bool": {
            "must": [
              {
                "match": {
                  "firstName": "{{firstName}}"   (5)
                }
              }
            ]
          }
        },
        "from": "{{from}}",                      (6)
        "size": "{{size}}"                       (7)
      }
      """)
    .build()
);

1	使用 `putScript()` 方法存储搜索模板脚本
2	脚本的名称/ID
3	搜索模板中使用的脚本必须是 mustache 语言。
4	脚本源
5	脚本中的搜索参数
6	分页请求偏移量
7	分页请求大小

要在搜索查询中使用搜索模板，Spring Data Elasticsearch 提供了 SearchTemplateQuery，它是 org.springframework.data.elasticsearch.core.query.Query 接口的一个实现。

尽管 SearchTemplateQuery 是 Query 接口的一个实现，但基类提供的所有功能并非都可用于 SearchTemplateQuery，例如设置 Pageable 或 Sort。此功能的数值必须添加到存储脚本中，如以下分页参数示例所示。如果这些值设置在 Query 对象上，它们将被忽略。

在以下代码中，我们将添加一个使用搜索模板查询的调用到自定义 repository 实现（请参阅自定义 Repository 实现）作为如何将其集成到 repository 调用中的示例。

我们首先定义自定义 repository 片段接口

interface PersonCustomRepository {
	SearchPage<Person> findByFirstNameWithSearchTemplate(String firstName, Pageable pageable);
}

此 repository 片段的实现如下

public class PersonCustomRepositoryImpl implements PersonCustomRepository {

  private final ElasticsearchOperations operations;

  public PersonCustomRepositoryImpl(ElasticsearchOperations operations) {
    this.operations = operations;
  }

  @Override
  public SearchPage<Person> findByFirstNameWithSearchTemplate(String firstName, Pageable pageable) {

    var query = SearchTemplateQuery.builder()                               (1)
      .withId("person-firstname")                                           (2)
      .withParams(
        Map.of(                                                             (3)
          "firstName", firstName,
          "from", pageable.getOffset(),
          "size", pageable.getPageSize()
          )
      )
      .build();

    SearchHits<Person> searchHits = operations.search(query, Person.class); (4)

    return SearchHitSupport.searchPageFor(searchHits, pageable);
  }
}

1	创建一个 `SearchTemplateQuery`
2	提供搜索模板的 ID
3	参数以 `Map<String,Object>` 的形式传递
4	以与其他查询类型相同的方式进行搜索。

嵌套排序

Spring Data Elasticsearch 支持嵌套对象中的排序（www.elastic.co/guide/en/elasticsearch/reference/8.9/sort-search-results.html#nested-sorting）

以下示例取自 org.springframework.data.elasticsearch.core.query.sort.NestedSortIntegrationTests 类，展示了如何定义嵌套排序。

var filter = StringQuery.builder("""
	{ "term": {"movies.actors.sex": "m"} }
	""").build();
var order = new org.springframework.data.elasticsearch.core.query.Order(Sort.Direction.DESC,
	"movies.actors.yearOfBirth")
	.withNested(
		Nested.builder("movies")
			.withNested(
				Nested.builder("movies.actors")
					.withFilter(filter)
					.build())
			.build());

var query = Query.findAll().addSort(Sort.by(order));

关于过滤器查询：这里不能使用 CriteriaQuery，因为此查询将转换为 Elasticsearch 嵌套查询，这在过滤器上下文中不起作用。因此，这里只能使用 StringQuery 或 NativeQuery。当使用其中之一时，例如上面的 term 查询，必须使用 Elasticsearch 字段名，因此在使用 @Field(name="…") 定义重新定义时要小心。

对于 order path 和 nested paths 的定义，应使用 Java 实体属性名称。