Đảm bảo các khóa json là chữ thường trong .NET

Có cách đơn giản nào sử dụng JSON trong .NET để đảm bảo rằng các khóa được gửi dưới dạng chữ thường không?

Hiện tại, tôi đang sử dụng thư viện Json.NET của newtonsoft và chỉ đơn giản là sử dụng

string loginRequest = JsonConvert.SerializeObject(auth);

Trong trường hợp authnày chỉ là đối tượng sau

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

Kết quả này trong

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

Có cách nào để đảm bảo rằng các phím usernamevà apitokenphím đi qua là chữ thường không?

Tất nhiên, tôi không muốn chỉ đơn giản chạy nó String.ToLower()vì các giá trị cho usernamevà apitokenlà trường hợp hỗn hợp.

Tôi nhận ra rằng tôi có thể lập trình làm điều này và tạo chuỗi JSON theo cách thủ công, nhưng tôi cần điều này cho khoảng 20 chuỗi dữ liệu JSON hoặc hơn và tôi đang xem liệu tôi có thể tiết kiệm thời gian cho mình hay không. Tôi tự hỏi liệu có thư viện nào đã được xây dựng sẵn cho phép bạn thực thi chữ thường để tạo khóa hay không.

Bạn có thể tạo một trình giải quyết hợp đồng tùy chỉnh cho việc này. Trình giải quyết hợp đồng sau sẽ chuyển đổi tất cả các khóa thành chữ thường:

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

Sử dụng:

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

Wil kết quả là:

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

Nếu bạn luôn muốn tuần tự hóa bằng cách sử dụng LowercaseContractResolver, hãy xem xét gói nó trong một lớp để tránh lặp lại chính mình:

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

Có thể được sử dụng như thế này:

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

ASP.NET MVC4 / WebAPI

Nếu bạn đang sử dụng ASP.NET MVC4 / WebAPI, bạn có thể sử dụng CamelCasePropertyNamesContractResolverthư viện từ Newtonsoft.Json được bao gồm theo mặc định.

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

Trong Json.NET 9.0.1 và mới hơn, có thể đảm bảo rằng tất cả các tên thuộc tính được chuyển đổi thành chữ thường bằng cách sử dụng một tùy chỉnh NamingStrategy. Lớp này trích xuất logic để ánh xạ lại theo thuật toán của các tên thuộc tính từ trình phân giải hợp đồng thành một đối tượng riêng biệt, nhẹ có thể được đặt trên đó DefaultContractResolver.NamingStrategy. Làm như vậy tránh được sự cần thiết phải tạo ra một tùy chỉnhContractResolver và do đó có thể dễ dàng tích hợp vào các khuôn khổ đã có trình giải quyết hợp đồng của riêng chúng.

Xác định LowercaseNamingStrategynhư sau:

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

Sau đó tuần tự hóa như sau:

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

Ghi chú -

• Việc sử dụng string.ToLowerInvariant()đảm bảo rằng cùng một hợp đồng được tạo ở tất cả các ngôn ngữ.

• Để kiểm soát xem tên thuộc tính ghi đè, các phím từ điển và tên dữ liệu mở rộng được lowercased, bạn có thể thiết lập NamingStrategy.OverrideSpecifiedNames, NamingStrategy.ProcessDictionaryKeyshoặc NamingStrategy.ProcessExtensionDataNames(Json.NET 10.0.1 và cao hơn) để true.

• Bạn có thể muốn lưu vào bộ nhớ cache trình giải quyết hợp đồng để có hiệu suất tốt nhất .

• Nếu bạn không có quyền truy cập vào cài đặt trình tuần tự trong khuôn khổ của mình, bạn có thể áp dụng NamingStrategytrực tiếp cho đối tượng của mình như sau:

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

• Không sửa đổi NamingStrategycủa CamelCasePropertyNamesContractResolver. Trình giải quyết hợp đồng này chia sẻ thông tin loại trên toàn cầu trên tất cả các trường hợp của nó và do đó, việc sửa đổi bất kỳ trường hợp nào có thể có tác dụng phụ không mong muốn.

bạn có thể sử dụng "JsonProperty":

Sử dụng:

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

Đối với tôi, tôi đã sử dụng kết hợp một số câu trả lời khác và kết quả là

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

gần hơn với một giải pháp cho những gì tôi đang tìm kiếm vì tôi không tìm cách tạo ra