|
此版本仍在开发中，尚不被认为是稳定的。对于最新的稳定版本，请使用 Spring Data Elasticsearch 5.5.2！ |
其他 Elasticsearch作支持
本章介绍了对无法通过存储库接口直接访问的 Elasticsearch作的其他支持。 建议将这些作添加为自定义实现，如 自定义存储库实现 中所述。
索引设置
使用 Spring Data Elasticsearch 创建 Elasticsearch 索引时，可以使用@Setting注解。
以下参数可用：
-
useServerConfiguration不发送任何设置参数，因此 Elasticsearch 服务器配置会确定它们。 -
settingPath指一个 JSON 文件，该文件定义了必须在类路径中可解析的设置 -
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类的注释。
此注解具有以下属性：
-
mappingPathJSON 格式的类路径资源;如果它不为空，则将其用作映射，则不执行其他映射处理。 -
enabled当设置为 false 时，此标志将写入映射，并且不会进行进一步的处理。 -
dateDetection和numericDetection未设置为 时，在映射中设置相应的属性DEFAULT. -
dynamicDateFormats当此 String 数组不为空时，它定义用于自动日期检测的日期格式。 -
runtimeFieldsPathJSON 格式的类路径资源，其中包含写入索引映射的运行时字段的定义，例如：
{
"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();中没有方法。SearchOperationsAPI 来访问滚动 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);要将 Scroll API 与存储库方法一起使用，返回类型必须定义为Stream在 Elasticsearch 存储库中。
然后，该方法的实现将使用 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类，可用于获得按地理距离排序的搜索作的结果。
如果要检索的类具有GeoPoint名为 location 的属性，则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 文件，例如：
{
"day_of_week": {
"type": "keyword",
"script": {
"source": "emit(doc['@timestamp'].value.dayOfWeekEnum.getDisplayName(TextStyle.FULL, Locale.ROOT))"
}
}
}此 JSON 文件的路径必须存在于类路径上，然后必须在@Mapping实体的注释：
@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
}以下查询使用运行时字段，该字段计算priceWithTax值，方法是将价格加 19%，并在搜索查询中使用此值来查找其中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它提供了必要的功能。
这里使用的示例假设我们有Person实体，其属性名为firstName.
搜索模板脚本可以像这样保存：
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对象，它们将被忽略。 |
在以下代码中，我们将使用搜索模板查询将调用添加到自定义存储库实现（请参阅自定义存储库实现）作为示例，了解如何将其集成到存储库调用中。
我们首先定义自定义仓库片段接口：
interface PersonCustomRepository {
SearchPage<Person> findByFirstNameWithSearchTemplate(String firstName, Pageable pageable);
}此存储库片段的实现如下所示：
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可以在这里使用。当使用其中之一时，例如上面的术语查询，必须使用 Elasticsearch 字段名称，因此请注意，当使用@Field(name="…")定义。
对于订单路径和嵌套路径的定义，应使用 Java 实体属性名称。