c# - Newtonsoft JSON 动态属性名称

Question

有没有办法在序列化期间更改数据属性的名称，以便我可以在我的 WEB Api 中重用此类。

例如，如果我要返回用户的分页列表，则数据属性应序列化为“用户”，如果我要返回项目列表，则应称为“项目”等。

这样的事情是否可能:

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; }
}

编辑:

我想控制此功能，例如尽可能传递要使用的名称。如果我的class叫做UserDTO , 我仍然希望序列化属性被称为 Users , 不是 UserDTOs .

例子

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

Answer 1

您可以使用自定义 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);

fiddle :https://dotnetfiddle.net/GqKBnx

如果您使用的是 Web API(看起来像)，那么您可以通过 Register 将自定义解析器安装到管道中WebApiConfig 的方法类(在 App_Start 文件夹中)。

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

---

另一种方法

另一种可能的方法是使用自定义 JsonConverter处理 PagedData 的序列化具体类而不是使用上面介绍的更通用的“解析器+属性”方法。转换器方法要求您的 PagedData 上有另一个属性指定用于可枚举 Data 的 JSON 名称的类属性(property)。您可以在 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类(如果你愿意，它可以是私有(private)的)，然后添加一个 [JsonConverter]类的属性以将其绑定(bind)到转换器:

[JsonConverter(typeof(PagedDataConverter))]
public class PagedData<T>
{
    private string DataPropertyName { get; set; }
    public IEnumerable<T> Data { get; private set; }
    ...
}

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

fiddle :https://dotnetfiddle.net/8E8fEE