介绍
迭代器模式又叫游标模式(Cursor),是对象的行为模式。迭代器模式可以顺序地访问一个聚集中的元素而不必暴露聚集内部的表象。
备注:Java聚集(Collection)对象是实现了共同的java.util.Collection接口的对象,是Java语言对聚集概念的直接支持。
模式引入
在现实生活以及程序设计中,经常要访问一个聚合对象中的各个元素,如“数据结构”中的链表遍历,通常的做法是将链表的创建和遍历都放在同一个类中,但这种方式不利于程序的扩展,如果要更换遍历方法就必须修改程序源代码,这违背了 “开闭原则”。
既然将遍历方法封装在聚合类中不可取,那么聚合类中不提供遍历方法,将遍历方法由用户自己实现是否可行呢?答案是同样不可取,因为这种方式会存在两个缺点:暴露了聚合类的内部表示,使其数据不安全,增加了使用者的负担。
“迭代器模式”能较好地克服以上缺点,它在客户访问类与聚合类之间插入一个迭代器,这分离了聚合对象与其遍历行为,对客户也隐藏了其内部细节,且满足“单一职责原则”和“开闭原则”。
个人理解,在其他语言(如C语言),想要实现List、Set、Map这样的聚集需要自己编码去实现。这不仅要对语言要较深的理解,还要熟悉数据结构和迭代器模式才能写出性能良好、易维护、易扩展的聚集(List、Set、Map);但对于Java程序员而言,Java有丰富的聚集(List、Set、Map),也为这些聚集提供了迭代器模式。因此大数情况下使用Java中已有的聚合类的迭代器就已经够了。(备注:熟悉迭代器模式有助于了解Java聚集的源码。)
模式角色
迭代器模式有以下角色:
- Aggregate(抽象聚集),定义存储、添加、删除聚合对象以及创建迭代器对象的接口。
- ConcreteIterator(具体聚集),实现抽象聚合类,返回一个具体迭代器的实例。
- Iterator(抽象迭代器),定义访问和遍历聚合元素的接口,通常包含 hasNext()、first()、next() 等方法。
- ConcreteIterator(具体迭代器),实现抽象迭代器接口中所定义的方法,完成对聚合对象的遍历,记录遍历的当前位置。
模式实现-白箱聚集与外迭代器
- 白箱聚集:一个白箱聚集向外界提供访问自己内部元素的接口。
- 外迭代器:具体迭代器在聚集外部声明(区别于内迭代器,内迭代器为聚集的内部类,Java聚集里是内迭代器)。
外迭代器迭代逻辑由白箱聚集提供,所以这样的外迭代器仅仅保持迭代的游标位置。
/**
* 抽象聚集
*/
public abstract class Aggregate {
// 工厂方法,返回一个迭代器对象
public Iterator createIterator() {
return null;
}
}
/**
* 具体聚集
*/
public class ConcreteAggregate extends Aggregate {
private Object[] objs = {"City", "Smile", "Sun", "Happy"};
@Override
public Iterator createIterator() {
return new ConcreteIterator(this);
}
public Object getElement(int index) {
if (index < objs.length) {
return objs[index];
} else {
return null;
}
}
public int size() {
return objs.length;
}
}
/**
* 抽象迭代器
*/
public interface Iterator {
// 迭代器方法,移动到第一个元素
void first();
// 迭代器方法,移动到下一个元素
void next();
// 迭代器方法,是否是最后一个元素
boolean isDone();
// 迭代器方法,返回当前元素
Object currentItem();
}
/**
* 具体迭代器
*/
class ConcreteIterator implements Iterator {
private ConcreteAggregate agg;
private int index = 0;
private int size = 0;
public ConcreteIterator(ConcreteAggregate agg) {
this.agg = agg;
size = agg.size();
index = 0;
}
@Override
public void first() {
index = 0;
}
@Override
public void next() {
if (index < size) {
index++;
}
}
@Override
public boolean isDone() {
return (index >= size);
}
@Override
public Object currentItem() {
return agg.getElement(index);
}
}
/**
* Client
*/
public class IteratorClient {
private Iterator it;
private Aggregate agg = new ConcreteAggregate();
public void operation() {
it = agg.createIterator();
while (!it.isDone()) {
System.out.println(it.currentItem());
it.next();
}
}
public static void main(String[] args) {
IteratorClient client = new IteratorClient();
client.operation();
}
}
模式实现-黑箱聚集与内迭代器
- 黑箱聚集:与白箱聚集相反,一个黑箱聚集不向外界提供访问自己内部元素的接口。因此,这些元素对象只可以被聚集内部成员访问。
- 内迭代器:具体迭代器在聚集内部声明,也就是一个内迭代器是黑箱聚集类的内部类。
/**
* 抽象聚集
*/
abstract class Aggregate {
// 工厂方法,返回一个迭代器对象
public abstract Iterator createIterator();
}
/**
* 具体聚集
*/
class ConcreteAggregate extends Aggregate {
private Object[] objs = {"City", "Smile", "Sun", "Happy"};
@Override
public Iterator createIterator() {
return new ConcreteIterator();
}
public Object getElement(int index) {
if (index < objs.length) {
return objs[index];
} else {
return null;
}
}
public int size() {
return objs.length;
}
/**
* 内迭代器
*/
private class ConcreteIterator implements Iterator {
private int index = 0;
@Override
public void first() {
index = 0;
}
@Override
public void next() {
if (index < objs.length) {
index++;
}
}
@Override
public boolean isDone() {
return (index >= objs.length);
}
@Override
public Object currentItem() {
return objs[index];
}
}
}
/**
* 抽象迭代器
*/
public interface Iterator {
// 迭代器方法,移动到第一个元素
void first();
// 迭代器方法,移动到下一个元素
void next();
// 迭代器方法,是否是最后一个元素
boolean isDone();
// 迭代器方法,返回当前元素
Object currentItem();
}
/**
* Client
*/
class IteratorClient {
private Iterator it;
private Aggregate agg = new ConcreteAggregate();
public void operation() {
it = agg.createIterator();
while (!it.isDone()) {
System.out.println(it.currentItem());
it.next();
}
}
public static void main(String[] args) {
IteratorClient client = new IteratorClient();
client.operation();
}
}
模式实现-静态迭代器
静态迭代器由聚集对象创建,并持有聚集对象的一个快照(snapshot),在产生后这个快照的内容就不再变化。客户端可以继续修改原聚集里的内容,但是迭代器不会反映出聚集的变化。静态迭代器的优点是安全性和简易性;缺点是将原聚集复制了一份,导致对时间和内存资源的消耗,对大型聚集不合适。
/**
* 静态迭代器
*/
public class StaticIterator<E> {
private final Vector<E> vector;
private int count;
public StaticIterator(Vector<E> vector) {
// 将聚集对象复制一份。
this.vector = (Vector<E>) vector.clone();
count = 0;
}
/**
* 迭代方法,移动到第一个元素
*/
public void first(E e) {
count = 0;
}
/**
* 迭代方法,是否是最后一个元素
*/
public boolean isDone() {
return count < vector.size();
}
/**
* 迭代方法,是否是最后一个元素
*/
public E next() {
synchronized (vector) {
if (count < vector.size()) {
return vector.get(count);
}
}
throw new NoSuchElementException("DynamicIterator");
}
}
模式实现-动态态迭代器
动态迭代器与静态迭代器完全想法,在迭代器被产生之后,迭代器保持着对聚集对象的引用,因此,任何对原聚集内容的修改都会在迭代器对象上反映出来。完整的动态迭代器不容易实现,但是简化的动态迭代器并不难实现。大多数迭代器都是这种简化的动态迭代器,如前面的外迭代器。
/**
* 动态迭代器
*/
public class DynamicIterator<E> {
private final Vector<E> vector;
private int count;
public DynamicIterator(Vector<E> vector) {
this.vector = vector;
count = 0;
}
/**
* 迭代方法,移动到第一个元素
*/
public void first() {
count = 0;
}
/**
* 迭代方法,是否是最后一个元素
*/
public boolean isDone() {
return count < vector.size();
}
/**
* 迭代方法,是否是最后一个元素
*/
public E next() {
synchronized (vector) {
if (count < vector.size()) {
return vector.get(count);
}
}
throw new NoSuchElementException("DynamicIterator");
}
}
模式实现-主动迭代器和被动迭代器
迭代器是主动的还是被动的,是相对于客户端而言的。如果客户端控制迭代的进程,那么这样的迭代器是主动迭代器;相反就是被动迭代器。
使用主动迭代器的客户端会明显调用迭代器的next()等迭代方法;而使用被动迭代器的客户端并不明显地调用迭代方法,迭代器自行推进遍历过程。
模式不变对象
一个白箱聚集对象可能是不变对象,前提是它的内部状态,包括聚集元素是不会改变的。
一个黑箱聚集对象不可能是不变对象,因为它的内部状态是会改变的。
关于“不变模式”可查看这篇文章。
Fail Fast机制
请查阅这篇文章。