Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

[インデックス 10417] ファイルの概要

このコミットは、Go言語の標準ライブラリである html/template パッケージにおける、トップレベルの値（特にポインタ）の扱いに関する修正を導入しています。具体的には、テンプレート内で {{.}} のようにトップレベルの値を表示しようとした際に、その値がポインタであった場合に、ポインタが指す実際の値ではなく、ポインタのアドレスが表示されてしまう問題を解決します。この修正により、html/template は text/template パッケージと同様に、ポインタを自動的に間接参照してその実体を表示するようになります。

コミット

commit f5db4d05f299c8cf681eae0f1b3faeb3b8df7bdb
Author: Rob Pike <r@golang.org>
Date:   Wed Nov 16 09:32:52 2011 -0800

    html/template: indirect top-level values before printing
    text/template does this (in an entirely different way), so
    make html/template do the same. Before this fix, the template
    {{.}} given a pointer to a string prints its address instead of its
    value.

    R=mikesamuel, r
    CC=golang-dev
    https://golang.org/cl/5370098

GitHub上でのコミットページへのリンク

https://github.com/golang/go/commit/f5db4d05f299c8cf681eae0f1b3faeb3b8df7bdb

元コミット内容

html/template: トップレベルの値を表示する前に間接参照する。 text/template は（全く異なる方法で）これを行っているため、html/template も同様に行うようにする。この修正以前は、文字列へのポインタが与えられた {{.}} テンプレートは、その値ではなくアドレスを表示していた。

変更の背景

Go言語のテンプレートパッケージには、主に text/template と html/template の二つがあります。これらは構文的には似ていますが、html/template はHTMLのサニタイズ（エスケープ処理）を自動的に行うことで、クロスサイトスクリプティング（XSS）などのセキュリティ脆弱性を防ぐ役割を担っています。

このコミットが修正する問題は、html/template がテンプレートのデータコンテキストとしてポインタを受け取った際に、そのポインタが指す実際の値ではなく、ポインタ自体のメモリアドレスを文字列として出力してしまうというものでした。例えば、data が *string 型の変数である場合、{{.}} は data が指す文字列ではなく、data のアドレス（例: 0xc000123456）を出力してしまっていました。

一方、text/template は、このようなポインタの自動的な間接参照（デリファレンス）を既に行う設計になっていました。この挙動の不一致は、開発者にとって混乱の原因となり、特に text/template から html/template へ移行する際に予期せぬ出力につながる可能性がありました。

このコミットの目的は、html/template の挙動を text/template に合わせ、ポインタが与えられた場合にはその実体を自動的に表示するようにすることで、より直感的で一貫性のあるテンプレート処理を提供することにあります。これにより、開発者はポインタを意識することなく、テンプレートにデータを渡すことができるようになります。

前提知識の解説

Go言語のポインタと間接参照

Go言語におけるポインタは、変数のメモリアドレスを保持する特殊な型です。ポインタを使用することで、関数間で大きなデータをコピーすることなく参照渡ししたり、構造体のフィールドを直接変更したりすることができます。

  • ポインタの宣言: var p *int のように、型名の前に * を付けて宣言します。
  • アドレスの取得: 変数のアドレスは & 演算子を使って取得します。例: p = &x
  • 間接参照（デリファレンス）: ポインタが指す値にアクセスするには、ポインタ変数の前に * 演算子を付けます。例: fmt.Println(*p)

reflect パッケージ

Go言語の reflect パッケージは、実行時に変数の型情報や値を検査・操作するための機能を提供します。これにより、Goの静的型付けの制約を受けずに、動的なプログラミングが可能になります。

  • reflect.TypeOf(i interface{}) Type: インターフェース値 i の動的な型を返します。
  • reflect.ValueOf(i interface{}) Value: インターフェース値 i の動的な値を返します。
  • Value.Kind() Kind: Value が表す値の具体的な種類（例: reflect.Ptr, reflect.String, reflect.Int など）を返します。
  • Value.Elem() Value: ポインタの場合、そのポインタが指す要素の Value を返します。これはポインタを間接参照する操作に相当します。

このコミットでは、reflect パッケージを使用して、テンプレートに渡された値がポインタであるかどうかを判断し、もしポインタであればその実体まで繰り返し間接参照する処理を実装しています。

text/template と html/template の違い

  • text/template: 任意のテキスト出力を生成するための汎用テンプレートエンジンです。入力されたデータはそのまま出力されるため、HTMLなどのマークアップ言語を生成する際には、開発者が明示的にエスケープ処理を行う必要があります。
  • html/template: text/template をベースに、HTML出力に特化したセキュリティ機能を追加したテンプレートエンジンです。自動的にHTMLエスケープ処理を行い、XSS攻撃などの脆弱性を防ぎます。例えば、{{.Name}} のように変数を表示する際に、Name の値に <script> タグが含まれていても、自動的に &lt;script&gt; のようにエスケープしてくれます。

このコミット以前は、ポインタの自動間接参照という点で両者の挙動に違いがありましたが、この修正によって html/template も text/template と同様の直感的なポインタ処理を行うようになりました。

技術的詳細

このコミットの主要な変更点は、html/template パッケージ内で値がポインタである場合に、そのポインタを自動的に間接参照するためのヘルパー関数 indirect および indirectToJSONMarshaler を導入し、既存の文字列化処理やJavaScriptエスケープ処理に適用したことです。

indirect 関数の導入 (src/pkg/html/template/content.go)

indirect 関数は、任意の interface{} 型の値を受け取り、それがポインタである限り、reflect.Elem() を使って繰り返し間接参照し、最終的な非ポインタ型（または nil ポインタ）の値を返します。

// indirect returns the value, after dereferencing as many times
// as necessary to reach the base type (or nil).
func indirect(a interface{}) interface{} {
    if t := reflect.TypeOf(a); t.Kind() != reflect.Ptr {
        // Avoid creating a reflect.Value if it's not a pointer.
        return a
    }
    v := reflect.ValueOf(a)
    for v.Kind() == reflect.Ptr && !v.IsNil() {
        v = v.Elem()
    }
    return v.Interface()
}

この関数は、まず入力 a の型がポインタでない場合は、reflect.Value を作成するオーバーヘッドを避けるためにそのまま a を返します。ポインタである場合は reflect.ValueOf(a) で reflect.Value を取得し、for ループ内で v.Kind() == reflect.Ptr かつ !v.IsNil() である限り v = v.Elem() を実行し、ポインタをデリファレンスし続けます。最終的に、非ポインタ型になった値、または nil ポインタになった値を interface{} 型として返します。

stringify 関数への適用 (src/pkg/html/template/content.go)

stringify 関数は、テンプレート内で値を文字列に変換する際に使用されます。この関数が indirect を利用するように変更されました。

変更前:

		switch s := args[0].(type) {

変更後:

		switch s := indirect(args[0]).(type) {

これにより、単一の引数が与えられた場合、まず indirect 関数によってポインタがデリファレンスされてから型アサーションが行われます。

また、複数の引数が与えられた場合（fmt.Sprint を使用するケース）にも、すべての引数に対して indirect が適用されるようになりました。

	for i, arg := range args {
		args[i] = indirect(arg)
	}
	return fmt.Sprint(args...), contentTypePlain

この変更により、fmt.Sprint に渡される前にすべてのポインタがデリファレンスされ、期待される値が文字列化されるようになります。

indirectToJSONMarshaler 関数の導入 (src/pkg/html/template/js.go)

js.go では、JavaScriptのコンテキストで値をエスケープする jsValEscaper 関数があります。JavaScriptのオブジェクトはJSONとして表現されることが多いため、json.Marshaler インターフェースを実装している型は、その MarshalJSON メソッドによってカスタムのJSON表現を提供できます。

indirectToJSONMarshaler 関数は indirect と似ていますが、ポインタをデリファレンスする際に、その型が json.Marshaler インターフェースを実装しているかどうかをチェックします。もし実装していれば、それ以上デリファレンスせずにその値を返します。これは、json.Marshaler がポインタレシーバを持つ場合（例: func (p *MyType) MarshalJSON() ([]byte, error)）に、ポインタ自体をマーシャリングしたいという意図を尊重するためです。

var jsonMarshalType = reflect.TypeOf((*json.Marshaler)(nil)).Elem()

// indirectToJSONMarshaler returns the value, after dereferencing as many times
// as necessary to reach the base type (or nil) or an implementation of json.Marshal.
func indirectToJSONMarshaler(a interface{}) interface{} {
    v := reflect.ValueOf(a)
    for !v.Type().Implements(jsonMarshalType) && v.Kind() == reflect.Ptr && !v.IsNil() {
        v = v.Elem()
    }
    return v.Interface()
}

この関数は、v.Type().Implements(jsonMarshalType) が true になるか、ポインタでなくなるか、nil ポインタになるまでデリファレンスを続けます。

jsValEscaper 関数への適用 (src/pkg/html/template/js.go)

jsValEscaper 関数も indirectToJSONMarshaler を利用するように変更されました。

変更前:

 	if len(args) == 1 {
 		a = args[0]

変更後:

 	if len(args) == 1 {
 		a = indirectToJSONMarshaler(args[0])

単一の引数の場合、indirectToJSONMarshaler が適用されます。

複数の引数の場合も同様に、すべての引数に対して indirectToJSONMarshaler が適用されます。

	} else {
		for i, arg := range args {
			args[i] = indirectToJSONMarshaler(arg)
		}
		a = fmt.Sprint(args...)
	}

これにより、JavaScriptコンテキストでエスケープされる値も、適切にデリファレンスされるか、または json.Marshaler の実装が尊重されるようになります。

テストケースの追加 (src/pkg/html/template/escape_test.go)

このコミットでは、ポインタの自動間接参照の挙動を検証するための新しいテストケースが追加されています。

  • TestEscape 関数内で、data 構造体へのポインタ pdata を使ってテンプレートを実行し、期待される出力が得られることを確認するテストブロックが追加されました。これにより、既存の多くのエスケープテストシナリオがポインタに対しても正しく機能することが保証されます。
  • TestIndirectPrint という新しいテスト関数が追加されました。このテストは、{{.}} テンプレートに対して、int へのポインタ (*int) や string へのポインタへのポインタ (**string) など、様々な深さのポインタを渡した場合に、正しく最終的な値がプリントされることを明示的に検証します。

これらのテストは、修正が意図した通りに機能し、ポインタの自動間接参照が正しく行われることを保証するものです。

コアとなるコードの変更箇所

このコミットにおけるコアとなるコードの変更箇所は以下の通りです。

  1. src/pkg/html/template/content.go:
    • reflect パッケージのインポートを追加。
    • indirect 関数を新規追加。
    • stringify 関数内で、引数に対して indirect 関数を適用するように変更。
  2. src/pkg/html/template/js.go:
    • reflect パッケージのインポートを追加。
    • indirectToJSONMarshaler 関数を新規追加。
    • jsValEscaper 関数内で、引数に対して indirectToJSONMarshaler 関数を適用するように変更。
  3. src/pkg/html/template/escape_test.go:
    • TestEscape 関数内に、ポインタを使ったテストケースを追加。
    • TestIndirectPrint 関数を新規追加し、様々なポインタのデリファレンス挙動を検証。

コアとなるコードの解説

このコミットの核心は、Goの reflect パッケージを効果的に利用して、実行時に値がポインタであるかどうかを判断し、必要に応じてそのポインタを自動的にデリファレンスするメカニズムを導入した点にあります。

indirect 関数は、Goのテンプレートシステムがデータを処理する際の「前処理」として機能します。テンプレートに渡されるデータは interface{} 型として扱われるため、コンパイル時にはその具体的な型（ポインタかどうか）を知ることはできません。reflect を使うことで、実行時にこの型情報を取得し、ポインタであればその実体まで辿り着くことができます。これにより、{{.}} のような単純なテンプレート構文でも、ポインタの背後にある実際の値を表示できるようになりました。

indirectToJSONMarshaler 関数は、indirect の特殊なケースです。JavaScriptのコンテキストでは、JSONシリアライズの挙動が重要になります。Goの encoding/json パッケージでは、json.Marshaler インターフェースを実装している型は、独自のJSON表現を提供できます。このインターフェースはポインタレシーバを持つことが多いため、indirectToJSONMarshaler は、json.Marshaler を実装しているポインタを見つけた場合、それ以上デリファレンスせずにそのポインタを返します。これは、開発者が json.Marshaler を通じてポインタのカスタムシリアライズを意図している場合に、その意図を尊重するための重要な挙動です。

これらの変更により、html/template は text/template と同様に、ポインタを透過的に扱うことができるようになり、開発者はテンプレートに渡すデータの型を過度に意識することなく、より自然な形でテンプレートを記述できるようになりました。これは、Goのテンプレートシステムの一貫性と使いやすさを向上させる上で重要な改善です。

関連リンク

参考にした情報源リンク