Giữ cách viết hoa khi sắp xếp tuần tự từ điển

Tôi có một dự án Web Api đang được định cấu hình như sau:

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

Tuy nhiên, tôi muốn cách viết hoa của các phím từ điển không thay đổi. có thuộc tính nào trong Newtonsoft.Jsontôi có thể sử dụng cho một lớp để biểu thị rằng tôi muốn cách viết hoa không thay đổi trong quá trình tuần tự hóa không?

public class SomeViewModel
{
    public Dictionary<string, string> Data { get; set; }    
}

Không có thuộc tính để thực hiện việc này, nhưng bạn có thể thực hiện bằng cách tùy chỉnh trình phân giải.

Tôi thấy rằng bạn đã sử dụng a CamelCasePropertyNamesContractResolver. Nếu bạn dẫn xuất một lớp trình phân giải mới từ đó và ghi đè CreateDictionaryContract()phương thức, bạn có thể cung cấp một DictionaryKeyResolverhàm thay thế không thay đổi tên khóa.

Đây là mã bạn cần:

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

        contract.DictionaryKeyResolver = propertyName => propertyName;

        return contract;
    }
}

Bản giới thiệu:

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

Đây là kết quả từ phía trên. Lưu ý rằng tất cả các tên thuộc tính lớp đều có vỏ camel, nhưng các khóa từ điển vẫn giữ nguyên cách viết hoa ban đầu của chúng.

{
  "anIntegerProperty": 42,
  "htmlString": "<html></html>",
  "dictionary": {
    "WHIZbang": "1",
    "FOO": "2",
    "Bar": "3"
  }
}

Json.NET 9.0.1 đã giới thiệu NamingStrategyhệ thống phân cấp lớp để xử lý loại vấn đề này. Nó 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 lớp riêng biệt, nhẹ cho phép kiểm soát xem các khóa từ điển , tên thuộc tính được chỉ định rõ ràng và tên dữ liệu mở rộng (trong 10.0.1 ) có được ánh xạ lại hay không.

Bằng cách sử dụng DefaultContractResolvervà đặt NamingStrategythành một phiên bản của CamelCaseNamingStrategybạn, bạn có thể tạo JSON với tên thuộc tính dựa trên lạc đà và các khóa từ điển chưa sửa đổi bằng cách đặt nó trong JsonSerializerSettings.ContractResolver:

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

Ghi chú:

• Việc triển khai hiện tại của CamelCasePropertyNamesContractResolvercũng chỉ định rằng các thành viên .Net có tên thuộc tính được chỉ định rõ ràng (ví dụ: những thuộc tính JsonPropertyAttribute.PropertyNameđã được đặt) phải có tên của chúng được ánh xạ lại:

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

  Ở trên resolverbảo tồn hành vi này. Nếu bạn không muốn điều này, hãy thiết lập OverrideSpecifiedNames = false.

• Json.NET có một số chiến lược đặt tên tích hợp bao gồm:

  1. CamelCaseNamingStrategy. Chiến lược đặt tên theo trường hợp lạc đà có chứa logic ánh xạ lại tên trước đây được nhúng vào CamelCasePropertyNamesContractResolver.
  2. SnakeCaseNamingStrategy. Một chiến lược đặt tên trường hợp rắn .
  3. DefaultNamingStrategy. Chiến lược đặt tên mặc định. Tên thuộc tính và khóa từ điển không thay đổi.

  Hoặc, bạn có thể tạo của riêng mình bằng cách kế thừa từ lớp cơ sở trừu tượng NamingStrategy.

• Mặc dù cũng có thể sửa đổi NamingStrategyphiên bản của CamelCasePropertyNamesContractResolver, vì phiên bản sau chia sẻ thông tin hợp đồng trên toàn cầu trên tất cả các phiên bản của mỗi loại , điều này có thể dẫn đến các tác dụng phụ không mong muốn nếu ứng dụng của bạn cố gắng sử dụng nhiều phiên bản của CamelCasePropertyNamesContractResolver. Không có vấn đề như vậy tồn tại DefaultContractResolver, vì vậy sẽ an toàn hơn khi sử dụng khi bất kỳ tùy chỉnh nào của logic vỏ được yêu cầu.

Đó là một câu trả lời rất hay. Nhưng tại sao không chỉ cần ghi đè ResolveDictionaryKey?

class CamelCaseExceptDictionaryResolver : CamelCasePropertyNamesContractResolver
    {
        #region Overrides of DefaultContractResolver

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

        #endregion
    }

Câu trả lời đã chọn là hoàn hảo nhưng tôi đoán vào thời điểm tôi nhập câu này, trình giải quyết hợp đồng phải thay đổi thành một cái gì đó như thế này vì DictionaryKeyResolver không tồn tại nữa :)

public class CamelCaseExceptDictionaryKeysResolver : CamelCasePropertyNamesContractResolver
    {
        protected override JsonDictionaryContract CreateDictionaryContract(Type objectType)
        {
            JsonDictionaryContract contract = base.CreateDictionaryContract(objectType);
            contract.PropertyNameResolver = propertyName => propertyName;
            return contract;
        }
    }