Sicherstellen, dass JSON-Schlüssel in .NET in Kleinbuchstaben geschrieben sind

Gibt es eine einfache Möglichkeit, JSON in .NET zu verwenden, um sicherzustellen, dass die Schlüssel in Kleinbuchstaben gesendet werden?

Im Moment benutze ich die Json.NET-Bibliothek von newtonsoft und benutze sie einfach

string loginRequest = JsonConvert.SerializeObject(auth);

In diesem Fall authhandelt es sich nur um das folgende Objekt

public class Authority
{
    public string Username { get; set; }
    public string ApiToken { get; set; }
}

Das führt zu

{"Username":"Mark","ApiToken":"xyzABC1234"}

Gibt es eine Möglichkeit , um sicherzustellen , dass die usernameund apitokenTasten als Klein kommen durch?

Ich möchte es String.ToLower()natürlich nicht einfach durchgehen, weil die Werte für usernameund apitokengemischt sind.

Mir ist klar, dass ich dies programmgesteuert tun und die JSON-Zeichenfolge manuell erstellen kann, aber ich benötige dies für ungefähr 20 JSON-Datenzeichenfolgen, und ich sehe, ob ich mir etwas Zeit sparen kann. Ich frage mich, ob es bereits erstellte Bibliotheken gibt, mit denen Sie Kleinbuchstaben für die Schlüsselerstellung erzwingen können.

Hierfür können Sie einen benutzerdefinierten Vertragsauflöser erstellen. Der folgende Vertragsauflöser konvertiert alle Schlüssel in Kleinbuchstaben:

public class LowercaseContractResolver : DefaultContractResolver
{
    protected override string ResolvePropertyName(string propertyName)
    {
        return propertyName.ToLower();
    }
}

Verwendung:

var settings = new JsonSerializerSettings();
settings.ContractResolver = new LowercaseContractResolver();
var json = JsonConvert.SerializeObject(authority, Formatting.Indented, settings);

Wil Ergebnis in:

{"username":"Mark","apitoken":"xyzABC1234"}

Wenn Sie immer mit serialisieren möchten, sollten Sie LowercaseContractResolveres in eine Klasse einschließen, um zu vermeiden, dass Sie sich wiederholen:

public class LowercaseJsonSerializer
{
    private static readonly JsonSerializerSettings Settings = new JsonSerializerSettings
    {
        ContractResolver = new LowercaseContractResolver()
    };

    public static string SerializeObject(object o)
    {
        return JsonConvert.SerializeObject(o, Formatting.Indented, Settings);
    }

    public class LowercaseContractResolver : DefaultContractResolver
    {
        protected override string ResolvePropertyName(string propertyName)
        {
            return propertyName.ToLower();
        }
    }
}

Welches kann so verwendet werden:

var json = LowercaseJsonSerializer.SerializeObject(new { Foo = "bar" });
// { "foo": "bar" }

ASP.NET MVC4 / WebAPI

Wenn Sie ASP.NET MVC4 / WebAPI verwenden, können Sie eine CamelCasePropertyNamesContractResolverBibliothek von Newtonsoft.Json verwenden, die standardmäßig enthalten ist.

protected void Application_Start() {
    JsonConfig.Configure();   
}

public static class JsonConfig
{
    public static void Configure(){
        var formatters = GlobalConfiguration.Configuration.Formatters;
        var jsonFormatter = formatters.JsonFormatter;
        var settings = jsonFormatter.SerializerSettings;

        settings.ContractResolver = new CamelCasePropertyNamesContractResolver();
    }
}

In Json.NET 9.0.1 und höher kann mithilfe einer benutzerdefinierten Funktion sichergestellt werden, dass alle Eigenschaftsnamen in Kleinbuchstaben konvertiert werden NamingStrategy. Diese Klasse extrahiert die Logik für die algorithmische Neuzuordnung von Eigenschaftsnamen aus dem Vertragsauflöser zu einem separaten, leichtgewichtigen Objekt, das festgelegt werden kann DefaultContractResolver.NamingStrategy. Dadurch wird die Notwendigkeit vermieden, eine benutzerdefinierteContractResolver Version zu erstellen, und es kann daher einfacher sein, diese in Frameworks zu integrieren, die bereits über eigene Vertragsauflöser verfügen.

Definieren Sie LowercaseNamingStrategywie folgt:

public class LowercaseNamingStrategy : NamingStrategy
{
    protected override string ResolvePropertyName(string name)
    {
        return name.ToLowerInvariant();
    }
}

Dann serialisieren Sie wie folgt:

var settings = new JsonSerializerSettings
{
    ContractResolver = new DefaultContractResolver { NamingStrategy = new LowercaseNamingStrategy() },
};
string loginRequest = JsonConvert.SerializeObject(auth, settings);

Anmerkungen -

• Durch string.ToLowerInvariant()die Verwendung wird sichergestellt, dass in allen Ländereinstellungen derselbe Vertrag generiert wird.

• Um zu steuern , ob überschriebene Eigenschaftsnamen, Dictionary - Schlüssel und Erweiterungsdatennamen werden klein geschrieben, können Sie einstellen NamingStrategy.OverrideSpecifiedNames, NamingStrategy.ProcessDictionaryKeysoder NamingStrategy.ProcessExtensionDataNames(Json.NET 10.0.1 und höher) true.

• Möglicherweise möchten Sie den Vertragsauflöser für eine optimale Leistung zwischenspeichern .

• Wenn Sie keinen Zugriff auf die Serializer-Einstellungen in Ihrem Framework haben, können Sie a NamingStrategydirekt wie folgt auf Ihr Objekt anwenden :

  [JsonObject(NamingStrategyType = typeof(LowercaseNamingStrategy))]
  public class Authority
  {
      public string Username { get; set; }
      public string ApiToken { get; set; }
  }

• Ändern Sie nicht das NamingStrategyvon CamelCasePropertyNamesContractResolver. Dieser Vertragsauflöser teilt Typinformationen global für alle Instanzen. Daher kann das Ändern einer Instanz unerwartete Nebenwirkungen haben.

Sie können "JsonProperty" verwenden:

Verwendung:

public class Authority
{
    [JsonProperty("userName")] // or [JsonProperty("username")]
    public string Username { get; set; }
    [JsonProperty("apiToken")] // or [JsonProperty("apitoken")]
    public string ApiToken { get; set; }
}

var json  = JsonConvert.SerializeObject(authority);

Für mich habe ich eine Kombination aus einigen der anderen Antworten verwendet und am Ende diese erhalten

        return JsonConvert.SerializeObject(obj, Formatting.Indented, new JsonSerializerSettings
        {
            ContractResolver = new CamelCasePropertyNamesContractResolver()
        });

war näher an einer Lösung für das, was ich suchte, da ich nicht meine eigene erstellen wollte