1. ホーム
  2. c#

[解決済み] 辞書のシリアライズ時にケーシングを保持する

2023-01-17 11:54:55

質問

WebApiのプロジェクトはこのように構成されています。

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

しかし、辞書のキーのケーシングは変更しないようにしたい。 Newtonsoft.Json に何か属性があるのでしょうか?

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

どのように解決するのですか?

属性はありませんが、リゾルバをカスタマイズすることで可能です。

をすでに使っているようですが 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"
  }
}