C#を使用して.NETでフォーマットされたJSONを取得するにはどうすればよいですか?


275

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

回答:


265

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 2018年

この方法では、JSON形式のエラーを回避することもできます。
AnshumanGoel19年

187

Json.Netライブラリの短いサンプルコード

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

2
実際には、これをさらに一歩進めて、拡張メソッドを作成できます。公開し、署名をFormatJson(この文字列json)に変更します
bdwakefield

拡張機能は必要ありません
HaseeB Mir

@HaseeBMirは6。5年後、MSは過去に開発者をそれほど気にしませんでした。
dvdmn

134

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 2016

1
@Ekevooに感謝します、以前のバージョンにロールバックしました!
Duncan Smart

@DuncanSmart私はこれが大好きです!そのバージョンでは、作成される一時オブジェクトがはるかに少なくなります。それらのユースケースがうまくいったとしても、私が批判したものよりはましだと思います。
Ekevoo 2016

106

既存の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

2
これは機能しますが、jsonオブジェクトが配列でない場合に限ります。配列になることがわかっている場合は、代わりにJArray.Parseを使用できます。
ルークZ

4
ああ、良い点、ありがとう。のJToken代わりに使用するように回答を更新しましたJObject。ので、これは、オブジェクトや配列で動作しJToken、両方の先祖クラスであるJObjectJArray
asherber 2017年

どうもありがとう、私はこの解決策に到達するために約2時間を無駄にしました...
@ stackoverflow

私は他の答えよりもこれを本当に好みます。ショートコードで効果的。ありがとう
MarcRoussel18年

50

使用するワンライナーNewtonsoft.Json.Linq

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

これがNewtonsoftを使用してJSONをフォーマットするための最も単純なAPIであることに同意します
Ethan Wu

2
Newtonsoft.Jsonでこれを見つけることができませんでした...多分私は古いバージョンを持っています。
cslotty

2
NewtonSoft.Json.Linq名前空間にあります。私も探しに行ったので、これを知っているだけです。
キャプテンケン

16

これはすべて、1つの簡単な行で実行できます。

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

3
'Newtonsoft.Jsonを使用して'を追加することを忘れないでください
Ebube

私の友人に最もよく答えなさい。
RogerEdward

12

フォーマットされたJsonを取得するには、次の標準的な方法を使用できます

JsonReaderWriterFactory.CreateJsonWriter(ストリームストリーム、エンコーディングエンコーディング、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の変換はすべて文化に依存しないようです。
OlexanderIvanitskyi19年

こんにちは、XmlJsonWriter / Readerについてはよくわかりませんが、DataContractJsonSerializerはThread.CurrentThread.CurrentCultureを使用します。データがマシンAでシリアル化されているが、別の地域設定でBで逆シリアル化されている場合、エラーが発生する可能性があります。
メイクマン

DataContractJsonSerializerアセンブリSystem.Runtime.Serialization v.4.0.0.0で逆コンパイルしましたが、の明示的な使用法はありませんCurrentCulture。カルチャの唯一の使用法はCultureInfo.InvariantCulture、基本クラスのXmlObjectSerializer内部メソッドTryAddLineInfoです。
OlexanderIvanitskyi19年

だから、多分それは私の間違いです。後で確認します。可能性として、私はこの文化の問題を別のシリアライザーの実装から推定しています。
メイクマン

1
元の回答を編集しました。DataContractシリアライザーはカルチャに依存しないようですが、別の種類のシリアライザーによるシリアライズ中にカルチャ固有のエラーを回避するために注意を払う必要があります。:)
メイクマン

12

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

1
これは、追加のパッケージを購入できない人にとっては良い解決策です。うまく機能します。
マークT

4

netcoreapp3.1

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

2

最初はDuncanSmartの投稿の下にコメントを追加したかったのですが、残念ながらまだコメントを残すのに十分な評判がありません。だからここでやってみます。

副作用について警告したいだけです。

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.Jsonセットを使用するJsonSerializerOptions.WriteIndented = true

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

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

.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();
弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.