LINQ基礎 - Iterator(疊代器模式) | I am City Man - 點部落

2020-07-12

LINQ基礎 - Iterator(疊代器模式)

13627
0
LinQ筆記
2020-07-19

原始文章將記錄於此
https://github.com/s0920832252/LinQ-Note

定義

提供一種方法可以讓使用者能夠走訪集合對象中的各個元素 , 但又不必暴露該對象的內部實現.

單一設計原則(SRP) - 一個類別最好只負責一個責任 , 只有一個修改它的原因.

我們固然能夠在集合對象中實作走訪的操作 , 但這樣集合對象可能就承擔過多的責任(?). 也就違反設計模式中的單一設計原則(SRP) , 因此我們要盡可能的分離職責 , 讓不同的類別承擔不同的責任. 而 Iterator 模式在 foreach 實作上 , 簡單來說 , 就是將走訪這個動作抽離出來給另一個類別負責.

結構

Iterator : 負責定義完成一個走訪的動作需要實作哪些方法的介面
- 通常有 MoveNext、CurrentItem、Fisrt、IsDone、Reset 之類的方法或屬性讓子類實作
Aggregate : 負責定義如何調用實作 Iterator 的物件來負責走訪
- 可以想成是僅負責向外宣告自身是否具有走訪能力
- 或者可以想成是將 Iterator 封裝給外界使用的介面
ConcreteAggregate
- 實作 Aggregate.
ConcreteIteraror
- 實作 Iterator.

範例 - 走訪整數

例如 : 517 , 會依序走訪 5 然後 1 然後7

Aggregate

public interface IAggregate
{
    INtegerIterator GetIterator();
}

ConcreteAggregate

public class Integers : IAggregate
{
    private readonly int _integers;
    public Integers(int integers)
    {
        _integers = integers;
    }
    public INtegerIterator GetIterator() => new IntIterator(_integers);
}

Iterator

public interface INtegerIterator
{
    object Current { get; }
    bool MoveNext();
    void Reset();
}

ConcreteIteraror

public class IntIterator : INtegerIterator
{
    private readonly int _integers;
    private readonly int _maxDigit;
    private int _currentFilter;
    public object Current => (_integers / _currentFilter) % 10;
    public IntIterator(int integers)
    {
        _integers = integers;
        _maxDigit = (int)Math.Log10(integers) + 1;
        Reset();
    }

    public void Reset() => _currentFilter = (int)Math.Pow(10, _maxDigit);

    public bool MoveNext()
    {
        _currentFilter /= 10;
        bool hasNext = _currentFilter > 0;
        if (!hasNext) Reset();
        return hasNext;
    }
}

Client

static void Main(string[] args)
{
     Integers integers = new Integers(543838626);
     var iterator = integers.GetIterator();
     while (iterator.MoveNext())
     {
          Console.Write($"{ iterator.Current} ");
     }
     Console.WriteLine();
     while (iterator.MoveNext())
     {
          Console.Write($"{ iterator.Current} ");
     }
     Console.ReadKey();
 }

輸出結果

.Net 的 Iterator

在 .Net 的 System.Collections 命名空間內 , 早就具有 Iterator 模式的實現 . 也就是 Aggregate 以及 Iterator 這兩個介面的存在.

IEnumerator(扮演Iterator的角色) - 定義如何走訪

public interface IEnumerator
{
     object Current { get; }
     bool MoveNext();
     void Reset();
}

IEnumerable(扮演Aggregate的角色) - 若需要資料集合具有走訪功能 , 就必須實現此介面.
```
public interface IEnumerable
{
    IEumerator GetEnumerator();
}
```
C# 大部分的資料結構都有實作 IEnumerable 介面 , 像是 List

所以上述範例 - 走訪整數 , 更改下列動作後 , 就可以使用foreach關鍵字.

public class IntIterator : IEnumerator

public class Integers : IEnumerable

public IEnumerator GetEnumerator() => new IntIterator(_integers);

測試端程式以及輸出結果(我用了foreach)

public class Integers : IEnumerable
{
    private readonly int _integers;
    public Integers(int integers)
    {
        _integers = integers;
    }

    public IEnumerator GetEnumerator() => new IntIterator(_integers);
}

public class IntIterator : IEnumerator
{
    private readonly int _integers;
    private readonly int _maxDigit;
    private int _currentFilter;
    public object Current => (_integers / _currentFilter) % 10;
    public IntIterator(int integers)
    {
        _integers = integers;
        _maxDigit = (int)Math.Log10(integers) + 1;
        Reset();
    }

    public void Reset() => _currentFilter = (int)Math.Pow(10, _maxDigit);

    public bool MoveNext()
    {
        _currentFilter /= 10;
        bool hasNext = _currentFilter > 0;
        if (!hasNext) Reset();
        return hasNext;
    }
}

static void Main(string[] args)
{
    Integers integers = new Integers(543838626);
    var iterator = integers.GetEnumerator();
    while (iterator.MoveNext())
    {
        Console.Write($"{ iterator.Current} ");
    }
    Console.WriteLine();
    foreach (var item in integers)
    {
        Console.Write($"{ item } ");
    }
    Console.ReadKey();
}

輸出結果

總結

Iterator 模式使得走訪一個資料集合的時候 , 無須暴露它的內部細節.
Iterator 模式為走訪不同的資料結構提供一個統一的接口. 因此同樣的演算法可在不同的資料結構上操作.
Iterator 模式在走訪的時候更改 Iterator 所在的資料會拋出例外 , 所以 foreach 只能用在走訪 , 而不能在走訪的時候同時修改資料集合內的元素.
Iterator 模式是一個抽象 Iterator 類來分離集合的走訪行為 , 為了可以做到不暴露集合內部結構同時又可讓外部使用者走訪集合內部的資料.