如何使用C#在.NET中获取格式化的JSON?


255

我正在使用.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();
}

Answers:


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

文档:序列化对象



15
@Brad他展示了完全相同的代码,但是使用了一个模型
Mia

所以这个想法就是Formatting.Indented
FindOutIslamNow

此方法还可以避免JSON格式错误。
Anshuman Goel

171

Json.Net库的较短示例代码

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

您实际上可以更进一步,并创建扩展方法。公开并将签名更改为FormatJson(this string json)
bdwakefield

129

如果您有一个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();
        }
    }
}

6
仅修饰一个Json字符串,这是比其他字符串更合适的解决方案……
Jens Marchewka 2015年

2
以下用例将失败:JsonPrettify("null")JsonPrettify("\"string\"")
Ekevoo

1
感谢@Ekevoo,我已将其回滚到以前的版本!
Duncan Smart

@DuncanSmart我喜欢这个!该版本创建的临时对象更少。我认为,即使这些用例都能奏效,它也比我批评的要好。
Ekevoo '16

97

美化现有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()

4
即使不事先知道json的结构,此方法也可以工作。这是最短的答案
foresightyj

1
这是可行的,但前提是json对象不是数组。如果您知道它将是一个数组,则可以改用JArray.Parse。
路加福音Z

3
啊,很好,谢谢。我已经将答案更新为JToken而不是JObject。这适用于对象或数组,因为JToken是两个祖先类JObjectJArray
阿瑟伯

非常感谢,伙计,我浪费了大约2个小时才能获得此解决方案...无法想象没有@stackoverflow的生活...
Rudresha Parameshappa

我真的更喜欢这个答案。短代码有​​效。谢谢
Marc Roussel '18

47

Oneliner使用Newtonsoft.Json.Linq

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

我同意这是使用Newtonsoft格式化JSON的最简单API
Ethan Wu

2
在Newtonsoft.Json中找不到此文件……也许我有一个旧版本。
cslotty

2
它在NewtonSoft.Json.Linq命名空间中。我只知道这一点,因为我也一直在寻找它。
肯帕奇船长

12

您可以使用以下标准方法来格式化Json

JsonReaderWriterFactory.CreateJsonWriter(流流,编码编码,bool ownsStream,bool缩进,字符串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来避免在具有不同“区域”设置的计算机上反序列化期间发生异常。例如,doubleDateTime的无效格式有时会导致它们。

反序列化

    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)

DataContractJsonSerializer在汇编时反编译,System.Runtime.Serialization v.4.0.0.0没有明确使用CurrentCulture。文化的唯一用法是CultureInfo.InvariantCulture在基类XmlObjectSerializer内部方法中TryAddLineInfo
亚历山大·伊万尼斯基

所以,也许这是我的错误。稍后再检查。可能的是,我从另一个序列化程序的实现推断出这种文化问题。
Makeman '10

1
我已经编辑了原始答案。似乎DataContract序列化程序不依赖于区域性,但您应注意避免在序列化期间使用其他类型的序列化程序特定于区域性的错误。:)
Makeman '19

6

所有这一切都可以在一个简单的行中完成:

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

1
记得添加“ using Newtonsoft.Json”
Ebube

最好回答我的朋友。
RogerEdward

5

这是使用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());
}

对于无法购买额外套餐的人来说,这是一个很好的解决方案。效果很好。
Mark T

2

首先,我想在Duncan Smart帖子下添加评论,但不幸的是,我没有足够的声誉来发表评论。所以我会在这里尝试。

我只想警告副作用。

JsonTextReader在内部将json解析为类型化的JToken,然后将它们序列化回去。

例如,如果您的原始JSON是

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

美化你后

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

当然,两个json字符串都是等效的,并且将反序列化为结构上相等的对象,但是如果您需要保留原始字符串值,则需要考虑这一点


这里有关于此细节的大量讨论 。github.com/JamesNK/Newtonsoft.Json/issues/862 有趣的是,这个细节如何演变。我了解了有关主JSON解析器的新知识-谢谢您的评论。
Sql Surfer

2

使用System.Text.Jsonset JsonSerializerOptions.WriteIndented = true

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

1

netcoreapp3.1

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

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

0

下面的代码对我有用:

JsonConvert.SerializeObject(JToken.Parse(yourobj.ToString()))
By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.