it-swarm.com.ru

Имя динамического свойства JSON Newtonsoft

Есть ли способ изменить имя свойства Data во время сериализации, чтобы я мог повторно использовать этот класс в моем WEB-интерфейсе API.

Например, если я возвращаю постраничный список пользователей, свойство Data должно быть сериализовано как «пользователи», если я возвращаю список элементов, оно должно называться «items» и т.д.

Возможно ли что-то подобное:

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...);
17
Robert

Вы можете сделать это с помощью пользовательской 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; }
    ...
}

И украсьте свои классы DTO атрибутом [JsonPluralName]:

[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();

Другой подход

Другой возможный подход использует пользовательский JsonConverter для конкретной обработки сериализации класса PagedData, вместо этого используется более общий подход «resolver + attribute», представленный выше. Подход конвертера требует наличия другого свойства в вашем классе PagedData, которое задает имя JSON, которое будет использоваться для перечисляемого свойства Data. Вы можете либо передать это имя в конструкторе 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

15
Brian Rogers

Другой вариант без необходимости играть с форматерами json или использовать замены строк - только наследование и переопределение (все еще не очень хорошее решение, imo):

public class MyUser { }
public class MyItem { }

// you cannot use it out of the box, because it's abstract,
// i.e. only for what's intended [=implemented].
public abstract class PaginatedData<T>
{
    // abstract, so you don't forget to override it in ancestors
    public abstract IEnumerable<T> Data { get; }
    public int Count { get; }
    public int CurrentPage { get; }
    public int Offset { get; }
    public int RowsPerPage { get; }
    public int? PreviousPage { get; }
    public int? NextPage { get; }
}

// you specify class explicitly
// name is clear,.. still not clearer than PaginatedData<MyUser> though
public sealed class PaginatedUsers : PaginatedData<MyUser>
{
    // explicit mapping - more agile than implicit name convension
    [JsonProperty("Users")]
    public override IEnumerable<MyUser> Data { get; }
}

public sealed class PaginatedItems : PaginatedData<MyItem>
{
    [JsonProperty("Items")]
    public override IEnumerable<MyItem> Data { get; }
}
6
pkuderov

Вот решение, которое не требует каких-либо изменений в том, как вы используете сериализатор Json. На самом деле, он также должен работать с другими сериализаторами. Он использует классный класс DynamicObject .

Использование так же, как вы хотели:

var usersPagedData = new PagedData<User>("Users");
....

public class PagedData<T> : DynamicObject
{
    private string _name;

    public PagedData(string name)
    {
        if (name == null)
            throw new ArgumentNullException(nameof(name));

        _name = name;
    }

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

    public override IEnumerable<string> GetDynamicMemberNames()
    {
        yield return _name;
        foreach (var prop in GetType().GetProperties().Where(p => p.CanRead && p.GetIndexParameters().Length == 0 && p.Name != nameof(Data)))
        {
            yield return prop.Name;
        }
    }

    public override bool TryGetMember(GetMemberBinder binder, out object result)
    {
        if (binder.Name == _name)
        {
            result = Data;
            return true;
        }

        return base.TryGetMember(binder, out result);
    }
}
2
Simon Mourier

Ниже приведено еще одно решение, протестированное в .NET Standard 2.

public class PagedResult<T> where T : class
{

    [JsonPropertyNameBasedOnItemClassAttribute]
    public List<T> Results { get; set; }

    [JsonProperty("count")]
    public long Count { get; set; }

    [JsonProperty("total_count")]
    public long TotalCount { get; set; }

    [JsonProperty("current_page")]
    public long CurrentPage { get; set; }

    [JsonProperty("per_page")]
    public long PerPage { get; set; }

    [JsonProperty("pages")]
    public long Pages { get; set; }
}

Я использую Humanizer для плюрализации.

    protected override JsonProperty CreateProperty(MemberInfo member, MemberSerialization memberSerialization)
    {
        JsonProperty property = base.CreateProperty(member, memberSerialization);
        if (member.GetCustomAttribute<JsonPropertyNameBasedOnItemClassAttribute>() != null)
        {
            Type[] arguments = property.DeclaringType.GenericTypeArguments;
            if(arguments.Length > 0)
            {
                string name = arguments[0].Name.ToString();
                property.PropertyName = name.ToLower().Pluralize();
            }
            return property;
        }
        return base.CreateProperty(member, memberSerialization);
    }
0
gv1507

посмотрите здесь: Как переименовать ключ JSON

Это делается не во время сериализации, а с помощью строковой операции.

Не очень приятно (на мой взгляд), но, по крайней мере, возможность.

Ура Томас

0
Thomas Voß