Хранить корпус при сериализации словарей

У меня есть проект Web Api, который настраивается следующим образом:

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

Тем не менее, я хочу, чтобы оболочка словарных ключей оставалась неизменной. есть ли какой-либо атрибут в Newtonsoft.Json, который я могу использовать для класса, чтобы обозначить, что я хочу, чтобы оболочка оставалась неизменной во время сериализации?

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

Ответы

Ответ 1

Для этого нет атрибута, но вы можете сделать это, настроив resolver.

Я вижу, что вы уже используете 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"
  }
}

Ответ 2

Json.NET 9.0.1 представил NamingStrategy классов 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), должны иметь 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, поэтому ее безопаснее использовать, когда требуется любая настройка логики корпуса.

Ответ 3

Это очень хороший ответ. Но почему бы не просто переопределить ResolveDictionaryKey?

class CamelCaseExceptDictionaryResolver : CamelCasePropertyNamesContractResolver
    {
        #region Overrides of DefaultContractResolver

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

        #endregion
    }

Ответ 4

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

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