Як мені відформатувати JSON у .NET за допомогою C #?

Я використовую .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();
}

Вам буде важко досягти цього за допомогою 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.Net

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

Якщо у вас є рядок JSON і ви хочете "вподобати" її, але не хочете її серіалізувати до відомого типу 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();
        }
    }
}

Найкоротша версія для покращення існуючого JSON: (редагувати: використовуючи 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()

Oneliner з використанням Newtonsoft.Json.Linq:

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

Ви можете використовувати наступний стандартний метод для форматування Json

JsonReaderWriterFactory.CreateJsonWriter (Потік потоку, Кодування кодування, bool володієStream, відступ bool, string 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-серіалізаторів слід використовувати InvariantCulture, щоб уникнути виключення під час десеріалізації на комп'ютерах з різними регіональними налаштуваннями. Наприклад, недійсний формат подвійного або DateTime іноді їх викликає .

Для десеріалізації

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

Дякую!

Все це можна зробити одним простим рядком:

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

Ось рішення з використанням бібліотеки Microsoft System.Text.Json :

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

Спершу я хотів додати коментар під публікацією Duncan Smart, але, на жаль, ще не маю достатньої репутації, щоб залишати коментарі. Тому я спробую це тут.

Я просто хочу попередити про побічні ефекти.

JsonTextReader внутрішньо розбирає json на введений JTokens, а потім послідовно повертає їх назад.

Наприклад, якщо ваш оригінальний JSON був

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

Після гарнітури ви отримаєте

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

Звичайно, обидва рядки json еквівалентні і десеріалізуються на структурно рівні об'єкти, але якщо вам потрібно зберегти початкові значення рядка, вам потрібно взяти це до розгляду

Використовуючи System.Text.Jsonнабір JsonSerializerOptions.WriteIndented = true:

JsonSerializerOptions options = new JsonSerializerOptions { WriteIndented = true };
string json = JsonSerializer.Serialize<Type>(object, options);

netcoreapp3.1

var js = JsonSerializer.Serialize(obj, new JsonSerializerOptions {
             WriteIndented = true
         });

Це працювало для мене. Якщо хтось шукає версію 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

Нижче код працює для мене:

JsonConvert.SerializeObject(JToken.Parse(yourobj.ToString()))