เก็บปลอกเมื่อจัดลำดับพจนานุกรม

Question 1

ฉันมีโครงการ Web Api ที่ได้รับการกำหนดค่าดังนี้:

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

อย่างไรก็ตามฉันต้องการให้ตัวครอบแป้นพจนานุกรมไม่เปลี่ยนแปลง มีแอตทริบิวต์ใดบ้างที่Newtonsoft.Jsonฉันสามารถใช้กับคลาสเพื่อแสดงว่าฉันต้องการให้ปลอกยังคงไม่เปลี่ยนแปลงระหว่างการทำให้เป็นอนุกรม

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

Question 2

ไม่มีแอตทริบิวต์ที่จะทำสิ่งนี้ แต่คุณสามารถทำได้โดยการปรับแต่งตัวแก้ไข

ฉันเห็นว่าคุณใช้ไฟล์CamelCasePropertyNamesContractResolver. หากคุณได้รับคลาสตัวแก้ไขใหม่จากนั้นและแทนที่CreateDictionaryContract()เมธอดคุณสามารถจัดเตรียมDictionaryKeyResolverฟังก์ชันทดแทนที่ไม่เปลี่ยนชื่อคีย์

นี่คือรหัสที่คุณต้องการ:

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

        contract.DictionaryKeyResolver = propertyName => propertyName;

        return contract;
    }
}

การสาธิต:

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

นี่คือผลลัพธ์จากด้านบน สังเกตว่าชื่อคุณสมบัติคลาสทั้งหมดเป็นแบบอูฐ แต่คีย์พจนานุกรมยังคงอยู่ในปลอกเดิม

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

Question 3

Json.NET 9.0.1แนะนำNamingStrategyลำดับชั้นของคลาสเพื่อจัดการปัญหาประเภทนี้ เป็นสารสกัดจากตรรกะสำหรับแมปอัลกอริทึมของชื่อทรัพย์สินจากการจำแนกสัญญาที่จะแยกระดับน้ำหนักเบาที่ช่วยให้การควบคุมว่ากุญแจพจนานุกรม , ชื่อคุณสมบัติระบุไว้อย่างชัดเจนและชื่อข้อมูลส่วนขยาย (ใน10.0.1 ) จะ remapped

การใช้DefaultContractResolverและการตั้งค่าNamingStrategyเป็นอินสแตนซ์ของCamelCaseNamingStrategyคุณสามารถสร้าง JSON ด้วยชื่อคุณสมบัติที่ใส่อูฐและคีย์พจนานุกรมที่ไม่ได้แก้ไขโดยการตั้งค่าในJsonSerializerSettings.ContractResolver:

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

หมายเหตุ:

การนำไปใช้ในปัจจุบันCamelCasePropertyNamesContractResolverยังระบุด้วยว่าสมาชิก. Net ที่มีชื่อคุณสมบัติที่ระบุอย่างชัดเจน (เช่นชื่อที่JsonPropertyAttribute.PropertyNameถูกตั้งค่า) ควรมีการแมปชื่อของพวกเขา:
```
public CamelCasePropertyNamesContractResolver()
{
    NamingStrategy = new CamelCaseNamingStrategy
    {
        ProcessDictionaryKeys = true,
        OverrideSpecifiedNames = true
    };
}
```
ข้างต้นresolverรักษาพฤติกรรมนี้ OverrideSpecifiedNames = falseถ้าคุณไม่อยากให้เรื่องนี้ชุด
Json.NET มีกลยุทธ์การตั้งชื่อในตัวหลายอย่าง ได้แก่ :
1. CamelCaseNamingStrategy. CamelCasePropertyNamesContractResolverกลยุทธ์การตั้งชื่อกรณีอูฐที่มีตรรกะชื่อแมปเดิมที่ฝังอยู่ใน
2. SnakeCaseNamingStrategy. งูกรณีกลยุทธ์การตั้งชื่อ
3. DefaultNamingStrategy. กลยุทธ์การตั้งชื่อเริ่มต้น ชื่อคุณสมบัติและคีย์พจนานุกรมไม่มีการเปลี่ยนแปลง
NamingStrategyหรือคุณสามารถสร้างของคุณเองโดยการสืบทอดจากคลาสฐานนามธรรม
ในขณะที่มันยังเป็นไปได้ที่จะปรับเปลี่ยนNamingStrategyของตัวอย่างของCamelCasePropertyNamesContractResolverตั้งแต่หลังข้อมูลหุ้นสัญญาทั่วโลกทั่วทุกกรณีของแต่ละประเภทCamelCasePropertyNamesContractResolverนี้สามารถนำไปสู่การที่ไม่คาดคิดผลข้างเคียงหากใบสมัครของคุณพยายามที่จะใช้กรณีหลาย ไม่มีปัญหาดังกล่าวDefaultContractResolverดังนั้นจึงปลอดภัยกว่าที่จะใช้เมื่อจำเป็นต้องปรับแต่งตรรกะของปลอก

Question 4

นั่นเป็นคำตอบที่ดีมาก แต่ทำไมไม่เพียงแค่ลบล้างResolveDictionaryKey?

class CamelCaseExceptDictionaryResolver : CamelCasePropertyNamesContractResolver
    {
        #region Overrides of DefaultContractResolver

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

        #endregion
    }

Question 5

คำตอบที่เลือกนั้นสมบูรณ์แบบ แต่ฉันเดาว่าเมื่อฉันพิมพ์สิ่งนี้ตัวแก้ไขสัญญาต้องเปลี่ยนเป็นแบบนี้เพราะ DictionaryKeyResolver ไม่มีอยู่อีกต่อไป :)

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