キー (Visual Basic)

[アーティクル]
09/30/2008

更新 : 2008 年 7 月

Key キーワードを使用すると、匿名型のプロパティの動作を指定できます。キープロパティとして指定したプロパティのみが、匿名型のインスタンス間での等価テストやハッシュコード値の計算に使用されます。キープロパティの値は変更できません。

匿名型のプロパティをキープロパティとして指定するには、初期化リストでの宣言時に Key キーワードをプロパティの前に置きます。次の例では、Airline と FlightNo はキープロパティですが、Gate はキープロパティではありません。

Dim flight1 = New With {Key .Airline = "Blue Yonder Airlines", _
                        Key .FlightNo = 3554, .Gate = "C33"}

作成される新しい匿名型は、Object から直接継承します。コンパイラは、次の 3 つの継承されたメンバをオーバーライドします。Equals、GetHashCode、および ToString。Equals および GetHashCode のために生成されるオーバーライドコードは、キープロパティに基づいています。型の中にキープロパティがない場合、GetHashCode と Equals はオーバーライドされません。

等価比較

2 つの匿名型のインスタンスは、型が同じであり、キープロパティの値が等しければ、等価のインスタンスです。次の例では、flight2 および前の例の flight1 は、同じ匿名型のインスタンスであり、キープロパティの値が一致するので等価です。ただし、flight3 と flight1 は等価ではありません。キープロパティの FlightNo の値が異なるためです。flight4 インスタンスの型は flight1 と同じではありません。これらは、異なるプロパティをキープロパティとして指定しています。

Dim flight2 = New With {Key .Airline = "Blue Yonder Airlines", _
                        Key .FlightNo = 3554, .Gate = "D14"}
' The following statement displays True. The values of the non-key 
' property, Gate, do not have to be equal.
Console.WriteLine(flight1.Equals(flight2))

Dim flight3 = New With {Key .Airline = "Blue Yonder Airlines", _
                        Key .FlightNo = 431, .Gate = "C33"}
' The following statement displays False, because flight3 has a
' different value for key property FlightNo.
Console.WriteLine(flight1.Equals(flight3))

Dim flight4 = New With {Key .Airline = "Blue Yonder Airlines", _
                        .FlightNo = 3554, .Gate = "C33"}
' The following statement displays False. Instance flight4 is not the 
' same type as flight1 because they have different key properties. 
' FlightNo is a key property of flight1 but not of flight4.
Console.WriteLine(flight1.Equals(flight4))

2 つのインスタンスが、キープロパティ以外のプロパティで宣言されている場合は、名前、型、順序、および値が同一であっても、2 つのインスタンスは等価ではありません。キープロパティを持たないインスタンスは、自身に対してのみ等価です。

2 つの匿名型インスタンスが同じ匿名型のインスタンスである場合の条件については、「匿名型」を参照してください。

ハッシュコードの計算

Equals のように、匿名型に対して GetHashCode で定義されたハッシュ関数は、型のキープロパティに基づきます。キープロパティとハッシュコード値の間のやり取りを次の例に示します。

すべてのキープロパティに対して同じ値を持つ匿名型のインスタンスは、キープロパティ以外のプロパティの値が一致していなくても、同じハッシュコードを保持します。次のステートメントは True を返します。

Console.WriteLine(flight1.GetHashCode = flight2.GetHashCode)

1 つ以上のキープロパティの値が異なる匿名型のインスタンスは、異なるハッシュコード値を保持します。次のステートメントは False を返します。

Console.WriteLine(flight1.GetHashCode = flight3.GetHashCode)

異なるプロパティをキープロパティとして指定する匿名型のインスタンスは、同じ型のインスタンスではありません。これらは、すべてのプロパティの名前と値が同じであっても、ハッシュコード値が異なります。次のステートメントは False を返します。

Console.WriteLine(flight1.GetHashCode = flight4.GetHashCode)

読み取り専用値

キープロパティの値は変更できません。たとえば、前の例の flight1 では、Airline フィールドと FlightNo フィールドは読み取り専用ですが、Gate は変更可能です。

' The following statement will not compile, because FlightNo is a key
' property and cannot be changed.
' flight1.FlightNo = 1234
'
' Gate is not a key property. Its value can be changed.
flight1.Gate = "C5"