脚本字段和运行时字段
Spring Data Elasticsearch 支持脚本字段和运行时字段。有关脚本的详细信息，请参阅 Elasticsearch 文档 (www.elastic.co/guide/en/elasticsearch/reference/current/modules-scripting.html) 和运行时字段 (www.elastic.co/guide/en/elasticsearch/reference/8.9/runtime.html)。在 Spring Data Elasticsearch 的上下文中，你可以使用
-
脚本字段，用于返回在结果文档上计算并添加到返回文档中的字段。
-
运行时字段，在存储的文档上计算，并可以在查询中使用和/或在搜索结果中返回。
以下代码片段将展示你可以实现的功能（这些代码展示了命令式代码，但响应式实现的工作方式类似）。
人员实体
在这些示例中使用的实体是 Person 实体。这个实体有一个 birthDate 属性和一个 age 属性。虽然出生日期是固定的，但年龄取决于查询发出时的时间，需要动态计算。
import org.springframework.data.annotation.Id;
import org.springframework.data.elasticsearch.annotations.DateFormat;
import org.springframework.data.elasticsearch.annotations.Document;
import org.springframework.data.elasticsearch.annotations.Field;
import org.springframework.data.elasticsearch.annotations.ScriptedField;
import org.springframework.lang.Nullable;
import java.time.LocalDate;
import java.time.format.DateTimeFormatter;
import static org.springframework.data.elasticsearch.annotations.FieldType.*;
import java.lang.Integer;
@Document(indexName = "persons")
public record Person(
@Id
@Nullable
String id,
@Field(type = Text)
String lastName,
@Field(type = Text)
String firstName,
@Field(type = Keyword)
String gender,
@Field(type = Date, format = DateFormat.basic_date)
LocalDate birthDate,
@Nullable
@ScriptedField Integer age 1
) {
public Person(String id,String lastName, String firstName, String gender, String birthDate) {
this(id, 2
lastName,
firstName,
LocalDate.parse(birthDate, DateTimeFormatter.ISO_LOCAL_DATE),
gender,
null);
}
}
age属性将在搜索结果中计算并填充。一个方便的构造函数，用于设置测试数据。
请注意，age 属性被标注为 @ScriptedField。这会阻止在索引映射中写入相应的条目，并将该属性标记为从搜索响应中放入计算字段的目标。
仓库接口
本示例中使用的仓库：
public interface PersonRepository extends ElasticsearchRepository<Person, String> {
SearchHits<Person> findAllBy(ScriptedField scriptedField);
SearchHits<Person> findByGenderAndAgeLessThanEqual(String gender, Integer age, RuntimeField runtimeField);
}
服务类
服务类中注入了存储库和一个 ElasticsearchOperations 实例，以展示填充和使用 age 属性的几种方式。我们将代码分成不同的部分，以便在其中插入解释。
import org.springframework.data.elasticsearch.core.ElasticsearchOperations;
import org.springframework.data.elasticsearch.core.SearchHits;
import org.springframework.data.elasticsearch.core.query.Criteria;
import org.springframework.data.elasticsearch.core.query.CriteriaQuery;
import org.springframework.data.elasticsearch.core.query.FetchSourceFilter;
import org.springframework.data.elasticsearch.core.query.RuntimeField;
import org.springframework.data.elasticsearch.core.query.ScriptData;
import org.springframework.data.elasticsearch.core.query.ScriptType;
import org.springframework.data.elasticsearch.core.query.ScriptedField;
import org.springframework.data.elasticsearch.core.query.StringQuery;
import org.springframework.stereotype.Service;
import java.util.List;
@Service
public class PersonService {
private final ElasticsearchOperations operations;
private final PersonRepository repository;
public PersonService(ElasticsearchOperations operations, SaRPersonRepository repository) {
this.operations = operations;
this.repository = repository;
}
public void save() { 1
List<Person> persons = List.of(
new Person("1", "Smith", "Mary", "f", "1987-05-03"),
new Person("2", "Smith", "Joshua", "m", "1982-11-17"),
new Person("3", "Smith", "Joanna", "f", "2018-03-27"),
new Person("4", "Smith", "Alex", "m", "2020-08-01"),
new Person("5", "McNeill", "Fiona", "f", "1989-04-07"),
new Person("6", "McNeill", "Michael", "m", "1984-10-20"),
new Person("7", "McNeill", "Geraldine", "f", "2020-03-02"),
new Person("8", "McNeill", "Patrick", "m", "2022-07-04"));
repository.saveAll(persons);
}
一个用于在 Elasticsearch 中存储一些数据的实用方法。
脚本字段
下一段展示了如何使用脚本字段来计算并返回人员的年龄。脚本字段只能向返回的数据中添加内容，无法在查询中使用年龄（请参阅运行时字段以了解相关功能）。
public SearchHits<Person> findAllWithAge() {
var scriptedField = ScriptedField.of("age", 1
ScriptData.of(b -> b
.withType(ScriptType.INLINE)
.withScript("""
Instant currentDate = Instant.ofEpochMilli(new Date().getTime());
Instant startDate = doc['birth-date'].value.toInstant();
return (ChronoUnit.DAYS.between(startDate, currentDate) / 365);
""")));
// version 1: use a direct query
var query = new StringQuery("""
{ "match_all": {} }
""");
query.addScriptedField(scriptedField); 2
query.addSourceFilter(FetchSourceFilter.of(b -> b.withIncludes("*"))); 3
var result1 = operations.search(query, Person.class); 4
// version 2: use the repository
var result2 = repository.findAllBy(scriptedField); 5
return result1;
}
定义一个
ScriptedField，用于计算一个人的年龄。在使用
Query时，将脚本字段添加到查询中。当向
Query添加脚本字段时，需要一个额外的源过滤器来从文档源中检索正常字段。获取数据，其中
Person实体的age属性现在已设置值。在使用存储库时，只需将脚本字段作为方法参数添加即可。
运行时字段
在使用运行时字段时，计算值可以在查询本身中使用。在以下代码中，这用于运行一个针对给定性别和最大年龄的查询：
public SearchHits<Person> findWithGenderAndMaxAge(String gender, Integer maxAge) {
var runtimeField = new RuntimeField("age", "long", """ 1
Instant currentDate = Instant.ofEpochMilli(new Date().getTime());
Instant startDate = doc['birthDate'].value.toInstant();
emit (ChronoUnit.DAYS.between(startDate, currentDate) / 365);
""");
// variant 1 : use a direct query
var query = CriteriaQuery.builder(Criteria
.where("gender").is(gender)
.and("age").lessThanEqual(maxAge))
.withRuntimeFields(List.of(runtimeField)) 2
.withFields("age") 3
.withSourceFilter(FetchSourceFilter.of(b -> b.withIncludes("*"))) 4
.build();
var result1 = operations.search(query, Person.class); 5
// variant 2: use the repository // <6>
var result2 = repository.findByGenderAndAgeLessThanEqual(gender, maxAge, runtimeField);
return result1;
}
}
定义一个运行时字段，用于计算一个人的年龄。// 有关内置属性的信息，请参阅 asciidoctor.org/docs/user-manual/#builtin-attributes。
在使用
Query时，添加运行时字段。在向
Query添加脚本字段时，需要一个额外的字段参数来返回计算值。在向
Query添加脚本字段时，需要一个额外的源过滤器以从文档源中检索正常字段。获取通过查询过滤的数据，并确保返回的实体具有年龄属性。
使用仓库时，只需将运行时字段作为方法参数添加即可。
除了在查询中定义运行时字段外，还可以通过在 @Mapping 注解中设置 runtimeFieldsPath 属性来在索引中定义运行时字段。该属性应指向包含运行时字段定义的 JSON 文件。