我可以选择在运行时关闭JsonIgnore属性吗?
我正在从一组类中使用Newtonsoft.Json创建一个JSON文件。 创建的文件非常大,所以我为属性创建了JsonProperty
以减小大小,并为某些数据类型添加了JsonIgnore
和自定义格式。
结果是从24MB减少到1MB,这很好; 但是,我希望选择在运行时生成完整版本或简化属性版本。
无论如何,我可以让序列化程序选择使用属性吗?
是的,这可以使用自定义ContractResolver
。
你没有显示任何代码,所以我只是举个例子。 假设我有一个Foo
类,如下所示。 我想在序列化输出中使用Id
和Name
属性,但我绝对不会对AlternateName
和Color
感兴趣。 我用[JsonIgnore]
标记了那些。 我希望描述出现,但有时这可能会变得很长,所以我使用自定义JsonConverter
来限制它的长度。 我还想使用较短的属性名称来描述,所以我用[JsonProperty("Desc")]
标记了它。
class Foo { public int Id { get; set; } public string Name { get; set; } [JsonIgnore] public string AlternateName { get; set; } [JsonProperty("Desc")] [JsonConverter(typeof(StringTruncatingConverter))] public string Description { get; set; } [JsonIgnore] public string Color { get; set; } }
当我序列化上面的一个实例时……
Foo foo = new Foo { Id = 1, Name = "Thing 1", AlternateName = "The First Thing", Description = "This is some lengthy text describing Thing 1 which you'll no doubt find very interesting and useful.", Color = "Yellow" }; string json = JsonConvert.SerializeObject(foo, Formatting.Indented);
…我得到这个输出:
{ "Id": 1, "Name": "Thing 1", "Desc": "This is some lengthy text describing Thing 1 " }
现在,让我们说我有时想获得完整的JSON输出,忽略我的自定义。 我可以使用自定义ContractResolver
以编程方式“取消应用”类中的属性。 这是解析器的代码:
class IgnoreJsonAttributesResolver : DefaultContractResolver { protected override IList CreateProperties(Type type, MemberSerialization memberSerialization) { IList props = base.CreateProperties(type, memberSerialization); foreach (var prop in props) { prop.Ignored = false; // Ignore [JsonIgnore] prop.Converter = null; // Ignore [JsonConverter] prop.PropertyName = prop.UnderlyingName; // restore original property name } return props; } }
要使用解析器,我将它添加到JsonSerializerSettings
并将设置传递给序列化器,如下所示:
JsonSerializerSettings settings = new JsonSerializerSettings(); settings.ContractResolver = new IgnoreJsonAttributesResolver(); settings.Formatting = Formatting.Indented; string json = JsonConvert.SerializeObject(foo, settings);
输出现在包括被忽略的属性,并且描述不再被截断:
{ "Id": 1, "Name": "Thing 1", "AlternateName": "The First Thing", "Description": "This is some lengthy text describing Thing 1 which you'll no doubt find very interesting and useful.", "Color": "Yellow" }
这里有完整的演示: https : //dotnetfiddle.net/WZpeWt
Json支持我们忽略不希望返回的财产。 例
class Foo { public int Id { get; set; } public string Name { get; set; } [JsonProperty(NullValueHandling = NullValueHandling.Ignore)] public string AlternateName { get; set; } }
如何使用它:
Foo foo = new Foo { Id = 1, Name = "Thing 1", AlternateName = null, }; string json = JsonConvert.SerializeObject(foo);