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

コミット

commit 990f9f4c007cb8b74fafd5c3d4800de86a7f2295
Author: Russ Cox <rsc@golang.org>
Date:   Sun Feb 19 00:27:05 2012 -0500

    encoding/json: disable anonymous fields
    
    We should, after Go 1, make them work the same as
    package xml, that is, make them appear in the outer
    struct.  For now turn them off so that people do not
    depend on the old behavior.
    
    Fixing them is issue 3069.
    
    R=golang-dev, bradfitz
    CC=golang-dev
    https://golang.org/cl/5656102

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

https://github.com/golang/go/commit/990f9f4c007cb8b74fafd5c3d4800de86a7f2295

このコミットは、Go言語の標準ライブラリ encoding/json パッケージにおいて、匿名フィールド（埋め込みフィールド）のJSONエンコーディング/デコーディング時の挙動を変更するものです。具体的には、Go 1リリース後には encoding/xml パッケージと同様に、匿名フィールドが外部の構造体の一部として扱われるようにする予定ですが、それまでの間、古い挙動に依存するのを避けるために、一時的に匿名フィールドの処理を無効化しています。この問題はGoのIssue 3069として追跡されています。

変更の背景

Go言語の encoding/json パッケージは、Goの構造体とJSONデータの間で変換を行うための重要なライブラリです。Goの構造体には「匿名フィールド（Anonymous Fields）」または「埋め込みフィールド（Embedded Fields）」という特徴的な機能があります。これは、ある構造体の中に別の構造体をフィールド名なしで埋め込むことで、埋め込まれた構造体のフィールドやメソッドが、埋め込んだ側の構造体のフィールドやメソッドであるかのように直接アクセスできるようになる機能です。これはコードの再利用性やインターフェースの実装において非常に強力な機能です。

しかし、encoding/json パッケージが匿名フィールドをどのようにJSONにマッピングするかについては、初期の設計段階でいくつかの議論がありました。特に、encoding/xml パッケージが匿名フィールドを外部構造体の一部として扱うのに対し、encoding/json パッケージでは異なる挙動を示す可能性がありました。

このコミットが行われた2012年2月は、Go 1のリリースが間近に迫っていた時期です。Go 1はGo言語の安定版として、将来にわたって互換性を保証する重要なマイルストーンでした。そのため、Go 1リリース前に、将来的に変更される可能性のある挙動にユーザーが依存してしまうことを避ける必要がありました。

コミットメッセージにある「Fixing them is issue 3069」は、この匿名フィールドの扱いに関する具体的な課題がGoのIssueトラッカーで3069番として登録されていることを示しています。このIssueでは、encoding/json が匿名フィールドを encoding/xml と同様に扱うべきか、あるいは異なる挙動を維持すべきか、そしてその実装方法について議論されていました。

このコミットの目的は、Go 1リリース時点での encoding/json の挙動を明確にし、将来的な変更（匿名フィールドの適切なサポート）への道を開くことでした。一時的に匿名フィールドの処理を無効化することで、ユーザーが現在の未定義または望ましくない挙動に依存するのを防ぎ、Go 1リリース後の安定したAPI設計を可能にしました。

前提知識の解説

Go言語の構造体と匿名フィールド

Go言語の構造体（struct）は、異なる型のフィールドをまとめるためのユーザー定義型です。匿名フィールドは、構造体の中にフィールド名を指定せずに別の型（構造体、インターフェースなど）を埋め込む機能です。

例:

type Person struct {
    Name string
    Age  int
}

type Employee struct {
    Person // 匿名フィールド
    ID     string
}

func main() {
    e := Employee{
        Person: Person{Name: "Alice", Age: 30},
        ID:     "E123",
    }
    fmt.Println(e.Name) // Alice (PersonのNameフィールドに直接アクセスできる)
}

この例では、Employee 構造体は Person 構造体を匿名で埋め込んでいます。これにより、Employee のインスタンスから e.Name のように Person のフィールドに直接アクセスできます。

JSON (JavaScript Object Notation)

JSONは、人間が読んで書きやすく、機械が解析して生成しやすいデータ交換フォーマットです。キーと値のペアの集まり（オブジェクト）と、値の順序付きリスト（配列）という2つの構造に基づいています。

Goの `encoding/json` パッケージ

encoding/json パッケージは、Goのデータ構造とJSONデータの間で変換を行うための標準ライブラリです。

json.Marshal(): Goのデータ構造をJSONバイトスライスに変換（エンコード）します。
json.Unmarshal(): JSONバイトスライスをGoのデータ構造に変換（デコード）します。

Goの構造体をJSONにエンコードする際、通常は構造体のエクスポートされたフィールド（先頭が大文字のフィールド）がJSONのキーとして使用されます。フィールドタグ（json:"fieldName"）を使用することで、JSONのキー名をカスタマイズしたり、フィールドを無視したりすることができます。

Goの `encoding/xml` パッケージ

encoding/xml パッケージは、Goのデータ構造とXMLデータの間で変換を行うための標準ライブラリです。encoding/json と同様に、構造体のフィールドをXML要素や属性にマッピングします。encoding/xml における匿名フィールドの扱いは、埋め込まれた構造体のフィールドが親構造体のフィールドとして扱われるという点で、このコミットが目指す encoding/json の将来の挙動と類似していました。

GoのIssueトラッカー

Go言語の開発は、GitHubのIssueトラッカー（以前はGoogle CodeのIssueトラッカー）で公開されています。バグ報告、機能リクエスト、設計に関する議論などがIssueとして管理され、開発の透明性を保っています。Issue 3069は、encoding/json における匿名フィールドの具体的な挙動に関する議論と解決策を追跡するためのものです。

技術的詳細

このコミットの技術的な核心は、encoding/json パッケージがGoの構造体をJSONにエンコード/デコードする際に、匿名フィールドを「無視する」ように変更した点です。これは、Goの reflect パッケージを使用して構造体のフィールド情報を取得し、そのフィールドが匿名であるかどうかを判定するロジックを追加することで実現されています。

具体的には、reflect.StructField 型が持つ Anonymous フィールド（ブール値）を利用しています。このフィールドが true の場合、そのフィールドは匿名フィールドであることを示します。

エンコーディング時の変更 (`encode.go`)

encode.go はGoの構造体をJSONに変換するエンコーディングロジックを含んでいます。 encodeFields 関数は、構造体のフィールドを走査し、JSONエンコーディングの対象となるフィールドを決定します。この関数内で、各フィールド f に対して f.Anonymous が true であれば、そのフィールドをスキップするように変更されました。

// src/pkg/encoding/json/encode.go
func encodeFields(t reflect.Type) []encodeField {
    // ...
    if f.Anonymous {
        // We want to do a better job with these later,
        // so for now pretend they don't exist.
        continue
    }
    // ...
}

この変更により、匿名フィールドはJSON出力に含まれなくなります。

デコーディング時の変更 (`decode.go`)

decode.go はJSONデータをGoの構造体に変換するデコーディングロジックを含んでいます。 object 関数は、JSONオブジェクトのキーと値のペアをGoの構造体のフィールドにマッピングする処理を行います。この関数内で、JSONのキーに対応する構造体フィールドを検索する際に、匿名フィールドをスキップするように変更されました。

// src/pkg/encoding/json/decode.go
func (d *decodeState) object(v reflect.Value) {
    // ...
    if sf.Anonymous {
        // Pretend this field doesn't exist,
        // so that we can do a good job with
        // these in a later version.
        continue
    }
    // ...
}

この変更により、JSONデータに匿名フィールドに対応するキーが含まれていても、その値はGoの構造体の匿名フィールドにはデコードされなくなります。

BUGコメントの追加 (`decode.go`)

decode.go には、この挙動が一時的なものであることを示す BUG コメントが追加されました。これは、Goのドキュメント生成ツールによって自動的に「Known Bugs」セクションに表示される可能性のある特別なコメントです。

// src/pkg/encoding/json/decode.go
// The following is issue 3069.

// BUG(rsc): This package ignores anonymous (embedded) struct fields
// during encoding and decoding.  A future version may assign meaning
// to them.  To force an anonymous field to be ignored in all future
// versions of this package, use an explicit `json:"-"` tag in the struct
// definition.

このコメントは、現在の encoding/json パッケージが匿名フィールドを無視していること、将来のバージョンでその挙動が変わる可能性があること、そして匿名フィールドを永続的に無視させたい場合は json:"-" タグを使用すべきであることを明確に示しています。

テストの追加 (`decode_test.go`)

匿名フィールドが正しく無視されることを検証するためのテストケースが decode_test.go に追加されました。

// src/pkg/encoding/json/decode_test.go
func TestAnonymous(t *testing.T) {
    type T struct {
        Y int
    }
    type S struct {
        T   // 匿名フィールド
        N int
    }

    // Marshalテスト
    data, err := Marshal(new(S))
    // ...
    // 期待される出力は `{"N":0}` で、匿名フィールドTは含まれない
    want := `{"N":0}`
    if string(data) != want {
        t.Fatalf("Marshal = %#q, want %#q", string(data), want)
    }

    // Unmarshalテスト
    var s S
    // JSON入力に匿名フィールドTに対応するキーが含まれていても、
    // S.T.Yはデコードされないことを確認
    if err := Unmarshal([]byte(`{"T": 1, "T": {"Y": 1}, "N": 2}`), &s); err != nil {
        t.Fatalf("Unmarshal: %v", err)
    }
    if s.N != 2 {
        t.Fatal("Unmarshal: did not set N")
    }
    if s.T.Y != 0 { // T.Yがデコードされていないことを確認
        t.Fatal("Unmarshal: did set T.Y")
    }
}

このテストは、Marshal 時に匿名フィールドがJSON出力に含まれないこと、および Unmarshal 時にJSON入力の匿名フィールドに対応する値がGoの構造体の匿名フィールドにデコードされないことを確認しています。

これらの変更により、encoding/json パッケージはGo 1リリース時点で匿名フィールドを明示的に無視するようになり、将来のより洗練された匿名フィールドのサポートへの道筋がつけられました。

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

このコミットによる主要なコード変更は以下の3つのファイルにわたります。

src/pkg/encoding/json/decode.go: JSONデコード処理において匿名フィールドを無視するロジックの追加と、BUG コメントの追加。
src/pkg/encoding/json/decode_test.go: 匿名フィールドが正しく無視されることを検証するテストケースの追加。
src/pkg/encoding/json/encode.go: JSONエンコード処理において匿名フィールドを無視するロジックの追加。

`src/pkg/encoding/json/decode.go` の変更

--- a/src/pkg/encoding/json/decode.go
+++ b/src/pkg/encoding/json/decode.go
@@ -496,6 +496,12 @@ func (d *decodeState) object(v reflect.Value) {
 					// Pretend this field doesn't exist.
 					continue
 				}
+				if sf.Anonymous {
+					// Pretend this field doesn't exist,
+					// so that we can do a good job with
+					// these in a later version.
+					continue
+				}
 				// First, tag match
 				tagName, _ := parseTag(tag)
 				if tagName == key {
@@ -963,3 +969,11 @@ func unquoteBytes(s []byte) (t []byte, ok bool) {
 	}
 	return b[0:w], true
 }
+
+// The following is issue 3069.
+
+// BUG(rsc): This package ignores anonymous (embedded) struct fields
+// during encoding and decoding.  A future version may assign meaning
+// to them.  To force an anonymous field to be ignored in all future
+// versions of this package, use an explicit `json:"-"` tag in the struct
+// definition.

`src/pkg/encoding/json/decode_test.go` の変更

--- a/src/pkg/encoding/json/decode_test.go
+++ b/src/pkg/encoding/json/decode_test.go
@@ -619,3 +619,32 @@ func TestRefUnmarshal(t *testing.T) {
 		t.Errorf("got %+v, want %+v", got, want)
 	}\n}\n+\n+// Test that anonymous fields are ignored.\n+// We may assign meaning to them later.\n+func TestAnonymous(t *testing.T) {\n+\ttype S struct {\n+\t\tT\n+\t\tN int\n+\t}\n+\n+\tdata, err := Marshal(new(S))\n+\tif err != nil {\n+\t\tt.Fatalf("Marshal: %v", err)\n+\t}\n+\twant := `{"N":0}`\n+\tif string(data) != want {\n+\t\tt.Fatalf("Marshal = %#q, want %#q", string(data), want)\n+\t}\n+\n+\tvar s S\n+\tif err := Unmarshal([]byte(`{"T": 1, "T": {"Y": 1}, "N": 2}`), &s); err != nil {\n+\t\tt.Fatalf("Unmarshal: %v", err)\n+\t}\n+\tif s.N != 2 {\n+\t\tt.Fatal("Unmarshal: did not set N")\n+\t}\n+\tif s.T.Y != 0 {\n+\t\tt.Fatal("Unmarshal: did set T.Y")\n+\t}\n+}\n```

### `src/pkg/encoding/json/encode.go` の変更

```diff
--- a/src/pkg/encoding/json/encode.go
+++ b/src/pkg/encoding/json/encode.go
@@ -538,6 +538,11 @@ func encodeFields(t reflect.Type) []encodeField {\n 		if f.PkgPath != "" {\n 			continue\n 		}\n+		if f.Anonymous {\n+			// We want to do a better job with these later,\n+			// so for now pretend they don't exist.\n+			continue\n+		}\n 		var ef encodeField\n 		ef.i = i\n 		ef.tag = f.Name

コアとなるコードの解説

`decode.go` の変更点

decode.go の object 関数は、JSONオブジェクトをGoの構造体にデコードする際の中心的なロジックです。この関数内で、JSONのキーに対応する構造体フィールドを検索し、値を設定しています。

追加された以下のコードブロックが重要です。

				if sf.Anonymous {
					// Pretend this field doesn't exist,
					// so that we can do a good job with
					// these in a later version.
					continue
				}

ここで sf は reflect.StructField 型の変数で、現在処理している構造体フィールドのメタデータを含んでいます。sf.Anonymous は、そのフィールドが匿名フィールドである場合に true となります。この条件が真の場合、continue ステートメントによって現在のループの残りの処理がスキップされ、次のフィールドの処理に移ります。これにより、匿名フィールドはJSONデコードの対象から除外されます。

また、ファイルの末尾に追加された BUG コメントは、このパッケージの現在の制限と将来の方向性について開発者やユーザーに情報を提供します。これはGoのドキュメンテーションシステムによって認識され、パッケージのドキュメントに表示される可能性があります。

`encode.go` の変更点

encode.go の encodeFields 関数は、Goの構造体をJSONにエンコードする際に、どのフィールドをJSON出力に含めるかを決定します。