Переконайтеся, що клавіші json мають малі літери в .NET

Чи є простий спосіб за допомогою JSON у .NET переконатися, що ключі надсилаються як малі регістри?

На даний момент я використовую бібліотеку Json.NET Newtonsoft і просто користуюся

string loginRequest = JsonConvert.SerializeObject(auth);

У цьому випадку authє лише наступний об’єкт

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

Це призводить до

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

Чи є спосіб переконатися, що клавіші usernameта apitokenключі проходять через малі літери?

Я не хочу просто запускати це, String.ToLower()звичайно, тому що значення для usernameі apitokenє змішаним регістром.

Я усвідомлюю, що я можу це зробити систематично і створити рядок JSON вручну, але мені це потрібно приблизно 20 або близько рядків даних JSON, і я бачу, чи можу я заощадити час. Мені цікаво, чи є вже побудовані бібліотеки, які дозволяють застосувати малі регістри для створення ключів.

Ви можете створити для цього спеціальний вирішальник контрактів. Наступний вирішальник контракту перетворить усі ключі в малі регістри:

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

Використання:

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

Вил в результаті:

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

Якщо ви завжди хочете серіалізувати за допомогою програми LowercaseContractResolver, подумайте про те, щоб перетворити його в клас, щоб не повторюватися:

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

Які можна використовувати так:

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

ASP.NET MVC4 / WebAPI

Якщо ви використовуєте ASP.NET MVC4 / WebAPI, ви можете використовувати CamelCasePropertyNamesContractResolverбібліотеку Newtonsoft.Json, яка включена за замовчуванням.

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

У Json.NET 9.0.1 та пізніших версіях можна переконатися, що всі назви властивостей перетворюються у малі регістри за допомогою користувацького NamingStrategy. Цей клас витягує логіку алгоритмічного перекомпонування імен властивостей з вирішальника договору до окремого легкого об’єкта, на який можна встановити DefaultContractResolver.NamingStrategy. Це дозволяє уникнути необхідності створювати користувальницькийContractResolver і, таким чином, може бути простіше інтегруватися в рамки, які вже мають власні рішення для контрактів.

Визначте LowercaseNamingStrategyтак:

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

Потім серіалізуйте наступним чином:

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

Примітки -

• Використання string.ToLowerInvariant()гарантує, що однаковий контракт формується у всіх регіонах.

• Для того, щоб контролювати чи малі імена перевизначені власності, ключі словника і імена даних розширення, ви можете встановити NamingStrategy.OverrideSpecifiedNames, NamingStrategy.ProcessDictionaryKeysчи NamingStrategy.ProcessExtensionDataNames(Json.NET 10.0.1 і пізніше) до true.

• Для кращого виконання можливостей ви захочете кешувати вирішувач контракту .

• Якщо у вас немає доступу до налаштувань серіалізатора у ваших рамках, ви можете застосувати NamingStrategyбезпосередньо до свого об'єкта наступним чином:

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

• Чи не модифікувати NamingStrategyв CamelCasePropertyNamesContractResolver. Цей укладач договору ділиться інформацією у всьому світі у всіх своїх випадках, і тому зміна будь-якого одного екземпляра може мати несподівані побічні ефекти.

ви можете використовувати "JsonProperty":

Використання:

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

Для мене я використав комбінацію деяких інших відповідей і закінчив це

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

був ближче до вирішення того, що я шукав, оскільки не шукав створити свою власну