c# - 在 C# 中覆盖 Json 属性名称

Question

我有一个包含以下字段的类。这些属性用于在需要调用外部 rest API 方法时序列化为 json 对象。

public class Customer
    {
        [JsonProperty(PropertyName = "email")]
        public string Email { get; set; }

        [JsonProperty(PropertyName = "prop[listId]")]
        public string Test{ get; set; }

        // there are lot of properties 
    }

在属性名称 Test 中，外部 API 服务调用需要遵循 json 文件名格式。

prop[7]

在我的例子中，这个 7 可以根据测试、开发和生产等环境进行更改。所以我正在寻找一种方法将该 listId 值移动到 app.config 中。

我已尝试按以下方式进行操作，但不允许这样做。对于 listIdValue，如果分配常量值，它将起作用。

     private string listIdValue = ConfigurationManager.AppSettings["ListIdValue"];

     [JsonProperty(PropertyName = "prop["+listIdValue +"]")]
     public string Test{ get; set; }

Answer 1

您必须覆盖 DefaultContractResolver 并实现您自己的机制来提供 PropertyName(JSON 格式)。我将提供一个完整的示例代码来展示使用运行时生成的 PropertyName 进行的反序列化和序列化。目前，它将 Test 字段修改为 Test5(在所有模型中)。您应该实现自己的机制(使用属性、保留名称、表格或其他任何内容。

class Program
{
    static void Main(string[] args)
    {
        var customer = new Customer() {Email = "asd@asd.com", Test = "asdasd"};
        var a = Serialize(customer, false);
        var b = Serialize(customer, true);
        Console.WriteLine(a);
        Console.WriteLine(b);

        var desA = Deserialize<Customer>(a, false);
        var desB = Deserialize<Customer>(b, true);

        Console.WriteLine("TestA: {0}", desA.Test);
        Console.WriteLine("TestB: {0}", desB.Test);

    }

    static string Serialize(object obj, bool newNames)
    {
        JsonSerializerSettings settings = new JsonSerializerSettings();
        settings.Formatting = Formatting.Indented;
        if (newNames)
        {
            settings.ContractResolver = new CustomNamesContractResolver();
        }

        return JsonConvert.SerializeObject(obj, settings);
    }
    static T Deserialize<T>(string text, bool newNames)
    {
        JsonSerializerSettings settings = new JsonSerializerSettings();
        settings.Formatting = Formatting.Indented;
        if (newNames)
        {
            settings.ContractResolver = new CustomNamesContractResolver();
        }

        return JsonConvert.DeserializeObject<T>(text, settings);
    }
}
class CustomNamesContractResolver : DefaultContractResolver
{
    protected override IList<JsonProperty> CreateProperties(System.Type type, MemberSerialization memberSerialization)
    {
        // Let the base class create all the JsonProperties 
        // using the short names
        IList<JsonProperty> list = base.CreateProperties(type, memberSerialization);

        // Now inspect each property and replace the 
        // short name with the real property name
        foreach (JsonProperty prop in list)
        {
            if (prop.UnderlyingName == "Test") //change this to your implementation!
                prop.PropertyName = "Test" + 5;

        }

        return list;
    }
}

public class Customer
{
    [JsonProperty(PropertyName = "email")]
    public string Email { get; set; }

    public string Test { get; set; }

}

输出:

{
  "email": "asd@asd.com",
  "Test": "asdasd"
}
{
  "email": "asd@asd.com",
  "Test5": "asdasd"
}
TestA: asdasd
TestB: asdasd

如您所见，当我们使用 Serialize(..., false) - 字段的名称是 Test 并且当我们使用 Serialize(... , true) - 字段名称如预期的那样是 Test5。这也适用于反序列化。

我用这个答案作为我的答案的灵感:https://stackoverflow.com/a/20639697/773879