Newtonsoft JSON动态属性名称

有没有一种方法可以在序列化期间更改Data属性的名称,因此我可以在WEB Api中重用该类。

例如,如果我要返回用户的分页列表,则应将Data属性序列化为“用户”,如果要返回项目列表,则应将其称为“项目”,依此类推。

可能是这样的:

public class PagedData

{

[JsonProperty(PropertyName = "Set from constructor")]??

public IEnumerable<T> Data { get; private set; }

public int Count { get; private set; }

public int CurrentPage { get; private set; }

public int Offset { get; private set; }

public int RowsPerPage { get; private set; }

public int? PreviousPage { get; private set; }

public int? NextPage { get; private set; }

}

我希望对此功能进行控制,例如,尽可能传递名称。如果我classUserDTO,我还是想序列化的属性被称为Users,没有UserDTOs

var usersPagedData = new PagedData("Users", params...);

回答:

您可以通过自定义进行操作ContractResolver。解析器可以寻找一个自定义属性,该属性将表明您希望JSON属性的名称基于可枚举项目的类。如果项目类具有指定其复数名称的另一个属性,则该名称将用作可枚举属性,否则,项目类名称本身将被复数并用作可枚举属性名称。以下是您需要的代码。

首先让我们定义一些自定义属性:

public class JsonPropertyNameBasedOnItemClassAttribute : Attribute

{

}

public class JsonPluralNameAttribute : Attribute

{

public string PluralName { get; set; }

public JsonPluralNameAttribute(string pluralName)

{

PluralName = pluralName;

}

}

然后是解析器:

public class CustomResolver : DefaultContractResolver

{

protected override JsonProperty CreateProperty(MemberInfo member, MemberSerialization memberSerialization)

{

JsonProperty prop = base.CreateProperty(member, memberSerialization);

if (prop.PropertyType.IsGenericType && member.GetCustomAttribute<JsonPropertyNameBasedOnItemClassAttribute>() != null)

{

Type itemType = prop.PropertyType.GetGenericArguments().First();

JsonPluralNameAttribute att = itemType.GetCustomAttribute<JsonPluralNameAttribute>();

prop.PropertyName = att != null ? att.PluralName : Pluralize(itemType.Name);

}

return prop;

}

protected string Pluralize(string name)

{

if (name.EndsWith("y") && !name.EndsWith("ay") && !name.EndsWith("ey") && !name.EndsWith("oy") && !name.EndsWith("uy"))

return name.Substring(0, name.Length - 1) + "ies";

if (name.EndsWith("s"))

return name + "es";

return name + "s";

}

}

现在你可以在你的装饰可变命名的属性PagedData<T>与类[JsonPropertyNameBasedOnItemClass]属性:

public class PagedData<T>

{

[JsonPropertyNameBasedOnItemClass]

public IEnumerable<T> Data { get; private set; }

...

}

并使用[JsonPluralName]属性装饰DTO类:

[JsonPluralName("Users")]

public class UserDTO

{

...

}

[JsonPluralName("Items")]

public class ItemDTO

{

...

}

最后,要进行序列化,请创建的实​​例JsonSerializerSettings,设置ContractResolver属性,然后将设置传递为JsonConvert.SerializeObject

JsonSerializerSettings settings = new JsonSerializerSettings

{

ContractResolver = new CustomResolver()

};

string json = JsonConvert.SerializeObject(pagedData, settings);

小提琴:https :

//dotnetfiddle.net/GqKBnx

如果您正在使用Web

API(看起来像您一样),则可以通过类的Register方法WebApiConfig(在App_Start文件夹中)将自定义解析器安装到管道中。

JsonSerializerSettings settings = config.Formatters.JsonFormatter.SerializerSettings;

settings.ContractResolver = new CustomResolver();


回答:

另一种可能的方法是使用自定义JsonConverterPagedData专门处理类的序列化,而不是使用上面介绍的更通用的“解析器+属性”方法。转换器方法要求您的PagedData类上还有另一个属性,该属性指定要用于可枚举Data属性的JSON名称。您可以在PagedData构造函数中传递此名称,也可以单独设置它,只要您在序列化时间之前执行即可。当为可枚举属性写出JSON时,转换器将查找该名称并使用它。

这是转换器的代码:

public class PagedDataConverter : JsonConverter

{

public override bool CanConvert(Type objectType)

{

return objectType.IsGenericType && objectType.GetGenericTypeDefinition() == typeof(PagedData<>);

}

public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer)

{

Type type = value.GetType();

var bindingFlags = BindingFlags.Instance | BindingFlags.NonPublic | BindingFlags.Public;

string dataPropertyName = (string)type.GetProperty("DataPropertyName", bindingFlags).GetValue(value);

if (string.IsNullOrEmpty(dataPropertyName))

{

dataPropertyName = "Data";

}

JObject jo = new JObject();

jo.Add(dataPropertyName, JArray.FromObject(type.GetProperty("Data").GetValue(value)));

foreach (PropertyInfo prop in type.GetProperties().Where(p => !p.Name.StartsWith("Data")))

{

jo.Add(prop.Name, new JValue(prop.GetValue(value)));

}

jo.WriteTo(writer);

}

public override bool CanRead

{

get { return false; }

}

public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)

{

throw new NotImplementedException();

}

}

要使用此转换器,请首先DataPropertyNamePagedData类中添加一个名为string的字符串属性(如果愿意,可以是私有的),然后[JsonConverter]在该类中添加一个属性以将其绑定到转换器:

[JsonConverter(typeof(PagedDataConverter))]

public class PagedData<T>

{

private string DataPropertyName { get; set; }

public IEnumerable<T> Data { get; private set; }

...

}

就是这样。只要设置了DataPropertyName属性,转换器将在序列化时将其拾取。

小提琴:https :

//dotnetfiddle.net/8E8fEE

以上是 Newtonsoft JSON动态属性名称 的全部内容, 来源链接: utcz.com/qa/406422.html

回到顶部