如何在Newtonsoft.JSON序列化前指定动态字段名？

嘿，这个需求我熟！想要给Newtonsoft.JSON序列化器指定动态字段名，其实有几种挺实用的方法，我给你挨个拆解下👇

如果你的场景不需要实体类，只是想快速生成键名动态的JSON，用JObject是最简单直接的方式。你可以随心所欲地指定字段名，完全动态：

using Newtonsoft.Json;
using Newtonsoft.Json.Linq;

// 假设这是你动态获取的字段名和对应值
string dynamicFieldName = "username";
string passwordValue = "mySuperSecurePassword";

// 创建JObject并添加动态键值对
var authJsonObj = new JObject();
authJsonObj[dynamicFieldName] = passwordValue;

// 序列化为格式化后的JSON字符串
string finalJson = authJsonObj.ToString(Formatting.Indented);
// 输出结果：{"username": "mySuperSecurePassword"}

这种方式的好处是完全没有约束，字段名可以是任何字符串，哪怕是从配置、数据库或者用户输入里拿到的都行。

如果你已经有了实体类，但需要动态修改实体属性对应的JSON字段名，那自定义ContractResolver是最佳选择。比如你有一个AuthInfo实体：

public class AuthInfo
{
    public string LoginName { get; set; }
    public string Password { get; set; }
}

现在你想把LoginName序列化为动态的字段名（比如有时候叫username，有时候叫user_id），可以这么做：

第一步：自定义ContractResolver #

public class DynamicFieldResolver : DefaultContractResolver
{
    private readonly Dictionary<string, string> _propertyNameMappings;

    // 构造函数传入属性名到JSON字段名的映射
    public DynamicFieldResolver(Dictionary<string, string> mappings)
    {
        _propertyNameMappings = mappings;
    }

    protected override string ResolvePropertyName(string propertyName)
    {
        // 如果有映射就用新字段名，否则保留原属性名
        return _propertyNameMappings.TryGetValue(propertyName, out var newName) 
            ? newName 
            : base.ResolvePropertyName(propertyName);
    }
}

第二步：使用自定义Resolver序列化 #

// 动态定义属性到JSON字段名的映射
var fieldMappings = new Dictionary<string, string>
{
    { "LoginName", "username" }, // 这里可以换成任何你需要的动态字段名
    { "Password", "password" }
};

var auth = new AuthInfo 
{ 
    LoginName = "chris.thorpe", 
    Password = "yourSecurePass" 
};

// 配置序列化设置
var serializerSettings = new JsonSerializerSettings
{
    ContractResolver = new DynamicFieldResolver(fieldMappings),
    Formatting = Formatting.Indented
};

// 序列化
string finalJson = JsonConvert.SerializeObject(auth, serializerSettings);
// 输出结果：{"username": "chris.thorpe", "password": "yourSecurePass"}

这种方式适合你有固定实体类，但需要根据不同场景动态调整JSON字段名的情况，扩展性很强。

如果只是偶尔需要替换单个字段名，也可以直接用匿名类型配合序列化——不过匿名类型的字段名是编译时确定的，所以如果字段名完全动态的话，还是JObject更靠谱。比如：

string dynamicKey = "username";
var authData = new { [dynamicKey] = "myPassword" };
string json = JsonConvert.SerializeObject(authData, Formatting.Indented);

这个在C# 6及以上版本可用，利用了索引器初始化器的特性，也能快速生成动态键名的JSON。

内容的提问来源于stack exchange，提问作者chris.thorpe