C# · 12月 29, 2021

c# – 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; }}

编辑:

我想要控制这个功能,例如传递名字,以便尽可能使用.如果我的类被称为UserDTO,我仍然希望序列化属性被称为用户,而不是UserDTO.

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(如您所愿),则可以通过WebApiConfig类的注册方法(在App_Start文件夹中)将自定义解析器安装到管道中.

JsonSerializerSettings settings = config.Formatters.JsonFormatter.SerializerSettings;settings.ContractResolver = new CustomResolver();

另一种方法

另一种可能的方法使用自定义JsonConverter来处理PagedData类的序列化,而不是使用上面提出的更一般的“解析器属性”方法.转换器方法要求您的PagedData类上有另一个属性,它指定要用于枚举数据属性的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(); }}

要使用此转换器,首先添加一个名为DataPropertyName的字符串属性到您的PagedData类(如果您愿意,它可以是私有的),然后添加一个[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