Garder le boîtier lors de la sérialisation des dictionnaires

J'ai un projet d'Api Web configuré comme ceci:

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

Cependant, je tiens les clés de dictionnaire boîtier reste inchangé. est-il un attribut dans Newtonsoft.Json je peux utiliser pour une classe pour montrer que je veux boîtier à rester inchangée lors de la sérialisation?

public class SomeViewModel
{
    public Dictionary<string, string> Data { get; set; }    
}
  • Avez-vous essayé la résolution par défaut?
  • Non, je n'ai pas; pouvez-vous expliquer avec un exemple de la façon dont le code pourrait ressembler? Remarque, j'ai encore envie de Chameau cas de la sérialisation pour tous mes api web demandes, je veux juste de la sérialisation personnalisée pour une classe (ou peut-être pour toutes les clés de dictionnaire).
InformationsquelleAutor zafeiris.m | 2014-06-10
  1. 116

    Il n'est pas un attribut pour ce faire, mais vous pouvez le faire par la personnalisation de l'outil de résolution.

    Je vois que vous êtes déjà à l'aide d'un CamelCasePropertyNamesContractResolver. Si vous dérivez un nouveau solveur de classe à partir de cela et remplacer le CreateDictionaryContract() méthode, vous pouvez fournir un substitut DictionaryKeyResolver fonction qui ne change pas les noms de clé.

    Voici le code que vous auriez besoin:

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

        contract.DictionaryKeyResolver = propertyName => propertyName;

        return contract;
    }
}

    Démo:

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

    Voici le résultat de la ci-dessus. Notez que tous les noms de propriété de classe sont en camelcase, mais les clés de dictionnaire ont conservé leur boîte d'origine.

    {
  "anIntegerProperty": 42,
  "htmlString": "<html></html>",
  "dictionary": {
    "WHIZbang": "1",
    "FOO": "2",
    "Bar": "3"
  }
}
    • Pour info, PropertyNameResolver est maintenant obsolète. Il semble que contract.DictionaryKeyResolver = key => key; fonctionne très bien.
    • C'est toujours TRÈS pertinentes avec les types anonymes, surtout lorsque nous voulons chameau boîtier pour la plupart de la structure, mais ne veulent pas les clés à l'intérieur de dictionnaires pour être camelised.
    • Absolument d'accord avec Chris. J'ai été forcé d'aller à travers des cerceaux dans mon JavaScript juste parce que je ne peux pas garder les dictionnaires d'être en camelcase. Il s'avère qu'une ligne de code permettra de résoudre ce problème (et de faire de mon JavaScript beaucoup plus simple)!
    • Fonctionne très bien! Cependant, savez-vous si je peux condition à l'aide de mon DictionaryKeyResolver que si mon Dictionnaire de la propriété a quelques Attribut personnalisé?
    • Pas sur le haut de ma tête. Je recommande de demander que comme une nouvelle Question. Vous pouvez lier de nouveau à cette question si vous avez besoin de fournir un contexte.
    • Super réponse, merci!

    InformationsquelleAutor Brian Rogers
  2. 57

    Json.NET 9.0.1 introduit la NamingStrategy hiérarchie de classes pour gérer ce genre de problème. Il extrait la logique algorithmique de reconfiguration des noms de propriété du contrat de résolution de se séparer, de classe légère qui permet le contrôle de savoir si les clés de dictionnaire, spécifié explicitement les noms de propriété, et les données d'extension de noms de (en 10.0.1) sont reconfigurées.

    En utilisant DefaultContractResolver et réglage NamingStrategy à une instance de CamelCaseNamingStrategy vous pouvez générer du JSON avec camelcase les noms de propriété et de non modifiée clés de dictionnaire par la mise en JsonSerializerSettings.ContractResolver:

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

    Notes:

    • La mise en œuvre actuelle de CamelCasePropertyNamesContractResolver précise aussi que .Les membres Net avec spécifiée explicitement les noms de propriété (par exemple celles où JsonPropertyAttribute.PropertyName a été définie) doivent avoir leurs noms reconfiguré:

      public CamelCasePropertyNamesContractResolver()
{
    NamingStrategy = new CamelCaseNamingStrategy
    {
        ProcessDictionaryKeys = true,
        OverrideSpecifiedNames = true
    };
}

      Ci-dessus resolver conserve ce comportement. Si vous ne voulez pas cela,OverrideSpecifiedNames = false.

    • Json.NET a intégré plusieurs stratégies de noms, y compris:

      1. CamelCaseNamingStrategy. Un chameau de cas stratégie de nommage qui contient le nom de reconfiguration de la logique anciennement intégré dans CamelCasePropertyNamesContractResolver.
      2. SnakeCaseNamingStrategy. Un serpent de cas stratégie de nommage.
      3. DefaultNamingStrategy. Le nom par défaut de la stratégie. Les noms de propriété et les clés de dictionnaire sont inchangés.

      Ou, vous pouvez créer votre propre en héritant de la classe de base abstraite NamingStrategy.

    • Alors qu'il est également possible de modifier le NamingStrategy d'une instance de CamelCasePropertyNamesContractResolver, depuis le dernier actions d'information sur le contrat à l'échelle mondiale à travers toutes les instances de chaque type, cela peut conduire à des effets secondaires inattendus si votre application tente d'utiliser plusieurs instances de CamelCasePropertyNamesContractResolver. Pas ce problème existe avec DefaultContractResolver, de sorte qu'il est plus sûr à utiliser lors de la personnalisation du boîtier logique est nécessaire.

    • Cette solution n'est pas de travail pour un bien comme public Dictionary<string, Dictionary<string, string>> Values { get; set; }. Il ne fait toujours camelCase pour l'intérieure clés de dictionnaire.
    • alors que je ne pouvais pas reproduire votre problème exact, j'ai été en mesure de trouver un problème lors de l'utilisation de plusieurs instances de CamelCasePropertyNamesContractResolver. Fondamentalement NamingStrategy pour la première aurait une influence sur les contrats généré par le second. Que à être ce que vous voyez. Essayez la nouvelle recommandation de la place et laissez-moi savoir si résout votre problème.
    • Est-il flexible NamingStrategy, de sorte qu'il est capable d'analyser à la fois camel cas et pascal cas?
    • href="https://dotnetfiddle.net/O6HPlL" >Vous avez tort.
    • Dans le premier exemple de code, ce qui est config censé être?
    • J'ai copié à partir de la question initiale, qui a montré la ligne de code suivante: config.Formatters.JsonFormatter.SerializerSettings.ContractResolver = new CamelCasePropertyNamesContractResolver();. Il semble être le MVC 4 Web API HttpConfiguration, voir Comment personnaliser JsonSerializerSettings pour Json.NET dans MVC 4 Web API?.

    InformationsquelleAutor dbc
  3. 11

    C'est une très belle réponse. Mais pourquoi ne pas simplement remplacer le ResolveDictionaryKey?

    class CamelCaseExceptDictionaryResolver : CamelCasePropertyNamesContractResolver
    {
        #region Overrides of DefaultContractResolver

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

        #endregion
    }
    • Bien laconique. Thx pour le partage.
    InformationsquelleAutor Dmitriy
  4. 1

    La réponse sélectionnée est parfait, mais je suppose que par le temps, je suis en train de taper ceci, le contrat de résolution doit changer pour quelque chose comme cela parce que DictionaryKeyResolver n'existe pas plus 🙂

    public class CamelCaseExceptDictionaryKeysResolver : CamelCasePropertyNamesContractResolver
    {
        protected override JsonDictionaryContract CreateDictionaryContract(Type objectType)
        {
            JsonDictionaryContract contract = base.CreateDictionaryContract(objectType);
            contract.PropertyNameResolver = propertyName => propertyName;
            return contract;
        }
    }
    • En fait, l'inverse est vrai. Vous devez être en utilisant une ancienne version de Json.Net. DictionaryKeyResolver a été ajouté à version 7.0.1, et PropertyNameResolver a été marquée comme obsolète.
    InformationsquelleAutor Sep