ฉันจะเปลี่ยนชื่อพร็อพเพอร์ตี้เมื่อซีเรียลไลซ์กับ Json.net ได้อย่างไร

ฉันมีข้อมูลบางอย่างในวัตถุ C # DataSet ฉันสามารถทำให้เป็นอันดับตอนนี้โดยใช้ตัวแปลง Json.net เช่นนี้

DataSet data = new DataSet();
// do some work here to populate 'data'
string output = JsonConvert.SerializeObject(data);

อย่างไรก็ตามสิ่งนี้ใช้ชื่อคุณสมบัติจากdataเมื่อพิมพ์ไปยังไฟล์. json ฉันต้องการเปลี่ยนชื่อคุณสมบัติเป็นชื่ออื่น (พูดเปลี่ยน 'foo' เป็น 'bar')

ในเอกสารประกอบของ Json.netภายใต้ 'Serializing and Deserializing JSON' → 'แอตทริบิวต์การทำให้เป็นอนุกรม' มันบอกว่า "JsonPropertyAttribute ... อนุญาตให้ชื่อถูกปรับแต่ง" แต่ไม่มีตัวอย่าง ไม่มีใครรู้วิธีใช้ JsonPropertyAttribute เพื่อเปลี่ยนชื่อคุณสมบัติเป็นอย่างอื่นหรือไม่

( ลิงก์โดยตรงไปยังเอกสารประกอบ )

เอกสารของ Json.net ดูเหมือนจะกระจัดกระจาย หากคุณมีตัวอย่างที่ยอดเยี่ยมฉันจะลองเพิ่มมันเข้าไปในเอกสารประกอบอย่างเป็นทางการ ขอบคุณ!

คุณสามารถตกแต่งคุณสมบัติที่คุณต้องการควบคุมชื่อด้วยแอ[JsonProperty]ททริบิวต์ที่ช่วยให้คุณสามารถระบุชื่ออื่น:

using Newtonsoft.Json;
// ...

[JsonProperty(PropertyName = "FooBar")]
public string Foo { get; set; }

เอกสาร: คุณสมบัติการทำให้เป็นอนุกรม

หากคุณไม่สามารถเข้าถึงคลาสเพื่อเปลี่ยนคุณสมบัติหรือไม่ต้องการใช้คุณสมบัติการเปลี่ยนชื่อเดียวกันเสมอการเปลี่ยนชื่อสามารถทำได้ด้วยการสร้างตัวแก้ไขที่กำหนดเอง

ตัวอย่างเช่นถ้าคุณมีคลาสที่เรียกMyCustomObjectว่ามีคุณสมบัติที่เรียกว่าLongPropertyNameคุณสามารถใช้ตัวแก้ไขที่กำหนดเองเช่นนี้ ...

public class CustomDataContractResolver : DefaultContractResolver
{
  public static readonly CustomDataContractResolver Instance = new CustomDataContractResolver ();

  protected override JsonProperty CreateProperty(MemberInfo member, MemberSerialization memberSerialization)
  {
    var property = base.CreateProperty(member, memberSerialization);
    if (property.DeclaringType == typeof(MyCustomObject))
    {
      if (property.PropertyName.Equals("LongPropertyName", StringComparison.OrdinalIgnoreCase))
      {
        property.PropertyName = "Short";
      }
    }
    return property;
  }
}

จากนั้นเรียกใช้การทำให้เป็นอันดับและจัดหาตัวแก้ไข:

 var result = JsonConvert.SerializeObject(myCustomObjectInstance,
                new JsonSerializerSettings { ContractResolver = CustomDataContractResolver.Instance });

และผลลัพธ์จะสั้นลงเป็น{"Short": "prop value"}แทน{"LongPropertyName": "prop value"}

ข้อมูลเพิ่มเติมเกี่ยวกับตัวแก้ไขที่กำหนดเองที่นี่

ยังมีวิธีการอื่นที่จะทำมันซึ่งมีการใช้โดยเฉพาะอย่างยิ่งNamingStrategyซึ่งสามารถนำไปใช้ในชั้นเรียนหรือสถานที่ให้บริการโดยการตกแต่งพวกเขาด้วยหรือ[JSonObject][JsonProperty]

มีกลยุทธ์การตั้งชื่อที่กำหนดไว้ล่วงหน้าเช่นCamelCaseNamingStrategyแต่คุณสามารถใช้กลยุทธ์ของคุณเองได้

การใช้กลยุทธ์การตั้งชื่อต่าง ๆ สามารถดูได้ที่นี่: https://github.com/JamesNK/Newtonsoft.Json/tree/master/Src/Newtonsoft.Json/Serialization