.NET设计模式(18):迭代器模式(Iterator Pattern)

概述

在面向对象的软件设计中,我们经常会遇到一类集合对象,这类集合对象的内部结构可能有着各种各样的实现,但是归结起来,无非有两点是需要我们去关心的:一是集合内部的数据存储结构,二是遍历集合内部的数据。面向对象设计原则中有一条是类的单一职责原则,所以我们要尽可能的去分解这些职责,用不同的类去承担不同的职责。Iterator模式就是分离了集合对象的遍历行为,抽象出一个迭代器类来负责,这样既可以做到不暴露集合的内部结构,又可让外部代码透明的访问集合内部的数据。

意图

提供一种方法顺序访问一个聚合对象中各个元素, 而又不需暴露该对象的内部表示。[GOF 《设计模式》]

结构图

Iterator模式结构图如下:

1  Iterator模式结构图

生活中的例子

迭代器提供一种方法顺序访问一个集合对象中各个元素,而又不需要暴露该对象的内部表示。在早期的电视机中,一个拨盘用来改变频道。当改变频道时,需要手工转动拨盘移过每一个频道,而不论这个频道是否有信号。现在的电视机,使用[后一个][前一个]按钮。当按下[后一个]按钮时,将切换到下一个预置的频道。想象一下在陌生的城市中的旅店中看电视。当改变频道时,重要的不是几频道,而是节目内容。如果对一个频道的节目不感兴趣,那么可以换下一个频道,而不需要知道它是几频道。

2  使用选频器做例子的Iterator模式对象图

Iterator模式解说

在面向对象的软件设计中,我们经常会遇到一类集合对象,这类集合对象的内部结构可能有着各种各样的实现,但是归结起来,无非有两点是需要我们去关心的:一是集合内部的数据存储结构,二是遍历集合内部的数据。面向对象设计原则中有一条是类的单一职责原则,所以我们要尽可能的去分解这些职责,用不同的类去承担不同的职责。Iterator模式就是分离了集合对象的遍历行为,抽象出一个迭代器类来负责,这样既可以做到不暴露集合的内部结构,又可让外部代码透明的访问集合内部的数据。下面看一个简单的示意性例子,类结构图如下:

3 示例代码结构图

首先有一个抽象的聚集,所谓的聚集就是就是数据的集合,可以循环去访问它。它只有一个方法GetIterator()让子类去实现,用来获得一个迭代器对象。

/// <summary>

/// 抽象聚集

/// </summary>


public interface IList

{
    IIterator GetIterator();
}

抽象的迭代器,它是用来访问聚集的类,封装了一些方法,用来把聚集中的数据按顺序读取出来。通常会有MoveNext()CurrentItem()Fisrt()Next()等几个方法让子类去实现。

/// <summary>

/// 抽象迭代器

/// </summary>


public interface IIterator
{
    
bool MoveNext();

    Object CurrentItem();

    
void First();

    
void Next();
}

具体的聚集,它实现了抽象聚集中的唯一的方法,同时在里面保存了一组数据,这里我们加上Length属性和GetElement()方法是为了便于访问聚集中的数据。

/// <summary>

/// 具体聚集

/// </summary>


public class ConcreteList : IList
{
    
int[] list;

    
public ConcreteList()

    
{
        list 
= new int[] 1,2,3,4,5};
    }


    
public IIterator GetIterator()

    
{
        
return new ConcreteIterator(this);
    }


    
public int Length

    
{
        
get return list.Length; }
    }


    
public int GetElement(int index)

    
{
        
return list[index];
    }

}

具体迭代器,实现了抽象迭代器中的四个方法,在它的构造函数中需要接受一个具体聚集类型的参数,在这里面我们可以根据实际的情况去编写不同的迭代方式。

/// <summary>

/// 具体迭代器

/// </summary>


public class ConcreteIterator : IIterator

{
    
private ConcreteList list;

    
private int index;

    
public ConcreteIterator(ConcreteList list)

    
{
        
this.list = list;

        index 
= 0;
    }


    
public bool MoveNext()

    
{
        
if (index < list.Length)

            
return true;

        
else

            
return false;
    }


    
public Object CurrentItem()

    
{
        
return list.GetElement(index) ;
    }


    
public void First()

    
{
        index 
= 0;
    }


    
public void Next()

    
{
        
if (index < list.Length)

        
{
            index
++;
        }

    }

}

简单的客户端程序调用:

/// <summary>

/// 客户端程序

/// </summary>


class Program

{
    
static void Main(string[] args)

    
{
        IIterator iterator;

        IList list 
= new ConcreteList();

        iterator 
= list.GetIterator();

        
while (iterator.MoveNext())

        
{
            
int i = (int)iterator.CurrentItem();
            Console.WriteLine(i.ToString());

            iterator.Next();
        }


        Console.Read();

    }


}

一个简单的迭代器示例就结束了,这里我们并没有利用任何的.NET特性,在C#中,实现Iterator模式已经不需要这么麻烦了,已经C#语言本身就有一些特定的实现,下面会说到。

.NET中的Iterator模式

.NET下实现Iterator模式,对于聚集接口和迭代器接口已经存在了,其中IEnumerator扮演的就是迭代器的角色,它的实现如下:

public interface IEumerator

{
    
object Current
    
{
        
get;
    }


    
bool MoveNext();

    
void Reset();

}

属性Current返回当前集合中的元素,Reset()方法恢复初始化指向的位置,MoveNext()方法返回值true表示迭代器成功前进到集合中的下一个元素,返回值false表示已经位于集合的末尾。能够提供元素遍历的集合对象,在.Net中都实现了IEnumerator接口。

IEnumerable则扮演的就是抽象聚集的角色,只有一个GetEnumerator()方法,如果集合对象需要具备跌代遍历的功能,就必须实现该接口。

public interface IEnumerable

{
    IEumerator GetEnumerator();
}

下面看一个在.NET1.1下的迭代器例子,Person类是一个可枚举的类。PersonsEnumerator类是一个枚举器类。这个例子来自于http://www.theserverside.net/,被我简单的改造了一下。

public class Persons : IEnumerable 


    
public string[] m_Names; 

    
public Persons(params string[] Names) 
    

        m_Names 
= new string[Names.Length]; 

        Names.CopyTo(m_Names,
0); 
    }
 

    
private string this[int index] 
    

        
get 
        

            
return m_Names[index]; 
        }
 

        
set 
        

            m_Names[index] 
= value; 
        }
 
    }


    
public IEnumerator GetEnumerator()
    
{
        
return new PersonsEnumerator(this);
    }

}



public class PersonsEnumerator : IEnumerator
{
    
private int index = -1;

    
private Persons P;

    
public PersonsEnumerator(Persons P)
    
{
        
this.P = P;
    }


    
public bool MoveNext()
    
{
        index
++;

        
return index < P.m_Names.Length;
    }


    
public void Reset()
    
{
        index 
= -1;
    }


    
public object Current
    
{
        
get

        
{
            
return P.m_Names[index];
        }

    }

}
 

来看客户端代码的调用:

class Program 

    
static void Main(string[] args) 
    

        Persons arrPersons 
= new Persons("Michel","Christine","Mathieu","Julien"); 

        
foreach (string s in arrPersons) 

        

            Console.WriteLine(s); 
        }


        Console.ReadLine(); 
    }
 
}

程序将输出:

Michel 

Christine 

Mathieu 

Julien

现在我们分析编译器在执行foreach语句时到底做了什么,它执行的代码大致如下:

class Program 


    
static void Main(string[] args) 
    

          Persons arrPersons 
= new Persons("Michel","Christine","Mathieu","Julien"); 

          IEnumerator e 
= arrPersons.GetEnumerator(); 

          
while (e.MoveNext()) 
          

            Console.WriteLine((
string)e.Current); 

          }


          Console.ReadLine();
    }
 
}

可以看到这段代码跟我们最前面提到的示例代码非常的相似。同时在这个例子中,我们把大部分的精力都花在了实现迭代器和可迭代的类上面,在.NET2.0下面,由于有了yield return关键字,实现起来将更加的简单优雅。下面我们把刚才的例子在2.0下重新实现一遍:

public class Persons : IEnumerable 

    
string[] m_Names; 

    
public Persons(params string[] Names) 
    

        m_Names 
= new string[Names.Length]; 

        Names.CopyTo(m_Names,
0); 
    }
 

    
public IEnumerator GetEnumerator() 
    

        
foreach (string s in m_Names) 
        

            yield 
return s; 
        }
 
    }
 
}
 

class Program 

    
static void Main(string[] args) 
    

        Persons arrPersons 
= new Persons("Michel","Christine","Mathieu","Julien"); 

        
foreach (string s in arrPersons) 
        

            Console.WriteLine(s); 
        }


        Console.ReadLine(); 
    }
 
}

程序将输出:

Michel 

Christine 

Mathieu 

Julien

实现相同的功能,由于有了yield return关键字,变得非常的简单。好了,关于.NET中的Iterator模式就说这么多了,更详细的内容大家可以参考相关的资料。

效果及实现要点

1.迭代抽象:访问一个聚合对象的内容而无需暴露它的内部表示。

2.迭代多态:为遍历不同的集合结构提供一个统一的接口,从而支持同样的算法在不同的集合结构上进行操作。

3.迭代器的健壮性考虑:遍历的同时更改迭代器所在的集合结构,会导致问题。

适用性

1.访问一个聚合对象的内容而无需暴露它的内部表示。

2.支持对聚合对象的多种遍历。

3.为遍历不同的聚合结构提供一个统一的接口(, 支持多态迭代)

总结

Iterator模式就是分离了集合对象的遍历行为,抽象出一个迭代器类来负责,这样既可以做到不暴露集合的内部结构,又可让外部代码透明的访问集合内部的数据。

参考资料

Erich Gamma等,《设计模式:可复用面向对象软件的基础》,机械工业出版社

Robert C.Martin,《敏捷软件开发:原则、模式与实践》,清华大学出版社

阎宏,《Java与模式》,电子工业出版社

Alan Shalloway James R. Trott,《Design Patterns Explained》,中国电力出版社

MSDN WebCast C#面向对象设计模式纵横谈(18)Iterator 迭代器模式(行为型模式)

作者:TerryLee
出处:http://terrylee.cnblogs.com
本文版权归作者和博客园共有,欢迎转载,但未经作者同意必须保留此段声明,且在文章页面明显位置给出原文连接,否则保留追究法律责任的权利。
posted @ 2006-09-16 10:40 TerryLee 阅读(19303) 评论(42) 编辑 收藏

 回复 引用 查看   
#1楼 2006-09-16 11:16 Dflying Chen      
good!
如果有个项目中的例子就更好了!

 回复 引用 查看   
#2楼[楼主] 2006-09-16 11:25 TerryLee      
@Dflying Chen
呵呵,这部分现在还是设计模式的基础部分,如果有可能我会做一些设计模式的案例分析:-)

 回复 引用 查看   
#3楼 2006-09-17 10:08 Clingingboy      
又出新的了,又有的看了.看了你文章以后又清晰了一些.
 回复 引用 查看   
#4楼[楼主] 2006-09-17 10:28 TerryLee      
@Clingingboy
好久没有更新了,对大家有所帮助就好:-)

 回复 引用 查看   
#5楼 2006-09-17 21:45 civ3's .NET studying      
纠正一个错别字:效果及实现要点第三条中“便利”应该为“遍历”。
另外,关于迭代器的并发控制问题,作者可不可以结合经验讨论一下?谢谢:)

 回复 引用 查看   
#6楼[楼主] 2006-09-17 22:50 TerryLee      
@civ3's .NET studying
多谢斧正
这个等后面的综合分析的时候可能会涉及到

 回复 引用   
#7楼 2006-09-19 07:57 大大虾![未注册用户]
综合分析大概什么时间出啊! :)
 回复 引用 查看   
#8楼[楼主] 2006-09-19 09:43 TerryLee      
@大大虾!
这个不好保证哦,毕竟大家都是利用业务时间再写而已:-)

 回复 引用   
#9楼 2006-10-09 14:35 design[未注册用户]
这样的话,1个Ilist实例所用到的iterator已经在代码内写死了,
public IIterator GetIterator()
{
return new ConcreteIterator(this);
}

不能在客户程序中为1个LIST实例应用多种iterator。
是不是要实现的话,就要用visitor模式了?

 回复 引用 查看   
#10楼 2006-10-20 04:09 MK2      
呵呵,我是在看prototype 1.4.0的代码才全面认识到迭代器模式的,现在看了C#是实现,原来这就是设计模式的好处。`````又学到东东了````
 回复 引用 查看   
#11楼[楼主] 2006-10-20 08:38 TerryLee      
@MK2
:)

 回复 引用   
#12楼 2006-10-20 10:23 路人丙[未注册用户]
老大,你是我的偶像!!!!等你等的好辛苦啊~~~~
我几乎每天都来你这里学习的.希望你能把设计模式这个系统按原计划写完,很期待???特别是综合篇.
我代表人民感谢你先~~~~~~

 回复 引用   
#13楼 2006-10-20 11:15 Frank Huang[未注册用户]
@design
template模式可以实现动态选择迭代器,以下是我经过扩展的代码,请大家指教:

public abstract class Persons : IEnumerable
{
protected string[] m_Names;

public Persons(params string[] Names)
{
m_Names = new string[Names.Length];

Names.CopyTo(m_Names, 0);
}

public virtual IEnumerator GetEnumerator()
{
foreach (string s in m_Names)
{
yield return s;
}
}
}

public class OrderedPersons : Persons
{
public OrderedPersons(params string[] Names)
: base(Names)
{

}

//实现正序遍历
public override IEnumerator GetEnumerator()
{
for (int i = 0; i < m_Names.Length; i++)
{
yield return m_Names[i];
}
}
}

public class ReverseOrderedPersons : Persons
{
public ReverseOrderedPersons(params string[] Names)
: base(Names)
{

}

//实现倒序遍历
public override IEnumerator GetEnumerator()
{
for (int i = m_Names.Length - 1; i >= 0; i--)
{
yield return m_Names[i];
}
}
}

 回复 引用   
#14楼 2006-10-20 11:17 Frank Huang[未注册用户]
调用如下:
static void Main(string[] args)
{

Persons persons = new OrderedPersons("Michel", "Christine", "Mathieu", "Julien");
foreach (string s in persons)
{
Console.WriteLine(s);
}
persons = new ReverseOrderedPersons("Michel", "Christine", "Mathieu", "Julien");
foreach (string s in persons)
{
Console.WriteLine(s);
}

Console.Read();

}

 回复 引用 查看   
#15楼[楼主] 2006-10-20 19:55 TerryLee      
@路人丙
谢谢,我尽量坚持写完,最近有点忙:)

 回复 引用 查看   
#16楼 2007-03-17 12:35 YanziMyWife      
public interface IEumerator

有个笔误 :IEumerator 应为IEunmerator

 回复 引用   
#17楼 2007-06-07 10:46 shasha[未注册用户]
每天不忙的时候上来看看,爽啊
 回复 引用   
#18楼 2007-08-10 15:47 coolaolmar[未注册用户]
好久没更新了 加油呀
 回复 引用 查看   
#19楼 2008-02-29 10:55 wuhang      
超级支持楼住,虽然很多模式看不懂,不过都给我收藏了!看到行为模式骗,让我联想到很多.net 的东西,像异步回调,感觉想command模式,迭代用的迭代,Observer,像事件调用,虽然学习.net快1年了,但是发觉自己懂的太少太少,希望楼主,将范型的迭代讲一讲!最后再支持下!!!向楼主学习!!!
 回复 引用 查看   
#20楼 2008-03-29 20:41 高_超      
讲的不错啊.先前看了webcast上的迭代器模式.关于扩展还是提了一些,是否可以介绍一些啊................
 回复 引用 查看   
#21楼 2008-09-25 10:55 林思衣      
迭代模式 和 组合模式很像啊

怎么看起来好像差别不大啊???
高手解释下

 回复 引用   
#22楼 2008-09-28 09:43 ww22222[未注册用户]
我是菜鸟,来学习的!
 回复 引用 查看   
#23楼[楼主] 2008-10-08 11:39 TerryLee      
@林思衣
这两个好像差别很大啊

 回复 引用 查看   
#24楼[楼主] 2008-10-08 11:39 TerryLee      
@ww22222
:-)

 回复 引用 查看   
#25楼 2008-11-03 10:29 爱上编程      
讲得太好了,思路清晰,表达也很恰当,谢谢楼主!
 回复 引用 查看   
#26楼[楼主] 2008-11-05 09:41 TerryLee      
@爱上编程
客气了,呵呵

 回复 引用   
#27楼 2009-01-12 23:36 pzm[未注册用户]
public string[] m_Names; 应该为私有吧
private string this[int index]
{
get
{
return m_Names[index];
}

set
{
m_Names[index] = value;
}
}
这个应该为共有吧
public object Current
{
get

{
return P[index];
}
}
改为
public object Current
{
get

{
return P.m_Names[index];
}
}
更好吧

 回复 引用   
#28楼 2009-01-12 23:38 pzm[未注册用户]
更正
public object Current
{
get

{
return P.m_Names[index];
}
}
改为
public object Current
{
get

{
return P[index];
}
}
更好吧

 回复 引用 查看   
#29楼 2009-08-21 16:38 月云      
李大哥,这个迭代器模式应该是组合模式中不可或缺的部分吧。对吗?
 回复 引用 查看   
#30楼 2010-11-04 02:12 天上有云      
求实例下哈。。。谢谢了。。
columbia sportswear outlet | north face outlet