GoでJSONをPretty Printする方法

Key Takeaways

1. json.MarshalIndentを使用して、Goのデータ構造を読みやすいJSONに整形します。
2. json.Indentは、既存のJSON文字列をpretty printするために使用できます。
3. json.Encoderは、メモリ効率の良い方法でJSON出力を整形します。

Goにおいて、JSONの「pretty printing」とは、JSONデータをインデントと改行で整形し、可読性を高めることを指します。これは、ログやコンソール出力でJSONを表示する際に特に便利です。Goの標準ライブラリは、encoding/jsonパッケージを通じてこれをサポートしています。

json.MarshalIndentを使ってJSONをPretty Printする

encoding/jsonパッケージは、MarshalIndent関数を提供し、Goのデータ構造をインデント付きのJSONにシリアライズします。以下に使用方法を示します。

package main

import (
	"encoding/json"
	"fmt"
)

func main() {
	// サンプルデータ構造
	data := map[string]interface{}{
		"Name":   "Alice",
		"Age":    30,
		"Active": true,
		"Skills": []string{"Go", "Docker", "Kubernetes"},
	}

	// pretty-printed JSONに変換
	jsonData, err := json.MarshalIndent(data, "", "    ")
	if err != nil {
		fmt.Println("JSONのマーシャリングエラー:", err)
		return
	}

	// 整形されたJSONを出力
	fmt.Println(string(jsonData))
}

この例では：

• dataは、サンプルデータ構造を表すマップです。
• json.MarshalIndentは、dataをインデント付きのJSON形式のバイトスライスにシリアライズします。
• 2番目の引数（""）は、各行のプレフィックスを指定します（この場合はなし）。
• 3番目の引数（" "）は、インデント文字列を指定します（ここでは4つのスペース）。
• 結果のjsonDataは、文字列に変換されて出力されます。

出力は次のようになります。

{
    "Active": true,
    "Age": 30,
    "Name": "Alice",
    "Skills": [
        "Go",
        "Docker",
        "Kubernetes"
    ]
}

既存のJSON文字列をPretty Printingする

JSON文字列があり、それをpretty printしたい場合は、json.Indent関数を使用できます。

package main

import (
	"bytes"
	"encoding/json"
	"fmt"
)

func main() {
	// 最小化されたJSON文字列
	jsonString := `{"Name":"Alice","Age":30,"Active":true,"Skills":["Go","Docker","Kubernetes"]}`

	// 文字列をバイトスライスに変換
	jsonData := []byte(jsonString)

	// 整形されたJSONを保持するためのバッファを作成
	var prettyJSON bytes.Buffer

	// JSONをインデント
	err := json.Indent(&prettyJSON, jsonData, "", "    ")
	if err != nil {
		fmt.Println("JSONのインデントエラー:", err)
		return
	}

	// 整形されたJSONを出力
	fmt.Println(prettyJSON.String())
}

このコードでは：

• jsonStringには、最小化されたJSONデータが含まれています。
• json.Indentは、最小化されたJSONを読み取り、整形されたバージョンをprettyJSONに書き込みます。
• 整形されたJSONは、文字列として出力されます。

出力は前の例と同一になります。

インデント付きのjson.Encoderの使用

あるいは、json.Encoderを使用して、JSONをos.Stdoutなどのio.Writerに直接pretty printすることもできます。

package main

import (
	"encoding/json"
	"os"
)

func main() {
	// サンプルデータ構造
	data := map[string]interface{}{
		"Name":   "Alice",
		"Age":    30,
		"Active": true,
		"Skills": []string{"Go", "Docker", "Kubernetes"},
	}

	// インデント付きのJSONエンコーダを作成
	encoder := json.NewEncoder(os.Stdout)
	encoder.SetIndent("", "    ")

	// データをエンコードして出力
	err := encoder.Encode(data)
	if err != nil {
		fmt.Println("JSONのエンコードエラー:", err)
	}
}

このアプローチは、整形されたJSONをメモリに保持せずに、出力ストリームに直接書き込みたい場合に効率的です。

結論

Goのencoding/jsonパッケージは、JSONデータをpretty printするための複数のメソッドを提供し、ログやコンソール出力の可読性を高めます。json.MarshalIndent、json.Indent、またはインデント付きのjson.Encoderを使用するかどうかにかかわらず、ユースケースに最適な方法を選択できます。

FAQs

json.MarshalIndentとjson.Indentの違いは何ですか？

json.MarshalIndentは、Goのデータ構造をJSONに整形しますが、json.Indentは既存のJSON文字列を再フォーマットします。

json.MarshalIndentの代わりにjson.Encoderを使用するのはいつですか？

io.Writerに直接書き込む場合に、不要なメモリ使用量を避けるためにjson.Encoderを使用します。

json.MarshalIndentのインデント文字を変更できますか？

はい、json.MarshalIndentの3番目の引数でインデント文字列（スペースやタブなど）を指定します。

---

Leapcellをご紹介します。GoプロジェクトをホストするならLeapcellが最適です。

Leapcellは、次世代のサーバーレスプラットフォームで、Webホスティング、非同期タスク、Redisに対応しています。

多言語サポート

• Node.js、Python、Go、Rustで開発できます。

無制限のプロジェクトを無料でデプロイ

• 使用量に応じてのみ料金が発生し、リクエストや料金は発生しません。

比類のないコスト効率

• アイドル料金なしの従量課金制。
• 例：25ドルで、平均応答時間60msで694万リクエストをサポートします。

合理化された開発者体験

• 直感的なUIで簡単にセットアップできます。
• 完全に自動化されたCI/CDパイプラインとGitOps統合。
• 実行可能なインサイトを得るためのリアルタイムのメトリクスとロギング。

簡単なスケーラビリティと高性能

• 自動スケーリングにより、高い同時実行性を容易に処理できます。
• 運用上のオーバーヘッドはゼロで、構築に集中できます。

詳細については、ドキュメントをご覧ください。

Xでフォローしてください：@LeapcellHQ