Java中的迭代器设计模式

迭代器设计模式中的行为模式之一。迭代器模式用于提供遍历一组对象的标准方法。迭代器模式广泛应用于Java集合框架。 Iterator 接口提供了遍历集合的方法。

迭代器设计模式

According to GoF, iterator design pattern intent is:

提供一种访问聚合对象的元素而不暴露其底层表示的方法。

迭代器模式不仅仅是遍历集合，我们可以根据需要提供不同类型的迭代器。迭代器设计模式隐藏了通过集合进行遍历的实际实现，客户端程序仅使用迭代器方法。

迭代器模式示例

让我们通过一个简单的例子来理解迭代器模式。假设我们有一个广播频道列表，并且客户端程序想要逐个或根据频道类型遍历它们。例如，某些客户端程序只对英语频道感兴趣，并且只想处理它们，而不想处理其他类型的频道。所以我们可以向客户端提供一个通道的集合，让他们编写遍历通道并决定是否处理它们的逻辑。但这个解决方案有很多问题，比如客户端必须想出遍历的逻辑。我们无法确保客户端逻辑是否正确。此外，如果客户数量增加，维护将变得非常困难。这里我们可以使用迭代器模式并提供基于通道类型的迭代。我们应该确保客户端程序只能通过迭代器访问频道列表。实现的第一部分是定义集合和迭代器接口的契约。ChannelTypeEnum.java

package com.journaldev.design.iterator;

public enum ChannelTypeEnum {

	ENGLISH, HINDI, FRENCH, ALL;
}

ChannelTypeEnum 是java枚举它定义了所有不同类型的通道。Channel.java

package com.journaldev.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;
	}
	
}

Channel 是一个简单的 POJO 类，具有频率和频道类型属性。ChannelCollection.java

package com.journaldev.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.journaldev.design.iterator;

public interface ChannelIterator {

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

现在我们的基接口和核心类已经准备好了，让我们继续实现集合类和迭代器。ChannelCollectionImpl.java

package com.journaldev.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.journaldev.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 接口。阅读这篇文章以了解Java 扫描器类。这就是迭代器设计模式的全部内容，希望对您有所帮助并且易于理解。