Java迭代器设计模式完全指南：原理、实现与最佳实践

1 年 ago

清, 宇

3 minutes

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

迭代器设计模式

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

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

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

迭代器模式的一个例子

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

package com.Olivia.design.iterator;

public enum ChannelTypeEnum {

	ENGLISH, HINDI, FRENCH, ALL;
}

ChannelTypeEnum是一个Java枚举，用于定义所有不同类型的渠道。Channel.java

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

public interface ChannelIterator {

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

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

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

	}
}

注意迭代器接口的内部类实现，使得该实现不能被任何其他集合使用。集合类也采用相同的方法，它们都具有迭代器接口的内部类实现。让我们编写一个简单的迭代器模式测试程序，以使用我们的集合和迭代器遍历通道集合。IteratorPatternTest.java

package com.Olivia.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中的迭代器设计模式。

我们都知道，集合框架的迭代器是迭代器模式实现的最好例子，但你知道java.util.Scanner类也实现了迭代器接口吗？阅读本文了解Java Scanner类。关于迭代器设计模式就介绍到这里，希望对你有所帮助，也容易理解。

#Java编程 #Java设计模式 #Java集合框架 #设计模式 #迭代器模式