Elasticsearch.NET 8.x 版本中SourceIncludes字段过滤的使用指南

背景介绍

在Elasticsearch.NET客户端库中，字段过滤是一个常见的优化需求。开发者通常只需要检索文档的部分字段而非全部内容，这可以显著减少网络传输数据量并提高查询性能。在NEST客户端中，这一功能通过SourceIncludes方法实现，但在迁移到Elastic.Clients.Elasticsearch 8.x版本时，开发者可能会遇到一些使用上的变化。

新旧版本实现差异

在NEST客户端中，字段过滤的典型实现方式如下：

search = search.Source(s => s
    .Includes(i => i
        .Fields(
            f => f.Id,
            f => f.Title
        )
    )
);

这种方式会在请求体中生成_source.includes字段，明确指定需要返回的字段列表。

而在Elastic.Clients.Elasticsearch 8.x版本中，默认的SourceIncludes方法行为发生了变化：

search = search.SourceIncludes(Fields.FromFields([
    Infer.Field<SearchAlert>(f => f.Id), 
    Infer.Field<SearchAlert>(f => f.Title)
]));

8.x版本的正确使用方式

经过验证，8.x版本中有两种实现字段过滤的方法：

1. URL参数方式（默认行为）：

search = search.SourceIncludes(Fields.FromFields([
    Infer.Field<SearchAlert>(f => f.Id),
    Infer.Field<SearchAlert>(f => f.Title)
]));

这种方式会将过滤字段作为URL参数发送，而不是放在请求体中。

2. 请求体方式：

search = search.Source(new SourceConfig(new SourceFilter
{
    Includes = Fields.FromFields([
        Infer.Field<SearchAlert>(f => f.Id),
        Infer.Field<SearchAlert>(f => f.Title)
    ])
}));

这种方式会在请求体中生成_source字段，与NEST客户端的行为一致。

字段指定方法

在8.x版本中，推荐使用Infer类来指定字段：

Infer.Fields<MyDocument>(x => x.Field1, x => x.Field2)

这种方式既清晰又类型安全，能够有效避免字段名拼写错误的问题。

实际应用建议

1. 如果需要与旧系统保持兼容，或者明确需要在请求体中包含字段过滤信息，请使用请求体方式。

2. 对于新开发的项目，URL参数方式是更高效的选择，因为它减少了请求体的大小。

3. 在复杂查询场景中，特别是需要同时使用字段包含和排除规则时，SourceFilter提供了更灵活的控制能力。

总结

Elasticsearch.NET 8.x版本在字段过滤功能上提供了更多的灵活性，开发者可以根据实际需求选择不同的实现方式。理解这些差异有助于在迁移过程中做出正确的技术选择，确保查询性能和数据传输效率的最优化。

对于从NEST迁移过来的开发者，建议逐步适应新的API设计理念，同时利用类型安全的字段指定方式来提高代码的健壮性。