文字列

Go言語 JSONエスケープ処理：EscapeHTML設定と特殊文字対策ガイド

2025-02-20更新日: 2025-02-20

Go言語のjsonパッケージでは、特殊文字が自動でエスケープされ、例えば「&」は「\u0026」として出力されます。

これは一部ブラウザが誤ってHTMLと認識するのを防ぐ目的があります。

必要に応じて、EncoderのSetEscapeHTMLメソッドでエスケープ処理を無効にすることもでき、実装の柔軟性が保たれています。

目次から探す

JSONエスケープ処理の基本
- エスケープされる特殊文字一覧
- 自動エスケープの背景と目的
Go言語のjsonパッケージの動作
- json.Marshalとjson.NewEncoderの違い
- デフォルト設定時のエスケープ挙動
EscapeHTML設定の活用方法
- EncoderのSetEscapeHTMLメソッドの利用
実装例と動作確認
- サンプルコードの解説
- 動作確認とテスト手法
特殊文字対策のポイント
- ブラウザ互換性への配慮
- セキュリティ面での考慮事項
まとめ

JSONエスケープ処理の基本

エスケープされる特殊文字一覧

Go言語のjsonパッケージでは、主に以下の特殊文字が自動的にエスケープされます。

& は \u0026 に変換されます。
< は \u003c に変換されます。
> は \u003e に変換されます。

これにより、WebブラウザでのHTML誤認識などのトラブルを未然に防ぐ目的があります。

自動エスケープの背景と目的

JSONデータをそのままHTMLに埋め込むケースにおいて、ブラウザが特定の記号をHTMLタグと誤解する可能性があります。

自動エスケープ処理は、次のような理由から実装されています。

安全にデータを扱うため、特定の記号をUnicodeエスケープに変換し、HTMLとの混同を防ぐ。
予期せぬ動作やセキュリティリスクを低減するため、エスケープ処理を自動で適用する。

この仕様により、プログラマは任意のケースで追加の手間をかけずに、標準のエスケープ処理の恩恵を受けることができます。

Go言語のjsonパッケージの動作

json.Marshalとjson.NewEncoderの違い

json.Marshal と json.NewEncoder はどちらもJSON出力に利用されますが、その動作と用途には以下の違いがあります。

json.Marshal
- JSONオブジェクトをバイトスライスに変換し、戻り値として得られます。
- 小規模なデータ変換や、変換結果をさらに加工する場合に便利です。
json.NewEncoder
- 指定した io.Writer に直接JSONデータを書き込みます。
- 大量データの直出力や、ファイルやネットワーク出力が必要な場合に適しています。

デフォルト設定時のエスケープ挙動

どちらの方法を用いる場合も、jsonパッケージはデフォルトでHTMLエスケープを行います。

そのため、特に設定を変更しなければ以下のような変換が自動的に適用されます。

"&" が "\u0026" に
"<" が "\u003c" に
">" が "\u003e" に

この自動エスケープにより、不意のセキュリティ問題やHTMLの解釈ミスを回避できます。

EscapeHTML設定の活用方法

EncoderのSetEscapeHTMLメソッドの利用

Go言語では、json.NewEncoder を利用した場合、SetEscapeHTMLメソッドを使うことでエスケープ処理の挙動を制御できます。

この設定を変更することで、意図に合わせたエスケープ処理を有効または無効にすることが可能です。

コード例による設定変更の実装解説

以下のコード例は、SetEscapeHTML を用いて自動エスケープの無効化を実装する方法を示しています。

コメント内に処理の説明を記載しているので、コードの流れが把握しやすくなっています。

package main
import (
	"encoding/json"
	"fmt"
	"os"
)
func main() {
	// JSON出力用のデータ構造体
	type SpecialChars struct {
		Ampersand         string `json:"ampersand"`
		LeftAngleBracket  string `json:"left_angle_bracket"`
		RightAngleBracket string `json:"right_angle_bracket"`
	}
	// 特殊文字を持つデータを用意
	data := SpecialChars{
		Ampersand:         "&",  // アンパサンド
		LeftAngleBracket:  "<",  // 左角括弧
		RightAngleBracket: ">",  // 右角括弧
	}
	// Encoderを用いる場合の標準出力へのJSONエンコード例
	encoder := json.NewEncoder(os.Stdout)
	// 標準状態ではEscapeHTMLが有効であるため、特殊文字がエスケープされる例
	encoder.Encode(data)
	// 出力例: {"ampersand":"\u0026","left_angle_bracket":"\u003c","right_angle_bracket":"\u003e"}
	// EscapeHTMLを無効に設定し、特殊文字をそのまま出力する例
	encoder.SetEscapeHTML(false)
	encoder.Encode(data)
	// 出力例: {"ampersand":"&","left_angle_bracket":"<","right_angle_bracket":">"}
}

{"ampersand":"\u0026","left_angle_bracket":"\u003c","right_angle_bracket":"\u003e"}
{"ampersand":"&","left_angle_bracket":"<","right_angle_bracket":">"}

実装例と動作確認

サンプルコードの解説

ここでは、json.Marshal と json.NewEncoder の2つの手法をサンプルコードにより解説します。

両手法の違いや、エスケープ処理の挙動を実際に確認する方法についても述べます。

json.Marshalを使った例

以下のコードは、json.Marshal を用いてJSONエンコードを行い、バイトスライスを文字列として出力する例です。

エスケープ処理がどのように実施されるかに注目してください。

package main
import (
	"encoding/json"
	"fmt"
)
func main() {
	// 構造体定義とサンプルデータの設定
	type SpecialChars struct {
		Ampersand         string `json:"ampersand"`
		LeftAngleBracket  string `json:"left_angle_bracket"`
		RightAngleBracket string `json:"right_angle_bracket"`
	}
	data := SpecialChars{
		Ampersand:         "&",
		LeftAngleBracket:  "<",
		RightAngleBracket: ">",
	}
	// json.Marshalを用いて構造体をJSONに変換
	jsonBytes, err := json.Marshal(data)
	if err != nil {
		fmt.Println("エラー:", err)
		return
	}
	fmt.Println(string(jsonBytes))
	// 出力例: {"ampersand":"\u0026","left_angle_bracket":"\u003c","right_angle_bracket":"\u003e"}
}

{"ampersand":"\u0026","left_angle_bracket":"\u003c","right_angle_bracket":"\u003e"}

json.NewEncoderを利用した例

次のコードは、json.NewEncoder を用い、標準出力へ直接JSONエンコードを実施する例です。

エスケープ処理のデフォルト設定と、SetEscapeHTML(false) による設定変更が確認できます。

package main
import (
	"encoding/json"
	"os"
)
func main() {
	// 構造体定義とサンプルデータの設定
	type SpecialChars struct {
		Ampersand         string `json:"ampersand"`
		LeftAngleBracket  string `json:"left_angle_bracket"`
		RightAngleBracket string `json:"right_angle_bracket"`
	}
	data := SpecialChars{
		Ampersand:         "&",
		LeftAngleBracket:  "<",
		RightAngleBracket: ">",
	}
	// json.NewEncoderを用いて標準出力にJSONを出力
	encoder := json.NewEncoder(os.Stdout)
	encoder.Encode(data)
	// 出力例: {"ampersand":"\u0026","left_angle_bracket":"\u003c","right_angle_bracket":"\u003e"}
	// EscapeHTMLを無効に設定し、特殊文字をエスケープせずに出力
	encoder.SetEscapeHTML(false)
	encoder.Encode(data)
	// 出力例: {"ampersand":"&","left_angle_bracket":"<","right_angle_bracket":">"}
}

{"ampersand":"\u0026","left_angle_bracket":"\u003c","right_angle_bracket":"\u003e"}
{"ampersand":"&","left_angle_bracket":"<","right_angle_bracket":">"}