迭代器设计模式中的一种行为模式。
迭代器模式用于提供遍历一组对象的标准方法。
迭代器模式在Java Collection Framework中被广泛使用。
迭代器接口提供遍历集合的方法。

迭代器设计模式

根据GoF，迭代器设计模式的意图是：

<p>Provides a way to access the elements of an aggregate object without exposing its underlying represenation.</p>

迭代器模式不仅涉及遍历集合，我们还可以根据需求提供不同种类的迭代器。

迭代器设计模式通过集合隐藏了遍历的实际实现，而客户端程序仅使用迭代器方法。

迭代器模式示例

让我们通过一个简单的示例来了解迭代器模式。
假设我们有一个无线电频道列表，并且客户端程序想一一遍或者根据频道类型遍历它们。
例如，某些客户程序仅对英语频道感兴趣，而只想处理它们，而不希望处理其他类型的频道。

因此，我们可以向客户提供渠道的集合，让他们编写逻辑来遍历渠道并决定是否进行处理。
但是此解决方案存在许多问题，例如客户端必须提出遍历的逻辑。
我们无法确保客户端逻辑正确。
此外，如果客户数量增加，那么将很难维护。

其中我们可以使用Iterator模式，并根据通道类型提供迭代。
我们应该确保客户端程序只能通过迭代器访问频道列表。

实现的第一部分是为我们的collection和iterator接口定义协定。

ChannelTypeEnum.java

package com.theitroad.design.iterator;

public enum ChannelTypeEnum {

	ENGLISH, HINDI, FRENCH, ALL;
}

ChannelTypeEnum是Java枚举，它定义所有不同类型的通道。

Channel.java

package com.theitroad.design.iterator;

public class Channel {

	private double frequency;
	private ChannelTypeEnum TYPE;
	
	public Channel(double freq, ChannelTypeEnum type){
		this.frequency=freq;
		this.TYPE=type;
	}

	public double getFrequency() {
		return frequency;
	}

	public ChannelTypeEnum getTYPE() {
		return TYPE;
	}
	
	@Override
	public String toString(){
		return "Frequency="+this.frequency+", Type="+this.TYPE;
	}
	
}

通道是一个简单的POJO类，具有频率和通道类型属性。

ChannelCollection.java

package com.theitroad.design.iterator;

public interface ChannelCollection {

	public void addChannel(Channel c);
	
	public void removeChannel(Channel c);
	
	public ChannelIterator iterator(ChannelTypeEnum type);
	
}

ChannelCollection接口为我们的集合类实现定义合同。
请注意，有一些方法可以添加和删除频道，但是没有方法可以返回频道列表。
ChannelCollection有一个返回迭代器以进行遍历的方法。
ChannelIterator接口定义以下方法；

ChannelIterator.java

package com.theitroad.design.iterator;

public interface ChannelIterator {

	public boolean hasNext();
	
	public Channel next();
}

现在我们的基本接口和核心类已经准备就绪，让我们继续实现集合类和迭代器。

ChannelCollectionImpl.java

package com.theitroad.design.iterator;

import java.util.ArrayList;
import java.util.List;

public class ChannelCollectionImpl implements ChannelCollection {

	private List<Channel> channelsList;

	public ChannelCollectionImpl() {
		channelsList = new ArrayList<>();
	}

	public void addChannel(Channel c) {
		this.channelsList.add(c);
	}

	public void removeChannel(Channel c) {
		this.channelsList.remove(c);
	}

	@Override
	public ChannelIterator iterator(ChannelTypeEnum type) {
		return new ChannelIteratorImpl(type, this.channelsList);
	}

	private class ChannelIteratorImpl implements ChannelIterator {

		private ChannelTypeEnum type;
		private List<Channel> channels;
		private int position;

		public ChannelIteratorImpl(ChannelTypeEnum ty,
				List<Channel> channelsList) {
			this.type = ty;
			this.channels = channelsList;
		}

		@Override
		public boolean hasNext() {
			while (position < channels.size()) {
				Channel c = channels.get(position);
				if (c.getTYPE().equals(type) || type.equals(ChannelTypeEnum.ALL)) {
					return true;
				} else
					position++;
			}
			return false;
		}

		@Override
		public Channel next() {
			Channel c = channels.get(position);
			position++;
			return c;
		}

	}
}

请注意，迭代器接口的内部类实现，以便其他任何集合都不能使用该实现。
集合类也遵循相同的方法，并且它们都具有Iterator接口的内部类实现。

让我们编写一个简单的迭代器模式测试程序，以使用我们的集合并使用迭代器遍历通道集合。

IteratorPatternTest.java

package com.theitroad.design.iterator;

public class IteratorPatternTest {

	public static void main(String[] args) {
		ChannelCollection channels = populateChannels();
		ChannelIterator baseIterator = channels.iterator(ChannelTypeEnum.ALL);
		while (baseIterator.hasNext()) {
			Channel c = baseIterator.next();
			System.out.println(c.toString());
		}
		System.out.println("**");
		//Channel Type Iterator
		ChannelIterator englishIterator = channels.iterator(ChannelTypeEnum.ENGLISH);
		while (englishIterator.hasNext()) {
			Channel c = englishIterator.next();
			System.out.println(c.toString());
		}
	}

	private static ChannelCollection populateChannels() {
		ChannelCollection channels = new ChannelCollectionImpl();
		channels.addChannel(new Channel(98.5, ChannelTypeEnum.ENGLISH));
		channels.addChannel(new Channel(99.5, ChannelTypeEnum.HINDI));
		channels.addChannel(new Channel(100.5, ChannelTypeEnum.FRENCH));
		channels.addChannel(new Channel(101.5, ChannelTypeEnum.ENGLISH));
		channels.addChannel(new Channel(102.5, ChannelTypeEnum.HINDI));
		channels.addChannel(new Channel(103.5, ChannelTypeEnum.FRENCH));
		channels.addChannel(new Channel(104.5, ChannelTypeEnum.ENGLISH));
		channels.addChannel(new Channel(105.5, ChannelTypeEnum.HINDI));
		channels.addChannel(new Channel(106.5, ChannelTypeEnum.FRENCH));
		return channels;
	}

}

当我运行上面的程序时，它将产生以下输出；

Frequency=98.5, Type=ENGLISH
Frequency=99.5, Type=HINDI
Frequency=100.5, Type=FRENCH
Frequency=101.5, Type=ENGLISH
Frequency=102.5, Type=HINDI
Frequency=103.5, Type=FRENCH
Frequency=104.5, Type=ENGLISH
Frequency=105.5, Type=HINDI
Frequency=106.5, Type=FRENCH
**
Frequency=98.5, Type=ENGLISH
Frequency=101.5, Type=ENGLISH
Frequency=104.5, Type=ENGLISH

迭代器设计模式要点

• 当您想提供一种标准方法来遍历集合并从客户端程序中隐藏实现逻辑时，迭代器模式非常有用。

• 迭代逻辑嵌入在集合本身中，它可以帮助客户端程序轻松地对其进行迭代。

JDK中的迭代器设计模式

我们都知道Collection框架Iterator是实现迭代器模式的最佳示例，但您知道java.util.Scanner类也实现了Iterator接口。