我如何改变属性名时序列化与Json.net?

我有一些数据在c#数据集对象。我现在就可以使用类似这样的Json.net转换器来序列化它

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

然而，这将在打印到.json文件时使用data中的属性名。我想改变属性名称是不同的(比如，改变'foo'到'bar')。

在Json.net文档中，在“Serializing and Deserializing JSON”→“Serialization Attributes”下面，它说“JsonPropertyAttribute…”允许自定义名称”。但是没有例子。有人知道如何使用JsonPropertyAttribute将属性名更改为其他名称吗?

(直接链接到文档)

Json.net的文档似乎很稀疏。如果你有一个很好的例子，我会把它添加到官方文档中。 谢谢!< / p >
389861 次浏览
小开
最佳答案

你可以用[JsonProperty]属性来修饰你想要控制它的名字，这个属性允许你指定一个不同的名字:

using Newtonsoft.Json;
// ...


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

文档:Serialization Attributes .

小开

如果您不能访问类来更改属性，或者不希望总是使用相同的重命名属性，也可以通过创建自定义解析器来重命名。

例如，如果你有一个名为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 });

结果将被缩短为{“短”:“道具价值”}而不是{“LongPropertyName”:“道具价值”}

关于自定义解析器在这里的更多信息

小开

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

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

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


提交答案