Блог

Я пытаюсь создать какой-то атрибут, который я мог бы добавить в класс модели, чтобы во время десериализации json, если ключ имеет определенный формат (в данном случае заканчивается на _special ), он был добавлен в список в модели.

ie: C#

 public class MyModel
{
    public string Name { get; set; }
    public IDictionary<string, string> SpecialFields { get; set; }
}
  

JSON

 {
    "Name": "John",
    "Height_special": "72",
    "Weight_special": "200"
}
  

Таким образом, результатом будет: MyModel.Name == "John" и MyModel.SpecialFields будут пары ключевых значений height и weight.

Возможно ли это?

РЕДАКТИРОВАТЬ: Проект использует .NET Core 3.1 и System.Text.Json

Вы можете сделать это с помощью пользовательского конвертера JSON для System.Text.Json . Вот пример, который является расширяемым и подходит для вашего конкретного MyModel класса:

 public class MyModelJsonConverter : JsonConverter<MyModel>
{
    public override MyModel Read(ref Utf8JsonReader reader,
                                  Type typeToConvert,
                                  JsonSerializerOptions options)
    {
        MyModel model = new MyModel()
        {
            SpecialFields = new Dictionary<string, string>()
        };

        string nextPropertyName = string.Empty;

        while (reader.Read())
        {
            switch (reader.TokenType)
            {
                case JsonTokenType.PropertyName:
                    nextPropertyName = reader.GetString();
                    break;

                case JsonTokenType.String:
                    // Tempting to use reflection or switch here, but the if/else-if performs faster
                    if (nextPropertyName == "Name")
                    {
                        model.Name = reader.GetString();
                        continue;
                    }

                    // Make sure it's a _special field; if not, it's unrecognized!
                    int nameEndsAtIndex = nextPropertyName.IndexOf("_special");
                    if (nameEndsAtIndex == -1) throw new InvalidDataException("Unknown JSON field");

                    string key = nextPropertyName.Substring(0, nameEndsAtIndex);
                    string value = reader.GetString();

                    model.SpecialFields.Add(key, value);
                    break;
            }

        }

        return model;
    }

    public override void Write(Utf8JsonWriter writer,
                               MyModel value,
                               JsonSerializerOptions options)
    {
        writer.WritePropertyName("Name");
        writer.WriteStringValue(value.Name);

        foreach (var specialField in value.SpecialFields)
        {
            writer.WritePropertyName($"{specialField.Key}_special");
            writer.WriteStringValue(specialField.Value);
        }
    }
}
  

Это можно использовать следующим образом:

 var options = new JsonSerializerOptions() 
{ 
   Converters = { new MyModelJsonConverter() } 
};

var model = JsonSerializer.Deserialize<MyModel>(jsonString, options);
  

Обратите внимание, что этот пользовательский конвертер может выполнять обратное преобразование вашего MyModel класса:

 var jsonString = JsonSerializer.Serialize<MyModel>(model, options);
  

Для того, чтобы использовать эту настройку в ASP.NET Базовое приложение или веб-API, вам нужно добавить атрибут к вашему классу модели, чтобы позволить ASP.NET Core Framework знает, что вы собираетесь использовать пользовательский конвертер:

 [JsonConverter(typeof(MyModelJsonConverter))]
public class MyModel
{
    public string Name { get; set; }
    public IDictionary<string, string> SpecialFields { get; set; }
}
  

… и, точно так же, преобразование будет обработано автоматически!

Я настоятельно рекомендую вам пошагово изучить методы Read и Write с точками останова, чтобы действительно понять, что происходит под ними. Эти методы будут вызываться JsonSerializer напрямую; поняв, как они работают, вы сможете увидеть, как расширить этот пользовательский конвертер, если у вас возникнет такая необходимость.

Этого можно достичь с помощью нескольких шагов:

Создайте тип для полей Json:

 public class SpecialClass
{
    public string Name { get; set; }
    public string Height_Special { get; set; }
    public string Weight_Special { get; set; }
}
  

Преобразуйте Json с этим типом:

 var myObject = JsonConvert.DeserializeObject<SpecialClass>(yourJson);
  

Создайте словарь _special полей как [высота как ключ, вес как значение]:

 var dictionary = new Dictionary<string, string>()
{
    { myObject.Height_Special, myObject.Weight_Special }
};
  

Если требуется получить [ключ, значение] как [propertyName, значение]:

 var dictionary = new Dictionary<string, string>()
{
    { nameof(myObject.Height_Special), myObject.Height_Special },
    { nameof(myObject.Weight_Special), myObject.Weight_Special }
};
  

Таким образом, вы можете получить требуемые данные в MyModel виде:

 MyModel myModel = new MyModel()
{
    Name = myObject.Name,
    SpecialFields = dictionary,
};