ฉันจะจัดรูปแบบ JSON ใน. NET โดยใช้ C # ได้อย่างไร


256

ฉันกำลังใช้ตัวแยกวิเคราะห์. NET JSON และต้องการซีเรียลไฟล์การกำหนดค่าของฉันเพื่อให้สามารถอ่านได้ ดังนั้นแทนที่จะ:

{"blah":"v", "blah2":"v2"}

ฉันต้องการบางสิ่งที่ดีกว่า:

{
    "blah":"v", 
    "blah2":"v2"
}

รหัสของฉันเป็นดังนี้:

using System.Web.Script.Serialization; 

var ser = new JavaScriptSerializer();
configSz = ser.Serialize(config);
using (var f = (TextWriter)File.CreateText(configFn))
{
    f.WriteLine(configSz);
    f.Close();
}

คำตอบ:


257

คุณกำลังจะประสบความสำเร็จกับ JavaScriptSerializer

ลองJSON.Net

ด้วยการแก้ไขเล็กน้อยจากตัวอย่าง JSON.Net

using System;
using Newtonsoft.Json;

namespace JsonPrettyPrint
{
    internal class Program
    {
        private static void Main(string[] args)
        {
            Product product = new Product
                {
                    Name = "Apple",
                    Expiry = new DateTime(2008, 12, 28),
                    Price = 3.99M,
                    Sizes = new[] { "Small", "Medium", "Large" }
                };

            string json = JsonConvert.SerializeObject(product, Formatting.Indented);
            Console.WriteLine(json);

            Product deserializedProduct = JsonConvert.DeserializeObject<Product>(json);
        }
    }

    internal class Product
    {
        public String[] Sizes { get; set; }
        public decimal Price { get; set; }
        public DateTime Expiry { get; set; }
        public string Name { get; set; }
    }
}

ผล

{
  "Sizes": [
    "Small",
    "Medium",
    "Large"
  ],
  "Price": 3.99,
  "Expiry": "\/Date(1230447600000-0700)\/",
  "Name": "Apple"
}

เอกสารประกอบ: ทำให้วัตถุเป็นอนุกรม


นอกจากนี้ยังมีตัวอย่างของการจัดรูปแบบเอาต์พุต json บนบล็อกของเขาjames.newtonking.com/archive/2008/10/16/ …
R0MANARMY

15
@Brad เขาแสดงรหัสเดียวกันอย่างแน่นอน แต่ใช้แบบจำลอง
Mia

ดังนั้นความคิดจึงเป็นเพียงการจัดรูปแบบเนื้อหา
FindOutIslamNow

วิธีการนี้ยังช่วยหนึ่งในการทำข้อผิดพลาดรูปแบบ JSON
Anshuman Goel

173

โค้ดตัวอย่างที่สั้นกว่าสำหรับไลบรารี Json.Net

private static string FormatJson(string json)
{
    dynamic parsedJson = JsonConvert.DeserializeObject(json);
    return JsonConvert.SerializeObject(parsedJson, Formatting.Indented);
}

1
คุณสามารถใช้ขั้นตอนนี้ต่อไปและสร้างวิธีการขยาย; ทำให้เป็นสาธารณะและเปลี่ยนลายเซ็นเป็น FormatJson (สตริงนี้ json)
bdwakefield

129

หากคุณมีสตริง JSON และต้องการ "prettify" มัน แต่ไม่ต้องการที่จะเป็นอันดับมันไปและกลับจาก C # ประเภทที่รู้จักกันแล้วต่อไปนี้จะหลอกลวง (ใช้ JSON.NET):

using System;
using System.IO;
using Newtonsoft.Json;

class JsonUtil
{
    public static string JsonPrettify(string json)
    {
        using (var stringReader = new StringReader(json))
        using (var stringWriter = new StringWriter())
        {
            var jsonReader = new JsonTextReader(stringReader);
            var jsonWriter = new JsonTextWriter(stringWriter) { Formatting = Formatting.Indented };
            jsonWriter.WriteToken(jsonReader);
            return stringWriter.ToString();
        }
    }
}

6
เพียงเสริมสวยสตริง Json นี้เป็นวิธีที่เหมาะสมกว่าคนอื่น ๆ ...
Jens Marchewka

2
กรณีการใช้งานต่อไปนี้จะล้มเหลว: JsonPrettify("null")และJsonPrettify("\"string\"")
Ekevoo

1
ขอบคุณ @Ekevoo ฉันได้ย้อนกลับไปเป็นเวอร์ชันก่อนหน้าของฉันแล้ว!
Duncan Smart

@DuncanSmart ฉันรักสิ่งนี้! เวอร์ชันนั้นสร้างวิธีการที่วัตถุชั่วคราวน้อยลง ฉันคิดว่ามันดีกว่าที่ฉันวิพากษ์วิจารณ์แม้ว่ากรณีใช้งานเหล่านั้นใช้ได้
Ekevoo

97

เวอร์ชันที่สั้นที่สุดเพื่อprettify JSON ที่มีอยู่: (แก้ไข: using JSON.net)

JToken.Parse("mystring").ToString()

การป้อนข้อมูล:

{"menu": { "id": "file", "value": "File", "popup": { "menuitem": [ {"value": "New", "onclick": "CreateNewDoc()"}, {"value": "Open", "onclick": "OpenDoc()"}, {"value": "Close", "onclick": "CloseDoc()"} ] } }}

เอาท์พุท:

{
  "menu": {
    "id": "file",
    "value": "File",
    "popup": {
      "menuitem": [
        {
          "value": "New",
          "onclick": "CreateNewDoc()"
        },
        {
          "value": "Open",
          "onclick": "OpenDoc()"
        },
        {
          "value": "Close",
          "onclick": "CloseDoc()"
        }
      ]
    }
  }
}

หากต้องการพิมพ์วัตถุให้สวย:

JToken.FromObject(myObject).ToString()

4
วิธีนี้ใช้งานได้โดยไม่ทราบโครงสร้างของ json ล่วงหน้า และนี่เป็นคำตอบที่สั้นที่สุดที่นี่。
foresightyj

1
ใช้งานได้ แต่เฉพาะถ้าวัตถุ json ไม่ใช่อาร์เรย์ ถ้าคุณรู้ว่ามันจะเป็นอาร์เรย์คุณสามารถให้เรา JArray.Parse แทน
ลุคซี

3
อ่าจุดดีขอบคุณ ผมได้ปรับปรุงคำตอบของฉันกับการใช้งานแทนJToken JObjectนี้ทำงานร่วมกับวัตถุหรืออาร์เรย์เนื่องจากJTokenเป็นชั้นบรรพบุรุษของทั้งสองและJObject JArray
asherber

ขอบคุณมากคนที่ฉันเสียเวลาประมาณ 2 ชั่วโมงเพื่อไปแก้ปัญหานี้ ... นึกไม่ออกว่าชีวิตไม่มี @stackoverflow ...
Rudresha Parameshappa

ฉันชอบอันนี้มากกว่าคำตอบอื่น ๆ รหัสสั้นและมีประสิทธิภาพ ขอบคุณ
Marc Roussel

47

Oneliner ใช้Newtonsoft.Json.Linq:

string prettyJson = JToken.Parse(uglyJsonString).ToString(Formatting.Indented);

ฉันยอมรับว่านี่เป็น API ที่ง่ายที่สุดสำหรับการจัดรูปแบบ JSON โดยใช้ Newtonsoft
Ethan Wu

2
ไม่พบสิ่งนี้ใน Newtonsoft.Json ... บางทีฉันอาจมีรุ่นที่เก่ากว่า
cslotty

2
มันอยู่ใน NewtonSoft.Json.Linq namespace ฉันรู้เรื่องนี้เพียงเพราะฉันไปค้นหาด้วย
กัปตัน Kenpachi

12

คุณสามารถใช้วิธีมาตรฐานต่อไปนี้ในการจัดรูปแบบ Json

JsonReaderWriterFactory.CreateJsonWriter (สตรีมสตรีม, การเข้ารหัส, เจ้าของบูลสตรีม, บูลเยื้อง, indentChars สตริง)

ตั้งค่า"indent == true" เท่านั้น

ลองอะไรเช่นนี้

    public readonly DataContractJsonSerializerSettings Settings = 
            new DataContractJsonSerializerSettings
            { UseSimpleDictionaryFormat = true };

    public void Keep<TValue>(TValue item, string path)
    {
        try
        {
            using (var stream = File.Open(path, FileMode.Create))
            {
                //var currentCulture = Thread.CurrentThread.CurrentCulture;
                //Thread.CurrentThread.CurrentCulture = CultureInfo.InvariantCulture;

                try
                {
                    using (var writer = JsonReaderWriterFactory.CreateJsonWriter(
                        stream, Encoding.UTF8, true, true, "  "))
                    {
                        var serializer = new DataContractJsonSerializer(type, Settings);
                        serializer.WriteObject(writer, item);
                        writer.Flush();
                    }
                }
                catch (Exception exception)
                {
                    Debug.WriteLine(exception.ToString());
                }
                finally
                {
                    //Thread.CurrentThread.CurrentCulture = currentCulture;
                }
            }
        }
        catch (Exception exception)
        {
            Debug.WriteLine(exception.ToString());
        }
    }

ใส่ใจกับสาย

    var currentCulture = Thread.CurrentThread.CurrentCulture;
    Thread.CurrentThread.CurrentCulture = CultureInfo.InvariantCulture;
    ....
    Thread.CurrentThread.CurrentCulture = currentCulture;

สำหรับ xml-serializers บางชนิดคุณควรใช้InvariantCultureเพื่อหลีกเลี่ยงข้อยกเว้นระหว่างการดีซีเรียลไลซ์เซชั่นในคอมพิวเตอร์ที่มีการตั้งค่าภูมิภาคที่แตกต่างกัน ตัวอย่างเช่นรูปแบบที่ไม่ถูกต้องของdoubleหรือDateTimeบางครั้งทำให้เกิด

สำหรับ deserializing

    public TValue Revive<TValue>(string path, params object[] constructorArgs)
    {
        try
        {
            using (var stream = File.OpenRead(path))
            {
                //var currentCulture = Thread.CurrentThread.CurrentCulture;
                //Thread.CurrentThread.CurrentCulture = CultureInfo.InvariantCulture;

                try
                {
                    var serializer = new DataContractJsonSerializer(type, Settings);
                    var item = (TValue) serializer.ReadObject(stream);
                    if (Equals(item, null)) throw new Exception();
                    return item;
                }
                catch (Exception exception)
                {
                    Debug.WriteLine(exception.ToString());
                    return (TValue) Activator.CreateInstance(type, constructorArgs);
                }
                finally
                {
                    //Thread.CurrentThread.CurrentCulture = currentCulture;
                }
            }
        }
        catch
        {
            return (TValue) Activator.CreateInstance(typeof (TValue), constructorArgs);
        }
    }

ขอบคุณ!


สวัสดี @Makeman คุณเคยทำซ้ำข้อผิดพลาดต่อเนื่องที่เกิดจากวัฒนธรรมที่แตกต่างกันหรือไม่? ดูเหมือนว่าการแปลง XmlJsonWriter / Reader เป็นค่าคงที่ของวัฒนธรรม
Olexander Ivanitskyi

สวัสดีฉันไม่แน่ใจเกี่ยวกับ XmlJsonWriter / Reader แต่ DataContractJsonSerializer ใช้ Thread.CurrentThread.CurrentCulture ข้อผิดพลาดอาจเกิดขึ้นเมื่อข้อมูลได้รับการทำให้เป็นอนุกรมบนเครื่อง A แต่ดีซีเรียลไลซ์บน B ด้วยการตั้งค่าภูมิภาคอื่น
Makeman

ฉัน decompiled DataContractJsonSerializerในการชุมนุมที่ไม่มีการใช้งานที่ชัดเจนของSystem.Runtime.Serialization v.4.0.0.0 CurrentCultureการใช้งานเฉพาะของวัฒนธรรมเป็นCultureInfo.InvariantCultureในชั้นฐานวิธีการภายในXmlObjectSerializer TryAddLineInfo
Olexander Ivanitskyi

ดังนั้นอาจเป็นความผิดพลาดของฉัน ฉันจะตรวจสอบในภายหลัง เป็นไปได้ฉันคาดการณ์ปัญหาวัฒนธรรมนี้จากการใช้ serializer อื่น
Makeman

1
ฉันได้แก้ไขคำตอบเดิม ดูเหมือนว่า DataContract serializers เป็นวัฒนธรรมอิสระ แต่คุณควรให้ความสนใจเพื่อหลีกเลี่ยงข้อผิดพลาดเฉพาะวัฒนธรรมในระหว่างการทำให้เป็นอนุกรมโดยซีเรียลไลเซอร์อื่น ๆ :)
Makeman

6

ทั้งหมดนี้สามารถทำได้ในหนึ่งบรรทัดง่ายๆ:

string jsonString = JsonConvert.SerializeObject(yourObject, Formatting.Indented);

1
อย่าลืมเพิ่ม 'using Newtonsoft.Json'
Ebube

คำตอบที่ดีที่สุดเพื่อนของฉัน
RogerEdward

5

นี่คือวิธีแก้ปัญหาโดยใช้ไลบรารีSystem.Text.Jsonของ Microsoft :

static string FormatJsonText(string jsonString)
{
    using var doc = JsonDocument.Parse(
        jsonString,
        new JsonDocumentOptions
        {
            AllowTrailingCommas = true
        }
    );
    MemoryStream memoryStream = new MemoryStream();
    using (
        var utf8JsonWriter = new Utf8JsonWriter(
            memoryStream,
            new JsonWriterOptions
            {
                Indented = true
            }
        )
    )
    {
        doc.WriteTo(utf8JsonWriter);
    }
    return new System.Text.UTF8Encoding()
        .GetString(memoryStream.ToArray());
}

นี่เป็นทางออกที่ดีสำหรับผู้ที่ไม่สามารถซื้อแพ็คเกจเพิ่มเติมได้ ทำได้ดี.
Mark T

2

ก่อนอื่นฉันต้องการเพิ่มความคิดเห็นภายใต้โพสต์ของดันแคนสมาร์ท แต่น่าเสียดายที่ฉันยังไม่มีชื่อเสียงเพียงพอที่จะแสดงความคิดเห็น ดังนั้นฉันจะลองที่นี่

ฉันแค่ต้องการเตือนเกี่ยวกับผลข้างเคียง

JsonTextReader แยกวิเคราะห์ json ภายในเป็น JTokens ที่พิมพ์แล้วจึงทำให้อนุกรมกลับมา

ตัวอย่างเช่นถ้า JSON ดั้งเดิมของคุณเป็น

 { "double":0.00002, "date":"\/Date(1198908717056)\/"}

หลังจาก prettify คุณจะได้รับ

{ 
    "double":2E-05,
    "date": "2007-12-29T06:11:57.056Z"
}

แน่นอนว่าสตริง json ทั้งสองนั้นมีค่าเท่ากันและจะดีซีเรียลกับวัตถุที่มีโครงสร้างเท่ากัน แต่ถ้าคุณต้องการรักษาค่าสตริงดั้งเดิมไว้คุณต้องนำสิ่งนี้มารวมกัน


มีการอภิปรายที่ยอดเยี่ยมเกี่ยวกับรายละเอียดนี้ที่นี่ ... github.com/JamesNK/Newtonsoft.Json/issues/862 น่าสนใจว่ารายละเอียดนี้พัฒนาไปอย่างไร ฉันเรียนรู้สิ่งใหม่เกี่ยวกับ json parser หลักของฉัน - ขอบคุณสำหรับความคิดเห็นของคุณ
นักท่อง SQL



0

สิ่งนี้ใช้ได้สำหรับฉัน ในกรณีที่มีใครบางคนกำลังมองหารุ่น VB.NET

@imports System
@imports System.IO
@imports Newtonsoft.Json

Public Shared Function JsonPrettify(ByVal json As String) As String
  Using stringReader = New StringReader(json)

    Using stringWriter = New StringWriter()
      Dim jsonReader = New JsonTextReader(stringReader)
      Dim jsonWriter = New JsonTextWriter(stringWriter) With {
          .Formatting = Formatting.Indented
      }
      jsonWriter.WriteToken(jsonReader)
      Return stringWriter.ToString()
    End Using
  End Using
End Function

โดยการใช้ไซต์ของเรา หมายความว่าคุณได้อ่านและทำความเข้าใจนโยบายคุกกี้และนโยบายความเป็นส่วนตัวของเราแล้ว
Licensed under cc by-sa 3.0 with attribution required.