确保json密钥在.NET中是小写的

时间:2011-06-09 05:58:41

标签: .net json json.net

是否有简单的方法在.NET中使用JSON来确保密钥以小写形式发送?

目前我正在使用newtonsoft的Json.NET库,只需使用

string loginRequest = JsonConvert.SerializeObject(auth);

在这种情况下,auth只是以下对象

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

这导致

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

有没有办法确保usernameapitoken键以小写形式出现?

我当然不想简单地通过String.ToLower()运行它,因为usernameapitoken的值是大小写混合的。

我意识到我可以以编程方式执行此操作并手动创建JSON字符串,但我需要大约20个左右的JSON数据字符串,我看到我是否可以节省一些时间。我想知道是否有任何已经构建的库允许您强制使用小写来创建密钥。

5 个答案:

答案 0 :(得分:161)

您可以为此创建自定义合约解析程序。以下合约解析程序会将所有键转换为小写:

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

Wil导致:

{"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,则可以使用默认包含的Newtonsoft.Json库中的CamelCasePropertyNamesContractResolver

答案 1 :(得分:21)

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

答案 2 :(得分:7)

https://github.com/dwyl/hapi-auth-jwt2/issues/248及更高版本中,可以使用自定义Json.NET 9.0.1确保将所有属性名称转换为小写。此类从合同解析程序中提取属性名称的算法重新映射的逻辑,以便在NamingStrategy上设置单独的轻量级对象。 这样做可以避免创建DefaultContractResolver.NamingStrategy的需要,因此可以更容易地集成到已经拥有自己的合同解析器的框架中。

如下定义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);

然后序列化如下:

true

备注 -

答案 3 :(得分:3)

你可以使用“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);

答案 4 :(得分:1)

对我来说,我结合了其他一些答案,最后得到了这个

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

由于我不想创建自己的解决方案,因此更接近于我所寻找的解决方案