使用 Json.net 序列化时如何更改属性名称？

Question

我在 C# DataSet 对象中有一些数据。我现在可以使用这样的 Json.net 转换器对其进行序列化

DataSet data = new DataSet();
// do some work here to populate 'data'
string output = JsonConvert.SerializeObject(data);

但是，当打印到 .json 文件时，它使用来自 data 的属性名称。我想将属性名称更改为不同的名称（例如，将 'foo' 更改为 'bar'）。

在Json.net documentation 中，在“序列化和反序列化 JSON”→“序列化属性”下显示“JsonPropertyAttribute... 允许自定义名称”。但是没有例子。 有人知道如何使用 JsonPropertyAttribute 将属性名称更改为其他名称吗？

(Direct link to documentation)

Json.net 的文档似乎很少。如果您有一个很好的示例，我会尝试将其添加到官方文档中。 谢谢！

Answer 1

还有另一种方法可以做到这一点，即使用特定的NamingStrategy，可以通过使用[JSonObject] 或[JsonProperty] 装饰类或属性来将其应用于类或属性。

有预定义的命名策略，例如CamelCaseNamingStrategy，但您可以实现自己的。

不同命名策略的实现可以看这里：https://github.com/JamesNK/Newtonsoft.Json/tree/master/Src/Newtonsoft.Json/Serialization

Answer 2

如果您无权访问类来更改属性，或者不想始终使用相同的重命名属性，也可以通过创建自定义解析器来完成重命名。

例如，如果您有一个名为 MyCustomObject 的类，它有一个名为 LongPropertyName 的属性，您可以使用这样的自定义解析器……

public class CustomDataContractResolver : DefaultContractResolver
{
  public static readonly CustomDataContractResolver Instance = new CustomDataContractResolver ();

  protected override JsonProperty CreateProperty(MemberInfo member, MemberSerialization memberSerialization)
  {
    var property = base.CreateProperty(member, memberSerialization);
    if (property.DeclaringType == typeof(MyCustomObject))
    {
      if (property.PropertyName.Equals("LongPropertyName", StringComparison.OrdinalIgnoreCase))
      {
        property.PropertyName = "Short";
      }
    }
    return property;
  }
}

然后调用序列化并提供解析器：

 var result = JsonConvert.SerializeObject(myCustomObjectInstance,
                new JsonSerializerSettings { ContractResolver = CustomDataContractResolver.Instance });

并且结果将被缩短为 {"Short":"prop value"} 而不是 {"LongPropertyName":"prop value"}

更多关于自定义解析器的信息here

Answer 3

您可以使用[JsonProperty] 属性来装饰您希望控制其名称的属性，该属性允许您指定不同的名称：

using Newtonsoft.Json;
// ...

[JsonProperty(PropertyName = "FooBar")]
public string Foo { get; set; }

文档：Serialization Attributes