集合 (Visual Basic)

發行項
05/10/2023

在許多應用程式中，您想要建立和管理相關物件的群組。有兩種方式可以群組物件：建立物件的陣列和建立物件的集合。

陣列是最適用於建立和處理固定數目的強類型物件。如需陣列的資訊，請參閱陣列。

集合會提供較具彈性的方式來使用物件群組。與陣列不同的是，您使用的物件群組可依程式變更的需要來動態增減。對於某些集合，您可以將索引鍵值指派給您放入集合的任何物件，讓您可以藉由使用索引鍵快速擷取物件。

集合是類別，因此您必須在將項目加入該集合之前，宣告類別的執行個體。

如果集合包含只有一個資料類型的項目，則可使用 System.Collections.Generic 命名空間內的其中一個類別。泛型集合會強制類型安全，如此就不會加入其他資料類型。當您從泛型集合中擷取項目時，並不需要判斷其資料類型或將其轉換。

注意

在本主題的範例中，請包括 System.Collections.Generic 和 System.Linq 命名空間的 Imports 陳述式。

使用簡單的集合

本節中的範例使用泛型 List<T> 類別，能夠讓您使用強型別物件清單。

以下範例會建立字串清單，並使用 For Each…Next 陳述式逐一查看字串。

' Create a list of strings.
Dim salmons As New List(Of String)
salmons.Add("chinook")
salmons.Add("coho")
salmons.Add("pink")
salmons.Add("sockeye")

' Iterate through the list.
For Each salmon As String In salmons
    Console.Write(salmon & " ")
Next
'Output: chinook coho pink sockeye

如果預先知道集合的內容，即可使用「集合初始設定式」來初始化集合。如需詳細資訊，請參閱集合初始設定式。

下列範例與前一個範例相同，但有一點除外，就是集合初始設定式是用來將項目加入集合中。

' Create a list of strings by using a
' collection initializer.
Dim salmons As New List(Of String) From
    {"chinook", "coho", "pink", "sockeye"}

For Each salmon As String In salmons
    Console.Write(salmon & " ")
Next
'Output: chinook coho pink sockeye

您可以使用 For…Next 陳述式來逐一查看集合，而不是使用 For Each 陳述式。您可以藉由依索引位置存取集合項目來完成這項作業。項目的索引以 0 開始，並以項目計數減 1 結束。

下列範例會使用 For…Next 來逐一查看集合的項目，而不是使用 For Each。

Dim salmons As New List(Of String) From
    {"chinook", "coho", "pink", "sockeye"}

For index = 0 To salmons.Count - 1
    Console.Write(salmons(index) & " ")
Next
'Output: chinook coho pink sockeye

下列範例透過指定要移除的物件，從集合中移除項目。

' Create a list of strings by using a
' collection initializer.
Dim salmons As New List(Of String) From
    {"chinook", "coho", "pink", "sockeye"}

' Remove an element in the list by specifying
' the object.
salmons.Remove("coho")

For Each salmon As String In salmons
    Console.Write(salmon & " ")
Next
'Output: chinook pink sockeye

下列範例會移除泛型清單中的項目。使用以遞減順序反覆運算的 For…Next 陳述式，而不是 For Each 陳述式。這是因為 RemoveAt 方法導致在已移除之項目後面的項目具有較低的索引值。

Dim numbers As New List(Of Integer) From
    {0, 1, 2, 3, 4, 5, 6, 7, 8, 9}

' Remove odd numbers.
For index As Integer = numbers.Count - 1 To 0 Step -1
    If numbers(index) Mod 2 = 1 Then
        ' Remove the element by specifying
        ' the zero-based index in the list.
        numbers.RemoveAt(index)
    End If
Next

' Iterate through the list.
' A lambda expression is placed in the ForEach method
' of the List(T) object.
numbers.ForEach(
    Sub(number) Console.Write(number & " "))
' Output: 0 2 4 6 8

如需 List<T> 中的項目類型，您也可以定義自己的類別。在下列範例中，List<T> 使用的 Galaxy 類別是在程式碼中定義的。

Private Sub IterateThroughList()
    Dim theGalaxies As New List(Of Galaxy) From
        {
            New Galaxy With {.Name = "Tadpole", .MegaLightYears = 400},
            New Galaxy With {.Name = "Pinwheel", .MegaLightYears = 25},
            New Galaxy With {.Name = "Milky Way", .MegaLightYears = 0},
            New Galaxy With {.Name = "Andromeda", .MegaLightYears = 3}
        }

    For Each theGalaxy In theGalaxies
        With theGalaxy
            Console.WriteLine(.Name & "  " & .MegaLightYears)
        End With
    Next

    ' Output:
    '  Tadpole  400
    '  Pinwheel  25
    '  Milky Way  0
    '  Andromeda  3
End Sub

Public Class Galaxy
    Public Property Name As String
    Public Property MegaLightYears As Integer
End Class

集合的種類

.NET Framework 會提供很多常見的集合。各個類型的集合都是針對特定用途來設計。

下列集合類別的群組將在本節介紹：

System.Collections.Generic 類別
System.Collections.Concurrent 類別
System.Collections 類別
Visual Basic Collection 類別

System.Collections.Generic 類別

藉由使用 System.Collections.Generic 命名空間的其中一個類別，您可以建立泛型集合。當集合中每個項目的資料類型相同時，泛型集合就相當有用。泛型集合會透過只允許加入所需資料類型的方式，強制使用強式類型。

下表列出 System.Collections.Generic 命名空間的一些常用類別：

類別	描述
Dictionary<TKey,TValue>	表示根據索引鍵所整理的索引鍵/值組集合。
List<T>	表示可以依照索引存取的物件清單。提供搜尋、排序和修改清單的方法。
Queue<T>	表示物件的先進先出 (FIFO) 集合。
SortedList<TKey,TValue>	代表根據關聯的 IComparer<T> 實作，依索引鍵所排序的索引鍵/值組集合。
Stack<T>	表示物件的後進先出 (LIFO) 集合。

如需其他資訊，請參閱常用的集合類型、選取集合類別和 System.Collections.Generic。

System.Collections.Concurrent 類別

在 .NET Framework 4 或更新版本中，System.Collections.Concurrent 命名空間中的集合提供了有效率的安全執行緒作業，可從多個執行緒存取集合項目。

每當有多個執行緒同時存取集合時，應該使用 System.Collections.Concurrent 命名空間中的類別來代替 System.Collections.Generic 和 System.Collections 命名空間中的對應類型。如需詳細資訊，請參閱安全執行緒集合和 System.Collections.Concurrent。

System.Collections.Concurrent 命名空間中包含一些類別，包括 BlockingCollection<T>、ConcurrentDictionary<TKey,TValue>、ConcurrentQueue<T> 和 ConcurrentStack<T>。

System.Collections 類別

System.Collections 命名空間中的類別不會將項目儲存為特別類型物件，而是會儲存為 Object 類型的物件。

可能的話，您應該使用 System.Collections.Generic 命名空間或 System.Collections.Concurrent 命名空間中的泛型集合，而非 System.Collections 命名空間中的傳統類型。

下表列出 System.Collections 命名空間的一些常用類別：

類別	描述
ArrayList	代表會視需要動態增加大小的物件陣列。
Hashtable	代表根據索引鍵的雜湊程式碼，所整理的索引鍵/值組集合。
Queue	表示物件的先進先出 (FIFO) 集合。
Stack	表示物件的後進先出 (LIFO) 集合。

System.Collections.Specialized 命名空間會提供特製化類型和強型別集合類別，例如只有字串的集合，以及連結串列和 Hybrid 字典。

Visual Basic Collection 類別

使用數值索引或 String 索引鍵，您就可以使用 Visual Basic Collection 類別來存取集合項目。不論是否指定索引鍵，您都可以在集合物件中加入項目。如果加入不具索引鍵的項目，則必須使用它的數值索引加以存取。

Visual Basic Collection 類別會將其所有項目儲存為類型 Object，因此可以加入屬於任何資料類型的項目。無法確定加入的資料類型皆適當無誤。

當您使用 Visual Basic Collection 類別時，集合中第一個項目的索引為 1。這與 .NET Framework 集合類別不同，後者的起始索引為 0。

可能的話，請盡量使用 System.Collections.Generic 或 System.Collections.Concurrent 命名空間中的泛型集合，而非 Visual Basic Collection 類別。

如需詳細資訊，請參閱Collection。

實作索引鍵/值組集合

Dictionary<TKey,TValue> 泛型集合可讓您使用每個項目的索引鍵來存取集合中的項目。加入字典中的每一個項目都是由值及其關聯索引鍵所組成。使用其索引鍵擷取值的速度非常快，因為 Dictionary 類別是實作為雜湊表。

下列範例會使用 For Each 陳述式建立 Dictionary 集合並逐一查看字典。

Private Sub IterateThroughDictionary()
    Dim elements As Dictionary(Of String, Element) = BuildDictionary()

    For Each kvp As KeyValuePair(Of String, Element) In elements
        Dim theElement As Element = kvp.Value

        Console.WriteLine("key: " & kvp.Key)
        With theElement
            Console.WriteLine("values: " & .Symbol & " " &
                .Name & " " & .AtomicNumber)
        End With
    Next
End Sub

Private Function BuildDictionary() As Dictionary(Of String, Element)
    Dim elements As New Dictionary(Of String, Element)

    AddToDictionary(elements, "K", "Potassium", 19)
    AddToDictionary(elements, "Ca", "Calcium", 20)
    AddToDictionary(elements, "Sc", "Scandium", 21)
    AddToDictionary(elements, "Ti", "Titanium", 22)

    Return elements
End Function

Private Sub AddToDictionary(ByVal elements As Dictionary(Of String, Element),
ByVal symbol As String, ByVal name As String, ByVal atomicNumber As Integer)
    Dim theElement As New Element

    theElement.Symbol = symbol
    theElement.Name = name
    theElement.AtomicNumber = atomicNumber

    elements.Add(Key:=theElement.Symbol, value:=theElement)
End Sub

Public Class Element
    Public Property Symbol As String
    Public Property Name As String
    Public Property AtomicNumber As Integer
End Class

若要改為使用集合初始設定式建置 Dictionary 集合，您可以使用下列方法取代 BuildDictionary 和 AddToDictionary 方法。

Private Function BuildDictionary2() As Dictionary(Of String, Element)
    Return New Dictionary(Of String, Element) From
        {
            {"K", New Element With
                {.Symbol = "K", .Name = "Potassium", .AtomicNumber = 19}},
            {"Ca", New Element With
                {.Symbol = "Ca", .Name = "Calcium", .AtomicNumber = 20}},
            {"Sc", New Element With
                {.Symbol = "Sc", .Name = "Scandium", .AtomicNumber = 21}},
            {"Ti", New Element With
                {.Symbol = "Ti", .Name = "Titanium", .AtomicNumber = 22}}
        }
End Function

下列範例會使用 ContainsKey 方法和 Dictionary 的 Item[] 屬性來依索引鍵快速尋找項目。藉由使用 Visual Basic 中的 elements(symbol) 程式碼，Item 屬性可讓您存取在 elements 集合中的項目。

Private Sub FindInDictionary(ByVal symbol As String)
    Dim elements As Dictionary(Of String, Element) = BuildDictionary()

    If elements.ContainsKey(symbol) = False Then
        Console.WriteLine(symbol & " not found")
    Else
        Dim theElement = elements(symbol)
        Console.WriteLine("found: " & theElement.Name)
    End If
End Sub

下列範例會使用 TryGetValue 方法依索引鍵來快速尋找項目。

Private Sub FindInDictionary2(ByVal symbol As String)
    Dim elements As Dictionary(Of String, Element) = BuildDictionary()

    Dim theElement As Element = Nothing
    If elements.TryGetValue(symbol, theElement) = False Then
        Console.WriteLine(symbol & " not found")
    Else
        Console.WriteLine("found: " & theElement.Name)
    End If
End Sub

使用 LINQ 存取集合

LINQ (Language-Integrated Query (LINQ)) 可用來存取集合。 LINQ 查詢提供篩選、排序和分組功能。如需詳細資訊，請參閱開始使用 Visual Basic 中的 LINQ。

下列範例會對泛型 List 執行 LINQ 查詢。 LINQ 查詢會傳回包含結果的不同集合。

Private Sub ShowLINQ()
    Dim elements As List(Of Element) = BuildList()

    ' LINQ Query.
    Dim subset = From theElement In elements
                  Where theElement.AtomicNumber < 22
                  Order By theElement.Name

    For Each theElement In subset
        Console.WriteLine(theElement.Name & " " & theElement.AtomicNumber)
    Next

    ' Output:
    '  Calcium 20
    '  Potassium 19
    '  Scandium 21
End Sub

Private Function BuildList() As List(Of Element)
    Return New List(Of Element) From
        {
            {New Element With
                {.Symbol = "K", .Name = "Potassium", .AtomicNumber = 19}},
            {New Element With
                {.Symbol = "Ca", .Name = "Calcium", .AtomicNumber = 20}},
            {New Element With
                {.Symbol = "Sc", .Name = "Scandium", .AtomicNumber = 21}},
            {New Element With
                {.Symbol = "Ti", .Name = "Titanium", .AtomicNumber = 22}}
        }
End Function

Public Class Element
    Public Property Symbol As String
    Public Property Name As String
    Public Property AtomicNumber As Integer
End Class

排序集合

下列範例說明排序集合的程序。此範例排序儲存在 List<T> 中的 Car 類別執行個體。 Car 類別實作 IComparable<T> 介面，而這個介面要求實作 CompareTo 方法。

每次對 CompareTo 方法的呼叫都會進行用於排序的單一比較。當目前物件和另一個物件比較時，在 CompareTo 方法中的使用者撰寫程式碼會傳回值。如果目前物件比另一個物件小則傳回的值小於零，如果目前物件比另一個物件大則傳回的值大於零，如果它們相等則傳回零。這可讓您以程式碼定義大於、小於、等於的準則。

在 ListCars 方法中，cars.Sort() 陳述式會排序清單。對 List<T> 之 Sort 方法的這個呼叫，會導致 CompareTo 方法對 List 的 Car 物件自動呼叫。

Public Sub ListCars()

    ' Create some new cars.
    Dim cars As New List(Of Car) From
    {
        New Car With {.Name = "car1", .Color = "blue", .Speed = 20},
        New Car With {.Name = "car2", .Color = "red", .Speed = 50},
        New Car With {.Name = "car3", .Color = "green", .Speed = 10},
        New Car With {.Name = "car4", .Color = "blue", .Speed = 50},
        New Car With {.Name = "car5", .Color = "blue", .Speed = 30},
        New Car With {.Name = "car6", .Color = "red", .Speed = 60},
        New Car With {.Name = "car7", .Color = "green", .Speed = 50}
    }

    ' Sort the cars by color alphabetically, and then by speed
    ' in descending order.
    cars.Sort()

    ' View all of the cars.
    For Each thisCar As Car In cars
        Console.Write(thisCar.Color.PadRight(5) & " ")
        Console.Write(thisCar.Speed.ToString & " ")
        Console.Write(thisCar.Name)
        Console.WriteLine()
    Next

    ' Output:
    '  blue  50 car4
    '  blue  30 car5
    '  blue  20 car1
    '  green 50 car7
    '  green 10 car3
    '  red   60 car6
    '  red   50 car2
End Sub

Public Class Car
    Implements IComparable(Of Car)

    Public Property Name As String
    Public Property Speed As Integer
    Public Property Color As String

    Public Function CompareTo(ByVal other As Car) As Integer _
        Implements System.IComparable(Of Car).CompareTo
        ' A call to this method makes a single comparison that is
        ' used for sorting.

        ' Determine the relative order of the objects being compared.
        ' Sort by color alphabetically, and then by speed in
        ' descending order.

        ' Compare the colors.
        Dim compare As Integer
        compare = String.Compare(Me.Color, other.Color, True)

        ' If the colors are the same, compare the speeds.
        If compare = 0 Then
            compare = Me.Speed.CompareTo(other.Speed)

            ' Use descending order for speed.
            compare = -compare
        End If

        Return compare
    End Function
End Class

定義自訂集合

您可以透過實作 IEnumerable<T> 或 IEnumerable 介面來定義集合。如需其他資訊，請參閱列舉集合。

雖然您可以定義自訂集合，但是使用包含在 .NET Framework 中的集合 (本主題稍早在集合的種類中所述) 通常會比較好。

下列範例會定義名為 AllColors 的自訂集合類別。這個類別實作 IEnumerable 介面，該介面要求實作 GetEnumerator 方法。

GetEnumerator 方法會傳回 ColorEnumerator 類別的執行個體。 ColorEnumerator 實作 IEnumerator 介面，而此介面會要求實作 Current 屬性、MoveNext 方法和 Reset 方法。

Public Sub ListColors()
    Dim colors As New AllColors()

    For Each theColor As Color In colors
        Console.Write(theColor.Name & " ")
    Next
    Console.WriteLine()
    ' Output: red blue green
End Sub

' Collection class.
Public Class AllColors
    Implements System.Collections.IEnumerable

    Private _colors() As Color =
    {
        New Color With {.Name = "red"},
        New Color With {.Name = "blue"},
        New Color With {.Name = "green"}
    }

    Public Function GetEnumerator() As System.Collections.IEnumerator _
        Implements System.Collections.IEnumerable.GetEnumerator

        Return New ColorEnumerator(_colors)

        ' Instead of creating a custom enumerator, you could
        ' use the GetEnumerator of the array.
        'Return _colors.GetEnumerator
    End Function

    ' Custom enumerator.
    Private Class ColorEnumerator
        Implements System.Collections.IEnumerator

        Private _colors() As Color
        Private _position As Integer = -1

        Public Sub New(ByVal colors() As Color)
            _colors = colors
        End Sub

        Public ReadOnly Property Current() As Object _
            Implements System.Collections.IEnumerator.Current
            Get
                Return _colors(_position)
            End Get
        End Property

        Public Function MoveNext() As Boolean _
            Implements System.Collections.IEnumerator.MoveNext
            _position += 1
            Return (_position < _colors.Length)
        End Function

        Public Sub Reset() Implements System.Collections.IEnumerator.Reset
            _position = -1
        End Sub
    End Class
End Class

' Element class.
Public Class Color
    Public Property Name As String
End Class

迭代器

「迭代器」是用來在集合上執行自訂反覆項目。迭代器可以是方法或 get 存取子。迭代器會使用 Yield 陳述式，一次一個地傳回集合中的每個項目。

您可以使用 For Each…Next 陳述式來呼叫迭代器。 For Each 迴圈的每個反覆項目都會呼叫迭代器。在迭代器中到達 Yield 陳述式時，會傳回運算式，並保留程式碼中的目前位置。下一次呼叫迭代器時，便會從這個位置重新開始執行。

如需詳細資訊，請參閱迭代器 (Visual Basic)。

下列範例使用了 iterator 方法。 Iterator 方法具有 For…Next 迴圈內的 Yield 陳述式。在 ListEvenNumbers 方法中，For Each 陳述式主體的每個反覆項目都會建立對 Iterator 方法的呼叫，這個方法將繼續執行下一個 Yield 陳述式。

Public Sub ListEvenNumbers()
    For Each number As Integer In EvenSequence(5, 18)
        Console.Write(number & " ")
    Next
    Console.WriteLine()
    ' Output: 6 8 10 12 14 16 18
End Sub

Private Iterator Function EvenSequence(
ByVal firstNumber As Integer, ByVal lastNumber As Integer) _
As IEnumerable(Of Integer)

' Yield even numbers in the range.
    For number = firstNumber To lastNumber
        If number Mod 2 = 0 Then
            Yield number
        End If
    Next
End Function