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

コミット

• コミットハッシュ: 6044dbdf1b627fc1f30422add87216137b709bae
• 作者: Robert Griesemer gri@golang.org
• 日付: 2012年7月3日 火曜日 16:06:24 -0700
• コミットメッセージ:

  reflect: reflect.Zero results are neither addressable nor settable
  
  This could be deduced from "The Laws of Reflection" but it seems
  worthwhile highlighting it.
  
  R=r
  CC=golang-dev
  https://golang.org/cl/6350073
  

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

https://github.com/golang/go/commit/6044dbdf1b627fc1f30422add87216137b709bae

元コミット内容

reflect: reflect.Zero の結果はアドレス可能でも設定可能でもない

これは「The Laws of Reflection」から推測できることだが、強調する価値があると思われる。

変更の背景

このコミットは、Go言語の reflect パッケージにおける reflect.Zero 関数の振る舞いに関する重要な明確化を目的としています。reflect.Zero は指定された型のゼロ値を表す reflect.Value を返しますが、その結果が「アドレス可能 (addressable)」でも「設定可能 (settable)」でもないという特性を明示的にドキュメントに追加しています。

Goの reflect パッケージを使用する際、reflect.Value オブジェクトが基となる変数を変更できるかどうかは、その Value がアドレス可能であるかどうかに依存します。アドレス可能でない Value は、その値を変更する操作（例: Set メソッド）を呼び出すとパニックを引き起こします。

コミットメッセージにある「The Laws of Reflection（リフレクションの法則）」とは、Goのリフレクションの動作を理解するための3つの主要なルールを指します。そのうちの1つは、「reflect.Value はアドレス可能である場合にのみ設定可能である」というものです。reflect.Zero が返す Value は、特定の変数に紐付けられたものではなく、単に型のゼロ値を表すため、メモリ上の特定のアドレスを持たず、したがってアドレス可能ではありません。このため、その値を変更することもできません。

この変更は、既存の動作を変更するものではなく、reflect.Zero の結果の特性をより明確にし、ユーザーが誤解するのを防ぐためのドキュメントの改善です。特に、リフレクションを初めて使う開発者や、reflect.Value のアドレス可能性と設定可能性の概念に慣れていない開発者にとっては、この明示的な記述が混乱を避ける上で非常に役立ちます。

前提知識の解説

Go言語の reflect パッケージ

Go言語の reflect パッケージは、実行時にプログラムの構造を検査・操作するための機能を提供します。これにより、型情報（reflect.Type）や値情報（reflect.Value）を動的に取得し、操作することが可能になります。これは、例えば、汎用的なシリアライザ/デシリアライザ、ORM、テストフレームワークなどを実装する際に非常に強力なツールとなります。

reflect.Value 型

reflect.Value は、Goの任意の型の値を抽象的に表現する構造体です。これには、その値の型情報（Type() メソッドで取得）と、実際の値データが含まれます。reflect.Value を使用することで、コンパイル時には未知の型や値に対して、実行時に型チェックや値の操作を行うことができます。

reflect.Zero 関数

reflect.Zero(typ Type) 関数は、指定された Type のゼロ値を表す reflect.Value を返します。Goにおけるゼロ値とは、変数が宣言されたときに自動的に割り当てられるデフォルト値のことです（例: 数値型は0、文字列型は""、ブール型はfalse、ポインタ型はnil）。reflect.Zero は、特定の変数のゼロ値ではなく、単にその型のゼロ値の「表現」を生成します。

アドレス可能性 (Addressability)

reflect.Value が「アドレス可能 (addressable)」であるとは、その Value がメモリ上の特定のアドレスを持つ変数に紐付けられていることを意味します。reflect.ValueOf(&x).Elem() のように、ポインタを介して取得された Value や、構造体のフィールドの Value はアドレス可能です。アドレス可能な Value に対しては、CanSet() メソッドが true を返し、Set メソッドなどを使ってその基となる変数の値を変更できます。

設定可能性 (Settability)

reflect.Value が「設定可能 (settable)」であるとは、その Value を通じて基となる変数の値を変更できることを意味します。Goのリフレクションのルールでは、reflect.Value が設定可能であるためには、まずアドレス可能である必要があります。つまり、CanSet() メソッドが true を返す Value のみが設定可能です。reflect.ValueOf(x) のように、値のコピーから作成された Value はアドレス可能ではないため、設定もできません。

「The Laws of Reflection（リフレクションの法則）」

Goのリフレクションの動作を理解するための非公式なガイドラインで、主に以下の3つのルールが挙げられます。

1. リフレクションはインターフェースの値をGoの型と値に変換する。
2. リフレクションは reflect.Value をGoのインターフェースの値に変換する。
3. reflect.Value が設定可能であるためには、アドレス可能でなければならない。

このコミットは、特に3番目の法則に密接に関連しています。

技術的詳細

reflect.Zero(typ Type) が返す reflect.Value は、特定のメモリ位置に存在する変数に対応するものではありません。これは、あくまで指定された typ のゼロ値という「概念」を reflect.Value オブジェクトとして表現したものです。

Goのリフレクションにおいて、reflect.Value が Set メソッドなどの変更操作を許可するためには、その Value が基となる変数のアドレスを保持している必要があります。reflect.Zero が生成する Value は、そのようなアドレスを持たないため、アドレス可能ではありません。結果として、アドレス可能でない Value は設定可能でもありません。

このコミットは、src/pkg/reflect/value.go 内の Zero 関数のドキュメンテーションコメントに、この重要な特性を明示的に追加しています。これにより、開発者が reflect.Zero の結果に対して Set メソッドを呼び出そうとしてパニックに遭遇するような誤用を防ぐことができます。

例えば、以下のようなコードはパニックを引き起こします。

package main

import (
	"fmt"
	"reflect"
)

func main() {
	// int型のゼロ値 (0) を表す reflect.Value を取得
	zeroInt := reflect.Zero(reflect.TypeOf(0))
	fmt.Println("Kind:", zeroInt.Kind()) // Output: Kind: int
	fmt.Println("CanAddr:", zeroInt.CanAddr()) // Output: CanAddr: false
	fmt.Println("CanSet:", zeroInt.CanSet())   // Output: CanSet: false

	// zeroInt はアドレス可能でも設定可能でもないため、SetInt を呼び出すとパニック
	// zeroInt.SetInt(10) // panic: reflect.Value.SetInt using unaddressable value
}

このコミットは、このような振る舞いが意図されたものであり、「The Laws of Reflection」に則っていることを強調し、ドキュメントを通じてユーザーにその事実を伝えるものです。

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

変更は src/pkg/reflect/value.go ファイルの Zero 関数のドキュメンテーションコメントにあります。

--- a/src/pkg/reflect/value.go
+++ b/src/pkg/reflect/value.go
@@ -1713,10 +1713,11 @@ func ValueOf(i interface{}) Value {
 	return Value{typ, unsafe.Pointer(eface.word), fl}\n }\n \n-// Zero returns a Value representing a zero value for the specified type.\n+// Zero returns a Value representing the zero value for the specified type.\n // The result is different from the zero value of the Value struct,\n // which represents no value at all.\n // For example, Zero(TypeOf(42)) returns a Value with Kind Int and value 0.\n+// The returned value is neither addressable nor settable.\n func Zero(typ Type) Value {\n \tif typ == nil {\n \t\tpanic(\"reflect: Zero(nil)\")\n```

具体的には、以下の行が追加されました。

`+ The returned value is neither addressable nor settable.`

また、既存のコメントの最初の行がわずかに修正されています。

`- Zero returns a Value representing a zero value for the specified type.`
`+ Zero returns a Value representing the zero value for the specified type.`

これは意味的な変更ではなく、より自然な英語表現への修正です。

## コアとなるコードの解説

変更されたのは、`Zero` 関数のGoDocコメントです。

元のコメントは以下の通りでした。
```go
// Zero returns a Value representing a zero value for the specified type.
// The result is different from the zero value of the Value struct,
// which represents no value at all.
// For example, Zero(TypeOf(42)) returns a Value with Kind Int and value 0.

このコミットによって、以下の行が追加されました。

// The returned value is neither addressable nor settable.

この追加により、reflect.Zero が返す reflect.Value の重要な特性が明示的に示されるようになりました。つまり、この Value はメモリ上の特定のアドレスに紐付けられていないため、CanAddr() メソッドは false を返し、CanSet() メソッドも false を返します。したがって、この Value を介して基となる値を変更しようとすると、実行時パニックが発生します。

このドキュメントの追加は、Goのリフレクションの「リフレクションの法則」を再確認し、開発者が reflect.Zero の結果を安全かつ正しく使用するためのガイドラインを提供します。これは、コードの振る舞いを変更するものではなく、その振る舞いに関するドキュメントの正確性と完全性を向上させるものです。

関連リンク

• Go CL (Change List): https://golang.org/cl/6350073

参考にした情報源リンク

• Go Blog: The Laws of Reflection: https://go.dev/blog/laws-of-reflection
• GoDoc: reflect package: https://pkg.go.dev/reflect
• GoDoc: reflect.Value.CanAddr: https://pkg.go.dev/reflect#Value.CanAddr
• GoDoc: reflect.Value.CanSet: https://pkg.go.dev/reflect#Value.CanSet
• GoDoc: reflect.Zero: https://pkg.go.dev/reflect#Zero