NewtonSoft.Json序列化异常：Settings字典键大小写随环境变化

问题描述 #

在.NET7环境中使用Newtonsoft.Json序列化VersionData类时出现环境依赖异常：

• 本地及部分部署环境中，Settings字典的键可保留原大小写
• K8s Pod环境中，Settings字典的键会被转为驼峰格式
• 标记了[JsonExtensionData]的ExtraFields字典键在所有环境下均能保留原大小写

已确认代码完全一致，数据库模型构建器及API初始化配置均显式设置不处理字典键命名，但K8s环境仍异常。相关代码如下：

模型类 #

public class VersionData
{
    [JsonProperty("settings")]
    public IDictionary<string, JToken>? Settings { get; set; }

    [JsonExtensionData]
    public IDictionary<string, JToken> ExtraFields = new Dictionary<string, JToken>();
}

数据库转换配置 #

modelBuilder.Entity<MyModel>(x =>
  x.Property(p => p.VersionData).IsRequired().HasColumnType("jsonb")
      .HasConversion(v => JsonConvert.SerializeObject(v), v => JsonConvert.DeserializeObject<VersionData>(v));

API配置 #

services.AddControllers()
    .AddNewtonsoftJson(opt =>
    {
        opt.SerializerSettings.ContractResolver = new CamelCasePropertyNamesContractResolver()
        {
            NamingStrategy = new CamelCaseNamingStrategy()
            {
                ProcessDictionaryKeys = false//默认值，已显式设置
            }
        };
        opt.SerializerSettings.Converters.Add(new StringEnumConverter());
    });

期望所有环境下字典键大小写均被保留，目前K8s环境异常原因不明。

排查方向 #

• 检查Newtonsoft.Json版本一致性：本地和K8s环境的NuGet包版本可能存在差异，部分旧版本存在ProcessDictionaryKeys设置不生效的bug，需确认K8s部署的程序包版本与本地完全一致。
• 排查序列化触发路径：K8s环境中可能存在额外的序列化路径未使用API配置的规则，比如数据库转换中JsonConvert.SerializeObject(v)未传入指定配置，会使用全局默认设置而非自定义的ContractResolver；同时检查是否有中间件/过滤器修改了序列化配置。
• 检查全局序列化配置：确认是否存在JsonConvert.DefaultSettings全局配置，该设置会覆盖局部配置，若K8s环境中全局配置修改了NamingStrategy，会导致字典键被转换。
• 排查K8s环境配置差异：检查K8s的ConfigMap、Secret或环境变量中是否注入了影响.NET序列化行为的配置项。

解决方案 #

• 统一NuGet包版本：确保所有环境使用相同版本的Newtonsoft.Json，建议升级至最新稳定版。
• 显式传递序列化配置：在所有手动调用JsonConvert.SerializeObject的地方传入统一配置，比如修改数据库转换代码：

  var serializerSettings = new JsonSerializerSettings
  {
      ContractResolver = new CamelCasePropertyNamesContractResolver()
      {
          NamingStrategy = new CamelCaseNamingStrategy()
          {
              ProcessDictionaryKeys = false
          }
      },
      Converters = { new StringEnumConverter() }
  };
  
  modelBuilder.Entity<MyModel>(x =>
    x.Property(p => p.VersionData).IsRequired().HasColumnType("jsonb")
        .HasConversion(v => JsonConvert.SerializeObject(v, serializerSettings), v => JsonConvert.DeserializeObject<VersionData>(v, serializerSettings));
  

• 对齐全局与局部配置：若存在JsonConvert.DefaultSettings，确保其配置与API设置一致；或移除全局设置，改用局部显式配置。
• 清理K8s环境异常配置：删除K8s环境中影响序列化行为的ConfigMap、Secret或环境变量配置项。

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