Elasticsearch .NET客户端9.0版本全面解析与技术指南

钟洁祺

于 2025-06-11 09:02:06 发布

阅读量316

点赞数 4

CC 4.0 BY-SA版权

本文链接：https://blog.youkuaiyun.com/gitblog_00056/article/details/148575258

Elasticsearch .NET客户端9.0版本全面解析与技术指南

elasticsearch-net This strongly-typed, client library enables working with Elasticsearch. It is the official client maintained and supported by Elastic. 项目地址: https://gitcode.com/gh_mirrors/el/elasticsearch-net

前言

Elasticsearch .NET客户端9.0版本是一次重大更新，带来了诸多改进和新特性。本文将深入解析这些变化，帮助开发者更好地理解和使用新版客户端。

核心改进概览

1. 请求方法API变更

1.1 同步请求API恢复

9.0版本取消了同步请求API的obsolete标记，这是基于开发者反馈做出的调整。现在开发者可以继续使用同步API而无需担心兼容性问题。

1.2 请求/响应类型分离

新增了请求和响应类型分离的支持，使得API更加灵活：

var response = await client.SearchAsync<Person, JsonObject>(x => x
    .Query(x => x.Term(x => x.Field(x => x.FirstName).Value("Florian")))
);

2. 流式API增强

9.0版本对流式API进行了全面增强，支持更多数据结构：

2.1 集合类型(ICollection )

new SearchRequestDescriptor<Person>()
    .Query(q => q
        .Bool(b => b
            .Must(new Query())  // 单个元素
            .Must(new Query(), new Query())  // 多个元素
        )
    );

2.2 字典类型(IDictionary<K, V>)

新增完整的字典类型支持：

new SearchRequestDescriptor<Person>()
    .Aggregations(aggs => aggs
        .Add("key", new MaxAggregation())  // 键值对
    );

3. 描述符设计改进

描述符现在包装了对象表示，带来多项改进：

3.1 包装现有对象

var request = new SearchRequest();
var descriptor = new SearchRequestDescriptor(request);

3.2 解包检查

var descriptor = new SearchRequestDescriptor();
SearchRequest request = descriptor;  // 隐式转换

4. 请求路径参数属性化

路径参数现在作为属性暴露：

var request = new SearchRequest { Indices = Indices.All };
request.Indices = "my_index";

高级特性详解

5. 字段名推断优化

移除了对null返回值的需求：

Field field = "field";  // 9.0更简洁

6. 日期时间类型统一

所有日期时间值统一表示为DateTimeOffset，持续时间使用TimeSpan：

// 更一致的日期时间处理

7. 容器设计改进

容器类型初始化更直观：

var agg = new Aggregation
{
    Max = new MaxAggregation { Field = "my_field" },
    Aggregations = new Dictionary<string, Aggregation>
    {
        { "my_sub_agg", new Aggregation{ Terms = new TermsAggregation() } }
    }
};

8. 排序API优化

排序语法更加简洁：

var search = new SearchRequestDescriptor<Person>()
    .Sort(
        x => x.Score(),
        x => x.Field(x => x.Age, SortOrder.Desc)
    );

9. 更安全的对象创建

通过构造函数强制初始化必要属性，防止无效请求：

// 9.0强制初始化必要属性

10. 序列化改进

全面重写序列化系统，支持往返序列化：

var json = client.ElasticsearchClientSettings.RequestResponseSerializer.SerializeToString(request);
var searchRequestBody = client.ElasticsearchClientSettings.RequestResponseSerializer.Deserialize<SearchRequest>(json)!;