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

【问题标题】：How do I get formatted JSON in .NET using C#?如何使用 C# 在 .NET 中获取格式化的 JSON？
【发布时间】：2011-02-09 07:17:09
【问题描述】：

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

【问题讨论】：

仅供参考：您并没有真正使用“the” .NET JSON 解析器，而是在旧 ASP.NET 时代创建的旧解析器。今天还有新的System.Text.Json 解析器，它速度更快，被认为是开箱即用的解析器，现在可以与.NET 一起使用。 JSON.NET 也是另一个非常流行的 .NET JSON 库。

标签： c# .net json javascriptserializer

【解决方案1】：

您将很难使用 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"
}

文档：Serialize an Object

【讨论】：

他的博客james.newtonking.com/archive/2008/10/16/…也有格式化json输出的例子
@Brad 他展示了完全相同的代码，但使用了模型
所以这个想法只是 Formatting.Indented
此方法还可以避免出现 JSON 格式错误。
这个简单的方法有效： private static string GetJson (T json) { return JsonConvert.SerializeObject(json, Formatting.Indented); }

【解决方案2】：

Json.Net 库的简短示例代码

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

【讨论】：

你实际上可以更进一步，创建一个扩展方法；将其公开并将签名更改为 FormatJson(this string json)
不需要扩展
@HaseeBMir 容易说 6.5 年后，MS 过去对开发者没那么在意。

【解决方案3】：

如果您有一个 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 字符串，这是一个比其他解决方案更合适的解决方案...
以下用例将失败：JsonPrettify("null") 和 JsonPrettify("\"string\"")
感谢@Ekevoo，我已将其回滚到以前的版本！
@DuncanSmart 我喜欢这个！该版本创建的临时对象更少。我认为它比我批评的那个更好，即使这些用例有效。

【解决方案4】：

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

【讨论】：

即使事先不知道 json 的结构，这也可以工作。而且是这里最短的答案。
这有效，但前提是 json 对象不是数组。如果你知道它将是一个数组，你可以使用 JArray.Parse 代替。
啊，好点子，谢谢。我已更新我的答案以使用 JToken 而不是 JObject。这适用于对象或数组，因为 JToken 是 JObject 和 JArray 的祖先类。
非常感谢，伙计，我浪费了大约 2 个小时来解决这个问题......无法想象没有@stackoverflow 我的生活......
我真的更喜欢这个而不是其他答案。代码短且有效。谢谢

【解决方案5】：

Oneliner 使用Newtonsoft.Json.Linq:

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

【讨论】：

我同意这是使用 Newtonsoft 格式化 JSON 的最简单的 API
在 Newtonsoft.Json 中找不到这个...也许我有一个旧版本。
它在 NewtonSoft.Json.Linq 命名空间中。我只知道这个，因为我也去寻找它。

【解决方案6】：

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

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

【讨论】：

记得添加“使用 Newtonsoft.Json”
最好的回答我的朋友。

【解决方案7】：

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

【讨论】：

对于那些无法购买额外套餐的人来说，这是一个很好的解决方案。效果很好。
不错，不想添加额外的包。

【解决方案8】：

netcoreapp3.1

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

【讨论】：

这个答案应该有更多的选票。大家还在使用 .Net Framework 吗？

【解决方案9】：

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

JsonReaderWriterFactory.CreateJsonWriter(Stream stream, Encoding encoding, bool ownsStream, bool indent, 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 以避免在具有不同区域设置的计算机上反序列化期间出现异常。例如，double 或 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);
        }
    }

谢谢！

【讨论】：

嗨，@Makeman，你有没有重现过由不同文化引起的序列化错误？似乎 XmlJsonWriter/Reader 转换都是文化不变的。
您好，我不确定 XmlJsonWriter/Reader，但 DataContractJsonSerializer 使用 Thread.CurrentThread.CurrentCulture。当数据已经在机器 A 上序列化但在 B 上使用其他区域设置反序列化时，可能会出现错误。
我在汇编System.Runtime.Serialization v.4.0.0.0中反编译了DataContractJsonSerializer，没有明确使用CurrentCulture。文化的唯一用法是基类XmlObjectSerializer中的CultureInfo.InvariantCulture，内部方法TryAddLineInfo。
所以，也许这是我的错误。我稍后会检查它。可能，我从另一个序列化程序的实现中推断出这个文化问题。
我已经编辑了原始答案。似乎 DataContract 序列化程序是独立于文化的，但您应该注意避免在其他类型的序列化程序序列化过程中出现特定于文化的错误。 :)

【解决方案10】：

使用System.Text.Json 设置JsonSerializerOptions.WriteIndented = true：

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

【讨论】：

【解决方案11】：

首先我想在 Duncan Smart 帖子下添加评论，但不幸的是我还没有足够的声誉离开 cmets。所以我会在这里尝试。

我只是想警告副作用。

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 解析器的新东西 - 谢谢你的评论。

【解决方案12】：

using System.Text.Json;
...
var parsedJson = JsonSerializer.Deserialize<ExpandoObject>(json);
var options = new JsonSerializerOptions() { WriteIndented = true };
return JsonSerializer.Serialize(parsedJson, options);

【讨论】：

【解决方案13】：

这对我有用。如果有人正在寻找 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

【讨论】：

【解决方案14】：

以下代码对我有用：

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

【讨论】：

【解决方案15】：

对于使用 .NET Core 3.1 的 UTF8 编码 JSON 文件，我终于能够根据来自 Microsoft 的以下信息使用 JsonDocument：https://docs.microsoft.com/en-us/dotnet/standard/serialization/system-text-json-how-to#utf8jsonreader-utf8jsonwriter-and-jsondocument

string allLinesAsOneString = string.Empty;
string [] lines = File.ReadAllLines(filename, Encoding.UTF8);
foreach(var line in lines)
    allLinesAsOneString += line;

JsonDocument jd = JsonDocument.Parse(Encoding.UTF8.GetBytes(allLinesAsOneString));
var writer = new Utf8JsonWriter(Console.OpenStandardOutput(), new JsonWriterOptions
{
    Indented = true
});
JsonElement root = jd.RootElement;
if( root.ValueKind == JsonValueKind.Object )
{
    writer.WriteStartObject();
}
foreach (var jp in root.EnumerateObject())
    jp.WriteTo(writer);
writer.WriteEndObject();

writer.Flush();

【讨论】：

【解决方案16】：

我有一些非常简单的方法。您可以将任何要转换为 json 格式的对象作为输入：

private static string GetJson<T> (T json)
{
    return JsonConvert.SerializeObject(json, Formatting.Indented);
}

【讨论】：

【解决方案17】：

.NET 5 在 System.Text.Json 命名空间下内置了用于处理 JSON 解析、序列化、反序列化的类。下面是一个将 .NET 对象转换为 JSON 字符串的序列化程序示例，

using System.Text.Json;
using System.Text.Json.Serialization;

private string ConvertJsonString(object obj)
{
    JsonSerializerOptions options = new JsonSerializerOptions();
    options.WriteIndented = true; //Pretty print using indent, white space, new line, etc.
    options.NumberHandling = JsonNumberHandling.AllowNamedFloatingPointLiterals; //Allow NANs
    string jsonString = JsonSerializer.Serialize(obj, options);
    return jsonString;
}

【讨论】：