Зберігайте регістр при серіалізації словників

Question 1

У мене проект Web Api налаштований так:

config.Formatters.JsonFormatter.SerializerSettings.ContractResolver = new CamelCasePropertyNamesContractResolver();

Однак я хочу, щоб корпус ключів словника залишався незмінним. чи є якийсь атрибут, який Newtonsoft.Jsonя можу використовувати для класу для позначення того, що я хочу, щоб кожух залишався незмінним під час серіалізації?

public class SomeViewModel
{
    public Dictionary<string, string> Data { get; set; }    
}

Question 2

Для цього немає атрибута, але ви можете зробити це, налаштувавши вирішувач.

Я бачу, що ви вже використовуєте CamelCasePropertyNamesContractResolver. Якщо ви отримаєте новий клас резольвера з цього і перевизначите CreateDictionaryContract()метод, ви можете надати функцію-заміну DictionaryKeyResolver, яка не змінює імена ключів.

Ось код, який вам знадобиться:

class CamelCaseExceptDictionaryKeysResolver : CamelCasePropertyNamesContractResolver
{
    protected override JsonDictionaryContract CreateDictionaryContract(Type objectType)
    {
        JsonDictionaryContract contract = base.CreateDictionaryContract(objectType);

        contract.DictionaryKeyResolver = propertyName => propertyName;

        return contract;
    }
}

Демо:

class Program
{
    static void Main(string[] args)
    {
        Foo foo = new Foo
        {
            AnIntegerProperty = 42,
            HTMLString = "<html></html>",
            Dictionary = new Dictionary<string, string>
            {
                { "WHIZbang", "1" },
                { "FOO", "2" },
                { "Bar", "3" },
            }
        };

        JsonSerializerSettings settings = new JsonSerializerSettings
        {
            ContractResolver = new CamelCaseExceptDictionaryKeysResolver(),
            Formatting = Formatting.Indented
        };

        string json = JsonConvert.SerializeObject(foo, settings);
        Console.WriteLine(json);
    }
}

class Foo
{
    public int AnIntegerProperty { get; set; }
    public string HTMLString { get; set; }
    public Dictionary<string, string> Dictionary { get; set; }
}

Ось вихідні дані з вищезазначеного. Зверніть увагу, що всі назви властивостей класу мають верблюд, але ключі словника зберегли оригінальну оболонку.

{
  "anIntegerProperty": 42,
  "htmlString": "<html></html>",
  "dictionary": {
    "WHIZbang": "1",
    "FOO": "2",
    "Bar": "3"
  }
}

Question 3

Json.NET 9.0.1 представив NamingStrategyієрархію класів для вирішення такого роду проблем. Він витягує логіку алгоритмічного перепризначення імен властивостей із засобу вирішення контрактів до окремого, полегшеного класу, що дозволяє контролювати, чи переназначаються ключі словника , явно вказані імена властивостей та імена даних розширень (у 10.0.1 ).

Використовуючи DefaultContractResolverта встановлюючи NamingStrategyекземпляр, CamelCaseNamingStrategyви можете генерувати JSON з назвою властивостей верблюдів та незміненими ключами словника, встановивши його в JsonSerializerSettings.ContractResolver:

var resolver = new DefaultContractResolver
{
    NamingStrategy = new CamelCaseNamingStrategy
    {
        ProcessDictionaryKeys = false,
        OverrideSpecifiedNames = true
    }
};
config.Formatters.JsonFormatter.SerializerSettings.ContractResolver = resolver;

Примітки:

Поточна реалізація CamelCasePropertyNamesContractResolverтакож визначає, що члени .Net з явно вказаними іменами властивостей (наприклад, ті, де JsonPropertyAttribute.PropertyNameбуло встановлено) повинні мати свої імена перепризначеними:
```
public CamelCasePropertyNamesContractResolver()
{
    NamingStrategy = new CamelCaseNamingStrategy
    {
        ProcessDictionaryKeys = true,
        OverrideSpecifiedNames = true
    };
}
```
Вищевказане resolverзберігає таку поведінку. Якщо ви цього не хочете, встановіть OverrideSpecifiedNames = false.
Json.NET має кілька вбудованих стратегій іменування, включаючи:
1. CamelCaseNamingStrategy. Стратегія іменування випадків верблюда, що містить логіку перепризначення імен, раніше вбудовану в CamelCasePropertyNamesContractResolver.
2. SnakeCaseNamingStrategy. Змія випадку стратегія іменування.
3. DefaultNamingStrategy. Стратегія імен за замовчуванням. Назви властивостей та ключі словника не змінюються.
Або ви можете створити свій власний, успадкувавши його від абстрактного базового класу NamingStrategy.
Хоча також можливо змінити NamingStrategyекземпляр CamelCasePropertyNamesContractResolver, оскільки останній обмінюється інформацією про договори глобально у всіх екземплярах кожного типу , це може призвести до несподіваних побічних ефектів, якщо ваша програма намагається використовувати кілька екземплярів CamelCasePropertyNamesContractResolver. З такою проблемою не існує DefaultContractResolver, тому безпечніше використовувати, коли потрібна будь-яка настройка логіки кожуха.

Question 4

Це дуже приємна відповідь. Але чому б просто не відмінити ResolveDictionaryKey?

class CamelCaseExceptDictionaryResolver : CamelCasePropertyNamesContractResolver
    {
        #region Overrides of DefaultContractResolver

        protected override string ResolveDictionaryKey(string dictionaryKey)
        {
            return dictionaryKey;
        }

        #endregion
    }

Question 5

Вибрана відповідь ідеальна, але я думаю, що до того часу, як я це наберу, вирішувач контракту повинен змінитись на щось подібне, оскільки DictionaryKeyResolver вже не існує :)

public class CamelCaseExceptDictionaryKeysResolver : CamelCasePropertyNamesContractResolver
    {
        protected override JsonDictionaryContract CreateDictionaryContract(Type objectType)
        {
            JsonDictionaryContract contract = base.CreateDictionaryContract(objectType);
            contract.PropertyNameResolver = propertyName => propertyName;
            return contract;
        }
    }