Elasticsearch-NET 8.x 版本中自定义序列化器的实现方法

在 Elasticsearch-NET 8.x 最新版本中，自定义 JSON 序列化器的实现方式有了显著简化。本文将详细介绍如何在最新版本中扩展序列化功能，以及新旧实现方式的对比。

旧版本实现方式

在 8.x 之前的版本中，开发者需要通过继承 SystemTextJsonSerializer 类来扩展序列化功能。典型实现如下：

internal class ExtendedSystemTextJsonSerializer : SystemTextJsonSerializer
{
    public ExtendedSystemTextJsonSerializer(IElasticsearchClientSettings elasticsearchClientSettings)
        : base(elasticsearchClientSettings)
    {
        JsonSerializerOptions options = DefaultSourceSerializer.CreateDefaultJsonSerializerOptions(includeDefaultConverters: true);
        options.Converters.Add(new ObjectConverter());
        Options = DefaultSourceSerializer.AddDefaultConverters(options);
    }

    protected JsonSerializerOptions Options { get; set; }

    protected override JsonSerializerOptions CreateJsonSerializerOptions() => Options;
}

使用时需要通过 ElasticsearchClientSettings 的构造函数注入：

ElasticsearchClientSettings elasticsearchClientSettings = new(
    nodePool,
    sourceSerializer: (defaultSerializer, settings) =>
        new ExtendedSystemTextJsonSerializer(settings));

这种方式需要开发者创建一个完整的派生类，并手动管理 JsonSerializerOptions 的配置过程。

新版本简化实现

在 8.x 最新版本中，Elasticsearch-NET 团队简化了这一过程，不再需要创建派生类。新的实现方式更加简洁：

ElasticsearchClientSettings elasticsearchClientSettings = new(
    nodePool,
    sourceSerializer: (defaultSerializer, settings) =>
        new DefaultSourceSerializer(settings, options => options.Converters.Add(/* 自定义转换器 */)));

技术解析

1. DefaultSourceSerializer 构造函数：新版提供了更灵活的构造函数，允许直接传入一个配置委托来修改 JsonSerializerOptions。

2. 配置委托：通过 options => options.Converters.Add() 这样的 lambda 表达式，可以直接添加自定义的 JSON 转换器，无需手动创建默认选项。

3. 简化流程：省去了创建派生类和手动管理选项的步骤，使代码更加简洁明了。

最佳实践

对于大多数自定义序列化需求，推荐使用新版方式。它提供了以下优势：

• 代码量减少，维护成本降低
• 更符合现代 .NET 的配置模式
• 与 Elasticsearch-NET 内部实现更好地集成
• 减少了潜在的错误点

如果需要更复杂的自定义，仍然可以通过实现 ISerializer 接口来完全控制序列化过程，但对于简单的添加转换器需求，新版方式已经足够。

总结

Elasticsearch-NET 8.x 在序列化器扩展方面做了重要改进，使开发者能够以更简洁的方式实现自定义序列化逻辑。这一变化体现了框架向更简单、更现代的 API 设计方向发展的趋势，同时也保持了足够的灵活性以满足各种复杂场景的需求。