C# Newtonsoft自定义序列化器与ContractResolver在ElasticSearch中未触发

核心问题 #

你用ConnectionSettingsAwareSerializerBase实现的自定义序列化器，根本没被用来处理你要索引的EF实体对象。这个基类是NEST框架用来序列化内部请求/响应元数据（比如查询语句、响应结构）的，不是给业务实体序列化用的，所以你的ExcludeVirtualPropertiesResolver完全没生效，CreateProperty断点自然不会触发。

正确解决方案 #

NEST提供了专门处理实体序列化的JsonNetSerializer（基于Json.NET，需要安装NEST.JsonNetSerializer NuGet包），用它来替换默认的实体序列化逻辑，才能让你的契约解析器生效。

步骤1：安装依赖包 #

如果还没安装，先添加NuGet包：

Install-Package NEST.JsonNetSerializer

步骤2：实现自定义JsonNet序列化器 #

替换原来的CustomSerializer，改用JsonNetSerializer作为基类：

internal class CustomJsonNetSerializer : JsonNetSerializer
{
    public CustomJsonNetSerializer(IConnectionSettingsValues settings) 
        : base(settings, () => new JsonSerializerSettings
        {
            ContractResolver = new ExcludeVirtualPropertiesResolver(),
            // 可选：如果还有自引用问题，可开启这个配置
            // ReferenceLoopHandling = ReferenceLoopHandling.Ignore
        })
    {
    }
}

步骤3：保留契约解析器逻辑 #

你的ExcludeVirtualPropertiesResolver逻辑没问题，继续使用：

internal class ExcludeVirtualPropertiesResolver : DefaultContractResolver
{
    protected override JsonProperty CreateProperty(MemberInfo member, MemberSerialization memberSerialization)
    {
        var prop = base.CreateProperty(member, memberSerialization);
        
        if (member is PropertyInfo propertyInfo)
        {
            // 排除所有EF导航属性（通常是虚拟属性）
            if (propertyInfo.GetGetMethod()?.IsVirtual ?? false)
            {
                prop.ShouldSerialize = _ => false;
            }
        }
        
        return prop;
    }
}

步骤4：初始化ElasticClient时注册序列化器 #

修改客户端创建代码，正确注册自定义序列化器：

private static ElasticClient CreateESClient()
{
    var elasticSearchUri = new Uri(ElasticSearchConnectionString);
    var pool = new SingleNodeConnectionPool(elasticSearchUri);
    
    // 方式1：通过类型注册
    var settings = new ConnectionSettings(pool, typeof(CustomJsonNetSerializer))
        .DefaultIndex("my_index");
    
    // 方式2：通过委托直接配置（更简洁）
    // var settings = new ConnectionSettings(pool)
    //     .JsonNetSerializer(options => options
    //         .ContractResolver(new ExcludeVirtualPropertiesResolver()))
    //     .DefaultIndex("my_index");
    
    var client = new ElasticClient(settings);
    return client;
}

额外说明 #

• 排除虚拟属性是解决EF实体自引用的直接方案，因为EF的导航属性几乎都是虚拟的；
• 如果还有其他自引用场景，可以在JsonSerializerSettings中设置ReferenceLoopHandling = ReferenceLoopHandling.Ignore作为补充；
• 确保NEST版本和NEST.JsonNetSerializer版本一致，避免兼容性问题。

内容的提问来源于stack exchange，提问作者Cata