匿名型 (Visual Basic)

[アーティクル]
08/09/2011

Visual Basic では匿名型がサポートされています。匿名型を使用すると、データ型のクラス定義を記述せずにオブジェクトを作成できます。クラスは、コンパイラによって生成されます。このクラスには使用可能な名前がなく、Object から直接継承します。また、オブジェクトの宣言時に指定したプロパティを格納します。データ型の名前が指定されないので、匿名型と呼ばれます。

次の例では、product を、Name と Price という 2 つのプロパティを持つ匿名型のインスタンスとして宣言して作成します。

' Variable product is an instance of a simple anonymous type.
Dim product = New With {Key .Name = "paperclips", .Price = 1.29}

クエリ式では、匿名型を使用して、クエリによって選択されたデータの列を結合します。特定のクエリで選択される列を予測できないので、結果の型を事前に定義することはできません。匿名型を使用すると、任意の数の列を任意の順序で選択するクエリを記述できます。コンパイラによって、指定したプロパティと指定した順序と一致するデータ型が作成されます。

次の例では、products は、多数のプロパティを持つ製品オブジェクトの一覧です。 namePriceQuery 変数は、実行すると Name と Price という 2 つのプロパティを持つ匿名型のインスタンスのコレクションが返されるクエリの定義を保持します。

Dim namePriceQuery = From prod In products
                     Select prod.Name, prod.Price

nameQuantityQuery 変数は、実行すると Name と OnHand という 2 つのプロパティを持つ匿名型のインスタンスのコレクションが返るクエリの定義を保持します。

Dim nameQuantityQuery = From prod In products
                        Select prod.Name, prod.OnHand

匿名型に対してコンパイラが作成するコードの詳細については、「匿名型の定義 (Visual Basic)」を参照してください。

ヒント

匿名型の名前は、コンパイラによって生成されるので、コンパイルするたびに変更される可能性があります。プロジェクトの再コンパイル時に変更される可能性があるので、コード内で匿名型の名前を使用したり、依存したりすることは避けてください。

匿名型の宣言

匿名型のインスタンスの宣言では、型のプロパティを指定する初期化子リストを使用します。匿名型の宣言時には、プロパティだけを指定でき、メソッドやイベントなどのその他のクラス要素は指定できません。次の例の product1 は、Name と Price という 2 つのプロパティを持つ匿名型のインスタンスです。

' Variable product1 is an instance of a simple anonymous type.
Dim product1 = New With {.Name = "paperclips", .Price = 1.29}
' -or-
' product2 is an instance of an anonymous type with key properties.
Dim product2 = New With {Key .Name = "paperclips", Key .Price = 1.29}

プロパティを主要なプロパティとして指定した場合は、それらのプロパティを使用して、2 つの匿名型のインスタンスの等価性を比較できます。ただし、主要なプロパティの値は変更できません。詳細については、このトピックで後述する「主要なプロパティ」のセクションを参照してください。

匿名型のインスタンスの宣言は、オブジェクト初期化子による名前付きの型のインスタンスの宣言に似ています。

' Variable product3 is an instance of a class named Product.
Dim product3 = New Product With {.Name = "paperclips", .Price = 1.29}

名前付きの型と匿名型の宣言の詳細な比較については、「名前付きの型と匿名型の比較 (Visual Basic)」を参照してください。

匿名型のプロパティを指定する他の方法の詳細については、「方法: 匿名型の宣言におけるプロパティ名と型を推論する (Visual Basic)」を参照してください。

主要なプロパティ

主要なプロパティは、次に示す点で、主要ではないプロパティとは根本的に異なります。

2 つのインスタンスが等価かどうかを決定する際は、主要なプロパティの値だけが比較されます。
主要なプロパティの値は読み取り専用であり、変更できません。
主要なプロパティの値だけが、コンパイラによって生成される匿名型用のハッシュコードのアルゴリズムに含まれます。

等価比較

匿名型のインスタンスは、同じ匿名型のインスタンスである場合のみ、等価になることができます。コンパイラは、2 つのインスタンスが次の条件に適合する場合、同型のインスタンスとみなします。

同一のアセンブリの中で宣言されている。
プロパティの名前と推論された型が同じであり、同じ順序で宣言されている。名前の比較では、大文字と小文字が区別されません。
各インスタンスで、同じプロパティが主要なプロパティとしてマークされている。
各宣言内の少なくとも 1 つのプロパティが、主要なプロパティである。

主要なプロパティを持たない匿名型のインスタンスは、自身に対してのみ等価です。

' prod1 and prod2 have no key values.
Dim prod1 = New With {.Name = "paperclips", .Price = 1.29}
Dim prod2 = New With {.Name = "paperclips", .Price = 1.29}

' The following line displays False, because prod1 and prod2 have no
' key properties.
Console.WriteLine(prod1.Equals(prod2))

' The following statement displays True because prod1 is equal to itself.
Console.WriteLine(prod1.Equals(prod1))

同じ匿名型の 2 つのインスタンスは、主要なプロパティの値が等しければ、等価です。次の例は、等価性のテスト方法を示しています。

Dim prod3 = New With {Key .Name = "paperclips", Key .Price = 1.29}
Dim prod4 = New With {Key .Name = "paperclips", Key .Price = 1.29}
' The following line displays True, because prod3 and prod4 are
' instances of the same anonymous type, and the values of their
' key properties are equal.
Console.WriteLine(prod3.Equals(prod4))

Dim prod5 = New With {Key .Name = "paperclips", Key .Price = 1.29}
Dim prod6 = New With {Key .Name = "paperclips", Key .Price = 1.29,
                      .OnHand = 423}
' The following line displays False, because prod5 and prod6 do not 
' have the same properties.
Console.WriteLine(prod5.Equals(prod6))

Dim prod7 = New With {Key .Name = "paperclips", Key .Price = 1.29,
                      .OnHand = 24}
Dim prod8 = New With {Key .Name = "paperclips", Key .Price = 1.29,
                      .OnHand = 423}
' The following line displays True, because prod7 and prod8 are
' instances of the same anonymous type, and the values of their
' key properties are equal. The equality check does not compare the
' values of the non-key field.
Console.WriteLine(prod7.Equals(prod8))

読み取り専用値

主要なプロパティの値は変更できません。たとえば、前の例の prod8 の場合、Name フィールドと Price フィールドは read-only ですが、OnHand は変更できます。

        ' The following statement will not compile, because Name is a key
        ' property and its value cannot be changed.
        ' prod8.Name = "clamps"

        ' OnHand is not a Key property. Its value can be changed.
        prod8.OnHand = 22

クエリ式の匿名型

クエリ式では、常に匿名型を作成する必要があるわけではありません。可能な場合は、既存の型を使用して列データを保持します。これは、クエリでデータソースからレコード全体が返された、または各レコードから 1 つのフィールドだけが返された場合に発生します。次のコード例では、customers は、Customer クラスのオブジェクトのコレクションです。このクラスには多くのプロパティがあり、その中の 1 つ以上を、任意の順序でクエリ結果に含めることができます。最初の 2 つの例では、クエリで名前付きの型の要素が選択されるため、匿名型は必要ありません。

cust.Name が文字列なので、custs1 には文字列のコレクションが格納されます。
```
Dim custs1 = From cust In customers
             Select cust.Name
```
customers の各要素は Customer オブジェクトであり、クエリによって要素全体が選択されたので、custs2 には Customer オブジェクトのコレクションが格納されます。
```
Dim custs2 = From cust In customers
             Select cust
```

ただし、適切な名前付きの型を常に使用できるとは限りません。ある目的のために顧客と住所を、別の目的で顧客 ID と所在地を、さらに別の目的で顧客名、住所、および注文履歴を選択する必要があるとします。匿名型を使用すると、結果を保持するための新しい名前付きの型を先に宣言しなくても、任意のプロパティを任意の順序で組み合わせて選択できます。プロパティのコンパイルのたびに、コンパイラによって匿名型が作成されます。次のクエリでは、customers 内の各 Customer オブジェクトから、顧客の名前と ID 番号だけを選択します。したがって、コンパイラは、これら 2 つのプロパティだけを格納する匿名型を作成します。

Dim custs3 = From cust In customers
             Select cust.Name, cust.ID

匿名型のプロパティの名前とデータ型は、両方とも、Select の引数である cust.Name と cust.ID から取得されます。クエリによって作成される匿名型のプロパティは、常に主要なプロパティになります。次の For Each ループの中で custs3 が実行された場合、結果は、Name と ID という 2 つの主要なプロパティを持つ匿名型のインスタンスのコレクションになります。

For Each selectedCust In custs3
    Console.WriteLine(selectedCust.ID & ": " & selectedCust.Name)
Next

custs3 で表されるコレクション内の要素は厳密に型指定されるので、IntelliSense を使用して、使用可能なプロパティのナビゲーションとそれらの型の検証を実行できます。

詳細については、「Visual Basic における LINQ の概要」を参照してください。

匿名型を使用するかどうかの決定

オブジェクトを匿名クラスのインスタンスとして作成する前に、それが最善の選択肢かどうかを考慮します。たとえば、関連するデータを格納する一時的なオブジェクトを作成するときに、クラス全体に格納されている可能性があるその他のフィールドやメソッドを必要としない場合、匿名型は適切なソリューションです。宣言ごとに異なるプロパティを選択する、またはプロパティの順序を変更する場合にも、匿名型は便利です。ただし、プロジェクトに、固定された順序の同じプロパティを持つ複数のオブジェクトが含まれている場合は、クラスコンストラクターと名前付きの型を使用する方が簡単に宣言できます。たとえば、適切なコンストラクターを使用すると、Product クラスの複数のインスタンスの宣言は、匿名型の複数のインスタンスの宣言より簡単です。

' Declaring instances of a named type.
Dim firstProd1 As New Product("paperclips", 1.29)
Dim secondProd1 As New Product("desklamp", 28.99)
Dim thirdProd1 As New Product("stapler", 5.09)

' Declaring instances of an anonymous type.
Dim firstProd2 = New With {Key .Name = "paperclips", Key .Price = 1.29}
Dim secondProd2 = New With {Key .Name = "desklamp", Key .Price = 28.99}
Dim thirdProd2 = New With {Key .Name = "stapler", Key .Price = 5.09}

名前付きの型で有利なもう 1 つの点は、プロパティ名のタイプミスをコンパイラが検出できることです。前の例では、firstProd2、secondProd2、および thirdProd2 は、同じ匿名型のインスタンスであることを意図しています。ただし、thirdProd2 を次のいずれかの方法で誤って宣言した場合、その型は、firstProd2 および secondProd2 の型と一致しなくなります。

' Dim thirdProd2 = New With {Key .Nmae = "stapler", Key .Price = 5.09}
' Dim thirdProd2 = New With {Key .Name = "stapler", Key .Price = "5.09"}
' Dim thirdProd2 = New With {Key .Name = "stapler", .Price = 5.09}

さらに重要なのは、匿名型の使用に関しては、名前付きの型には適用されない制約があることです。 firstProd2、secondProd2、および thirdProd2 は、同じ匿名型のインスタンスです。ただし、共有される匿名型の名前は、コード内で型名が必要とされる場所には使用不可であり、記述できません。たとえば、匿名型を使用してメソッドシグネチャを定義したり、別の変数またはフィールドを宣言したりすることはできません。また、型宣言の中では匿名型を使用できません。結果として、匿名型は、メソッド間で情報を共有する必要がある場合には適していません。

匿名型の定義

コンパイラは、匿名型のインスタンスの宣言に応答して、指定されたプロパティを含む新しいクラス定義を作成します。

匿名型に、少なくとも 1 つの主要なプロパティが含まれている場合、定義は、Object から継承された 3 つのメンバー (Equals、GetHashCode、および ToString) をオーバーライドします。等価性をテストし、ハッシュコード値を決定するために生成されるコードは、主要なプロパティだけを考慮します。匿名型に主要なプロパティが含まれていない場合は、ToString だけがオーバーライドされます。明示的に名前を付けられた匿名型のプロパティは、これらの生成されるメソッドと競合することはできません。つまり、.Equals、.GetHashCode、または .ToString を使用してプロパティに名前を付けることはできません。

少なくとも 1 つの主要なプロパティを持つ匿名型の定義は、System.IEquatable<T> インターフェイスも実装します (T は匿名型の型です)。

コンパイラによって作成されるコードと、オーバーライドされたメソッドの機能については、「匿名型の定義 (Visual Basic)」を参照してください。

参照