Condividi tramite

Iteratori (C# e Visual Basic)

  • Articolo

E' possibile utilizzare un iteratore per passare in rassegna raccolte come elenchi e matrici.

Un metodo iteratore o una funzione di accesso get eseguono un'iterazione personalizzata in una raccolta.Un metodo iteratore utilizza l'istruzione Yield (Visual Basic) o yield return (C#) per restituire ogni elemento, uno alla volta.Quando un'istruzione yield return o Yield viene raggiunta, viene memorizzata la posizione corrente nel codice.Alla successiva chiamata della funzione iteratore, l'esecuzione verrà riavviata a partire da quella posizione.

Utilizzare un iteratore dal codice client utilizzando un'istruzione di For Each… next (Visual Basic) o di l'istruzione foreach (c) o tramite una query LINQ.

Nell'esempio seguente, la prima iterazione del ciclo di foreach o di For Each comporta l'esecuzione di proseguire nel metodo iteratore di SomeNumbers fino alla prima Yield o l'istruzione di yield return viene raggiunto.Questa iterazione restituisce un valore 3 e la posizione corrente nel metodo di iteratore vengono mantenute.Nell'iterazione successiva del ciclo, l'esecuzione nel metodo di iteratore continua da dove era stato interrotto, ancora arrestando quando raggiunge un'istruzione di yield return o di Yield.Questa iterazione restituisce un valore 5 e la posizione corrente nel metodo di iteratore viene mantenuta di nuovo.Il ciclo viene terminato alla fine del metodo di iteratore è soddisfatta.

Sub Main()
    For Each number As Integer In SomeNumbers()
        Console.Write(number & " ")
    Next
    ' Output: 3 5 8
    Console.ReadKey()
End Sub

Private Iterator Function SomeNumbers() As System.Collections.IEnumerable
    Yield 3
    Yield 5
    Yield 8
End Function

static void Main()
{
    foreach (int number in SomeNumbers())
    {
        Console.Write(number.ToString() + " ");
    }
    // Output: 3 5 8
    Console.ReadKey();
}

public static System.Collections.IEnumerable SomeNumbers()
{
    yield return 3;
    yield return 5;
    yield return 8;
}

Il tipo restituito de un metodo iteratore o da una funzione di accesso get può essere IEnumerable, IEnumerable<T>, IEnumerator, o IEnumerator<T>.

È possibile utilizzare un'istruzione Return o Exit Function (Visual Basic) o un'istruzione yield break (C#) per terminare l'iterazione.

Una dichiarazione di funzione iteratore Visual Basic o della funzione di accesso get include un modificatore iteratore.

Gli iteratori sono stati introdotti in C# in Visual Studio 2005e sono stati introdotti in Visual Basic in Visual Studio 2012.

In questo argomento

  • Iteratore semplice

  • Creazione di una classe Collection

  • Blocco try in Visual Basic

  • Metodi anonimi in Visual Basic

  • Utilizzando gli iteratori con un elenco generico

  • Informazioni di sintassi

  • Implementazione tecnica

  • Utilizzo degli iteratori

Iteratore semplice

L'esempio seguente contiene una sola istruzione Yield o yield return all'interno di un ciclo For… Next (Visual Basic) o for (C#).All'interno del Main, ogni iterazione dell'istruzione For Each o dell'istruzione foreach porta ad una chiamata alla funzione iteratore, che procede con l'istruzione Yield o yield return successiva.

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

Private Iterator Function EvenSequence(
ByVal firstNumber As Integer, ByVal lastNumber As Integer) _
As System.Collections.Generic.IEnumerable(Of Integer)

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

static void Main()
{
    foreach (int number in EvenSequence(5, 18))
    {
        Console.Write(number.ToString() + " ");
    }
    // Output: 6 8 10 12 14 16 18
    Console.ReadKey();
}

public static System.Collections.Generic.IEnumerable<int>
    EvenSequence(int firstNumber, int lastNumber)
{
    // Yield even numbers in the range.
    for (int number = firstNumber; number <= lastNumber; number++)
    {
        if (number % 2 == 0)
        {
            yield return number;
        }
    }
}

Creazione di una classe Collection

[!NOTA]

Gli esempi rimanenti nel topic, includono le istruzioni Imports (Visual Basic) o utilizzano le direttive (C#) per System.Collections e i namespace System.Collections.Generic.

Nell'esempio seguente, la classe DaysOfTheWeek implementa l'interfaccia IEnumerable, che richiede un metodo GetEnumerator.Il compilatore chiama in modo implicito il metodo GetEnumerator, che restituisce IEnumerator.

Il metodo GetEnumerator restituisce ogni stringa, una alla volta, utilizzando l'istruzione yield return o Yield.Nel codice Visual Basic, c'è un modificatore Iterator nella dichiarazione della funzione.

Sub Main()
    Dim days As New DaysOfTheWeek()
    For Each day As String In days
        Console.Write(day & " ")
    Next
    ' Output: Sun Mon Tue Wed Thu Fri Sat
    Console.ReadKey()
End Sub

Private Class DaysOfTheWeek
    Implements IEnumerable

    Public days =
        New String() {"Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat"}

    Public Iterator Function GetEnumerator() As IEnumerator _
        Implements IEnumerable.GetEnumerator

        ' Yield each day of the week.
        For i As Integer = 0 To days.Length - 1
            Yield days(i)
        Next
    End Function
End Class

static void Main()
{
    DaysOfTheWeek days = new DaysOfTheWeek();

    foreach (string day in days)
    {
        Console.Write(day + " ");
    }
    // Output: Sun Mon Tue Wed Thu Fri Sat
    Console.ReadKey();
}

public class DaysOfTheWeek : IEnumerable
{
    private string[] days = { "Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat" };

    public IEnumerator GetEnumerator()
    {
        for (int index = 0; index < days.Length; index++)
        {
            // Yield each day of the week.
            yield return days[index];
        }
    }
}

L'esempio seguente consente di creare una classe Zoo che contiene una raccolta di animali.

L'istruzione foreach o For Each che fa riferimento all'istanza della classe (theZoo) chiama in modo implicito il metodo GetEnumerator.Le istruzioni foreach o For Each che fanno riferimento alle proprietà Mammals e Birds utilizzano il metodo iteratore denominato AnimalsForType.

Sub Main()
    Dim theZoo As New Zoo()

    theZoo.AddMammal("Whale")
    theZoo.AddMammal("Rhinoceros")
    theZoo.AddBird("Penguin")
    theZoo.AddBird("Warbler")

    For Each name As String In theZoo
        Console.Write(name & " ")
    Next
    Console.WriteLine()
    ' Output: Whale Rhinoceros Penguin Warbler

    For Each name As String In theZoo.Birds
        Console.Write(name & " ")
    Next
    Console.WriteLine()
    ' Output: Penguin Warbler

    For Each name As String In theZoo.Mammals
        Console.Write(name & " ")
    Next
    Console.WriteLine()
    ' Output: Whale Rhinoceros

    Console.ReadKey()
End Sub

Public Class Zoo
    Implements IEnumerable

    ' Private members.
    Private animals As New List(Of Animal)

    ' Public methods.
    Public Sub AddMammal(ByVal name As String)
        animals.Add(New Animal With {.Name = name, .Type = Animal.TypeEnum.Mammal})
    End Sub

    Public Sub AddBird(ByVal name As String)
        animals.Add(New Animal With {.Name = name, .Type = Animal.TypeEnum.Bird})
    End Sub

    Public Iterator Function GetEnumerator() As IEnumerator _
        Implements IEnumerable.GetEnumerator

        For Each theAnimal As Animal In animals
            Yield theAnimal.Name
        Next
    End Function

    ' Public members.
    Public ReadOnly Property Mammals As IEnumerable
        Get
            Return AnimalsForType(Animal.TypeEnum.Mammal)
        End Get
    End Property

    Public ReadOnly Property Birds As IEnumerable
        Get
            Return AnimalsForType(Animal.TypeEnum.Bird)
        End Get
    End Property

    ' Private methods.
    Private Iterator Function AnimalsForType( _
    ByVal type As Animal.TypeEnum) As IEnumerable
        For Each theAnimal As Animal In animals
            If (theAnimal.Type = type) Then
                Yield theAnimal.Name
            End If
        Next
    End Function

    ' Private class.
    Private Class Animal
        Public Enum TypeEnum
            Bird
            Mammal
        End Enum

        Public Property Name As String
        Public Property Type As TypeEnum
    End Class
End Class

static void Main()
{
    Zoo theZoo = new Zoo();

    theZoo.AddMammal("Whale");
    theZoo.AddMammal("Rhinoceros");
    theZoo.AddBird("Penguin");
    theZoo.AddBird("Warbler");

    foreach (string name in theZoo)
    {
        Console.Write(name + " ");
    }
    Console.WriteLine();
    // Output: Whale Rhinoceros Penguin Warbler

    foreach (string name in theZoo.Birds)
    {
        Console.Write(name + " ");
    }
    Console.WriteLine();
    // Output: Penguin Warbler

    foreach (string name in theZoo.Mammals)
    {
        Console.Write(name + " ");
    }
    Console.WriteLine();
    // Output: Whale Rhinoceros

    Console.ReadKey();
}

public class Zoo : IEnumerable
{
    // Private members.
    private List<Animal> animals = new List<Animal>();

    // Public methods.
    public void AddMammal(string name)
    {
        animals.Add(new Animal { Name = name, Type = Animal.TypeEnum.Mammal });
    }

    public void AddBird(string name)
    {
        animals.Add(new Animal { Name = name, Type = Animal.TypeEnum.Bird });
    }

    public IEnumerator GetEnumerator()
    {
        foreach (Animal theAnimal in animals)
        {
            yield return theAnimal.Name;
        }
    }

    // Public members.
    public IEnumerable Mammals
    {
        get { return AnimalsForType(Animal.TypeEnum.Mammal); }
    }

    public IEnumerable Birds
    {
        get { return AnimalsForType(Animal.TypeEnum.Bird); }
    }

    // Private methods.
    private IEnumerable AnimalsForType(Animal.TypeEnum type)
    {
        foreach (Animal theAnimal in animals)
        {
            if (theAnimal.Type == type)
            {
                yield return theAnimal.Name;
            }
        }
    }

    // Private class.
    private class Animal
    {
        public enum TypeEnum { Bird, Mammal }

        public string Name { get; set; }
        public TypeEnum Type { get; set; }
    }
}

Blocco try in Visual Basic

Visual Basic consente l'utilizzo di un'istruzione Yield nel blocco Try di un Istruzione Try...Catch...Finally (Visual Basic).Un blocco Try con un'istruzione Yield può contenere blocchi Catch e può presentare un blocco Finally.

Nota di C#Nota di C#

In C# è possibile utilizzare un'istruzione yield return nel blocco try di un'istruzione try-finally.Un blocco try con un'istruzione yield return non può contenere blocchi catch.

Nell'esempio Visual Basic sono inclusi Try, Catche i blocchi Finally in un iteratore esecuzione.Il blocco Finally nella funzione iteratore viene eseguito prima che l'iterazione For Each venga completata.

Sub Main()
    For Each number As Integer In Test()
        Console.WriteLine(number)
    Next
    Console.WriteLine("For Each is done.")

    ' Output:
    '  3
    '  4
    '  Something happened. Yields are done.
    '  Finally is called.
    '  For Each is done.
    Console.ReadKey()
End Sub

Private Iterator Function Test() As IEnumerable(Of Integer)
    Try
        Yield 3
        Yield 4
        Throw New Exception("Something happened. Yields are done.")
        Yield 5
        Yield 6
    Catch ex As Exception
        Console.WriteLine(ex.Message)
    Finally
        Console.WriteLine("Finally is called.")
    End Try
End Function

Un'istruzione Yield non può trovarsi all'interno di un blocco Catch o di un blocco Finally.

Se il corpo For Each (anziché il metodo iteratori) genera un'eccezione, non viene eseguito un blocco Catch nella funzione iteratore, ma viene invece eseguito un blocco Finally nella funzione iteratore.Un blocco Catch in una funzione iteratore rileva solo le eccezioni che si verificano nella funzione iteratore.

Metodi anonimi in Visual Basic

In Visual Basic (ma non in C#), una funzione anonima può essere una funzione iteratore.Questa condizione è illustrata nell'esempio che segue.

Dim iterateSequence = Iterator Function() _
                      As IEnumerable(Of Integer)
                          Yield 1
                          Yield 2
                      End Function

For Each number As Integer In iterateSequence()
    Console.Write(number & " ")
Next
' Output: 1 2
Console.ReadKey()

Nell'esempio Visual Basic c'è un metodo non iteratore che convalida gli argomenti.Il metodo restituisce il risultato di un iteratore anonimo che descrive gli elementi della raccolta.

Sub Main()
    For Each number As Integer In GetSequence(5, 10)
        Console.Write(number & " ")
    Next
    ' Output: 5 6 7 8 9 10
    Console.ReadKey()
End Sub

Public Function GetSequence(ByVal low As Integer, ByVal high As Integer) _
As IEnumerable
    ' Validate the arguments.
    If low < 1 Then
        Throw New ArgumentException("low is too low")
    End If
    If high > 140 Then
        Throw New ArgumentException("high is too high")
    End If

    ' Return an anonymous iterator function.
    Dim iterateSequence = Iterator Function() As IEnumerable
                              For index = low To high
                                  Yield index
                              Next
                          End Function
    Return iterateSequence()
End Function

Se la convalida avviene invece nella funzione iteratore, la convalida non può essere eseguita fino all'inizio della prima iterazione del corpo For Each.

Utilizzando gli iteratori con un elenco generico

Nell'esempio seguente la classe generica Stack(Of T) implementa l'interfaccia IEnumerable<T>.Il metodo Push assegna valori in un array di tipo T.Il metodo GetEnumerator restituisce i valori dell'array mediante l'istruzione yield return o Yield.

Oltre al metodo generico GetEnumerator, deve essere implementato il metodo non generico GetEnumerator.Questo perché IEnumerable<T> eredita da IEnumerable.L'implementazione non generica rinvia all'implementazione generica.

L'esempio utilizza gli iteratori denominati per supportare le diverse modalità di ripetizione tramite la stessa raccolta dati.Questi iteratori con nome rappresentano le proprietà BottomToTop e TopToBottom e il metodo TopN.

La proprietà BottomToTop utilizza un iteratore in una funzione di accesso get.Nel codice Visual Basic, la dichiarazione delle proprietà include la chiave Iterator.

Sub Main()
    Dim theStack As New Stack(Of Integer)

    ' Add items to the stack.
    For number As Integer = 0 To 9
        theStack.Push(number)
    Next

    ' Retrieve items from the stack.
    ' For Each is allowed because theStack implements
    ' IEnumerable(Of Integer).
    For Each number As Integer In theStack
        Console.Write("{0} ", number)
    Next
    Console.WriteLine()
    ' Output: 9 8 7 6 5 4 3 2 1 0

    ' For Each is allowed, because theStack.TopToBottom
    ' returns IEnumerable(Of Integer).
    For Each number As Integer In theStack.TopToBottom
        Console.Write("{0} ", number)
    Next
    Console.WriteLine()
    ' Output: 9 8 7 6 5 4 3 2 1 0

    For Each number As Integer In theStack.BottomToTop
        Console.Write("{0} ", number)
    Next
    Console.WriteLine()
    ' Output: 0 1 2 3 4 5 6 7 8 9 

    For Each number As Integer In theStack.TopN(7)
        Console.Write("{0} ", number)
    Next
    Console.WriteLine()
    ' Output: 9 8 7 6 5 4 3

    Console.ReadKey()
End Sub

Public Class Stack(Of T)
    Implements IEnumerable(Of T)

    Private values As T() = New T(99) {}
    Private top As Integer = 0

    Public Sub Push(ByVal t As T)
        values(top) = t
        top = top + 1
    End Sub

    Public Function Pop() As T
        top = top - 1
        Return values(top)
    End Function

    ' This function implements the GetEnumerator method. It allows
    ' an instance of the class to be used in a For Each statement.
    Public Iterator Function GetEnumerator() As IEnumerator(Of T) _
        Implements IEnumerable(Of T).GetEnumerator

        For index As Integer = top - 1 To 0 Step -1
            Yield values(index)
        Next
    End Function

    Public Iterator Function GetEnumerator1() As IEnumerator _
        Implements IEnumerable.GetEnumerator

        Yield GetEnumerator()
    End Function

    Public ReadOnly Property TopToBottom() As IEnumerable(Of T)
        Get
            Return Me
        End Get
    End Property

    Public ReadOnly Iterator Property BottomToTop As IEnumerable(Of T)
        Get
            For index As Integer = 0 To top - 1
                Yield values(index)
            Next
        End Get
    End Property

    Public Iterator Function TopN(ByVal itemsFromTop As Integer) _
        As IEnumerable(Of T)

        ' Return less than itemsFromTop if necessary.
        Dim startIndex As Integer =
            If(itemsFromTop >= top, 0, top - itemsFromTop)

        For index As Integer = top - 1 To startIndex Step -1
            Yield values(index)
        Next
    End Function
End Class

static void Main()
{
    Stack<int> theStack = new Stack<int>();

    //  Add items to the stack.
    for (int number = 0; number <= 9; number++)
    {
        theStack.Push(number);
    }

    // Retrieve items from the stack.
    // foreach is allowed because theStack implements
    // IEnumerable<int>.
    foreach (int number in theStack)
    {
        Console.Write("{0} ", number);
    }
    Console.WriteLine();
    // Output: 9 8 7 6 5 4 3 2 1 0

    // foreach is allowed, because theStack.TopToBottom
    // returns IEnumerable(Of Integer).
    foreach (int number in theStack.TopToBottom)
    {
        Console.Write("{0} ", number);
    }
    Console.WriteLine();
    // Output: 9 8 7 6 5 4 3 2 1 0

    foreach (int number in theStack.BottomToTop)
    {
        Console.Write("{0} ", number);
    }
    Console.WriteLine();
    // Output: 0 1 2 3 4 5 6 7 8 9

    foreach (int number in theStack.TopN(7))
    {
        Console.Write("{0} ", number);
    }
    Console.WriteLine();
    // Output: 9 8 7 6 5 4 3

    Console.ReadKey();
}

public class Stack<T> : IEnumerable<T>
{
    private T[] values = new T[100];
    private int top = 0;

    public void Push(T t)
    {
        values[top] = t;
        top++;
    }
    public T Pop()
    {
        top--;
        return values[top];
    }

    // This method implements the GetEnumerator method. It allows
    // an instance of the class to be used in a foreach statement.
    public IEnumerator<T> GetEnumerator()
    {
        for (int index = top - 1; index >= 0; index--)
        {
            yield return values[index];
        }
    }

    IEnumerator IEnumerable.GetEnumerator()
    {
        return GetEnumerator();
    }

    public IEnumerable<T> TopToBottom
    {
        get { return this; }
    }

    public IEnumerable<T> BottomToTop
    {
        get
        {
            for (int index = 0; index <= top - 1; index++)
            {
                yield return values[index];
            }
        }
    }

    public IEnumerable<T> TopN(int itemsFromTop)
    {
        // Return less than itemsFromTop if necessary.
        int startIndex = itemsFromTop >= top ? 0 : top - itemsFromTop;

        for (int index = top - 1; index >= startIndex; index--)
        {
            yield return values[index];
        }
    }

}

Informazioni di sintassi

Un iteratore può verificarsi in un metodo o funzione di accesso get.Un iteratore non può verificarsi in un evento, in un costruttore di istanza, in un costruttore statico, o in un distruttore statico.

Una conversione implicita deve esistere dal tipo di espressione in un'istruzione Yield (Visual Basic) o yield return (C#) al tipo restituito dell'iteratore.

In Visual Basic, un metodo iteratore non può avere alcun parametro ByRef.In C#, un metodo iteratore non può avere alcun parametro out o ref.

In Visual Basic, "yield" non è una parola riservata e ha un significato speciale solo quando viene utilizzato in un metodo Iterator o in una funzione di accesso get.In C#, "yield" non è una parola riservata e ha un significato speciale solo quando viene utilizzato prima di una parola chiave break o return.

Implementazione tecnica

Sebbene un iteratore venga scritto come metodo, il compilatore lo converte in una classe annidata che, in pratica, è una macchina a stati.Questa classe tiene traccia della posizione dell'iteratore purché il ciclo For Each...Next o foreach nel codice client sia continuo.

Per verificare le operazioni eseguite dal compilatore, è possibile utilizzare lo strumento Ildsam.exe per visualizzare il codice Microsoft Intermediate Language generato per un metodo dell'iteratore.

Quando si crea un iteratore per la classe o la struttura, non è necessario implementare l'intera interfaccia IEnumerator.Quando il compilatore rileva l'iteratore, genera automaticamente i metodi Current, MoveNext, e i metodi Dispose dell'interfaccia IEnumerator o IEnumerator<T>.

In ogni iterazione successiva del ciclo foreach o For Each…Next (o la chiamata diretta a IEnumerator.MoveNext), in cui riprende seguenti del corpo del codice iteratori dopo Yield o l'istruzione precedente yield return.Continua quindi alla successiva istruzione Yield o yield return fino a raggiungere la fine del corpo di iteratore, o fino a che non viene rilevata un'istruzione Return o Exit Function (Visual Basic) o all'istruzione yield break (C#).

Gli iteratori non supportano il metodo IEnumerator.Reset.Per reiterare dall'inizio è necessario ottenere un nuovo iteratore.

Per ulteriori informazioni, vedere Specifica del linguaggio Visual Basic o Specifiche del linguaggio C#.

Utilizzo degli iteratori

Gli iteratori consentono di gestire la semplicità di un ciclo For Each quando è necessario utilizzare il codice complesso per popolare una sequenza dell'elenco.Questo può essere utile se si vuole:

  • Modificare la sequenza dell'elenco dopo la prima iterazione del ciclo For Each.

  • Evitare completamente il caricamento di un elenco prima della prima iterazione di un ciclo For Each.Un esempio è una raccolta di paging per caricare una serie di righe della tabella.Un altro esempio è il metodo EnumerateFiles, che implementa gli iteratori nel framework .NET.

  • Incapsulare l'elenco delle compilazioni nell'iteratore.Nel metodo iteratore, è possibile compilare l'elenco e quindi esaminare ogni risultato in un ciclo.

Nei seguenti blog di C# si trovano ulteriori informazioni sull'utilizzo degli iteratori.

Vedere anche

Riferimenti

Istruzione For Each...Next (Visual Basic)

foreach, in (Riferimenti per C#)

Istruzione Yield (Visual Basic)

yield (Riferimenti per C#)

Iteratore (Visual Basic)

Utilizzo di foreach con matrici (Guida per programmatori C#)

Generics (Guida per programmatori C#)

System.Collections.Generic

IEnumerable<T>