迭代器模式在开源代码中的应用

逃离我推掉我的手 2022-12-05 10:25 202阅读 0赞

迭代器模式的作用：提供一种方法来顺序访问聚合对象中的一系列数据，而不暴露聚合对象的内部表示。

### **案例** ###

迭代器模式最经典的应用就是 JDK 中工具类 Iterator 接口的设计，定义了对集合的访问方法。

public interface Iterator<E> {
    
    	boolean hasNext();
    
    	E next();
    
    	default void remove() {
    		throw new UnsupportedOperationException("remove");
    	}
    
    	default void forEachRemaining(Consumer<? super E> action) {
    		Objects.requireNonNull(action);
    		while (hasNext())
    			action.accept(next());
    	}
    }

每种集合中都有 iterator() 方法，返回各自的迭代器，迭代器按照各自算法实现了 Iterator 接口，满足遍历需求。

如 ArrayLis 中

public class ArrayList<E> extends AbstractList<E> implements List<E>, RandomAccess, Cloneable, java.io.Serializable {
    
    	public Iterator<E> iterator() {
    		return new Itr();
    	}
    
    	//ArrayList 迭代器的内部实现类
    	private class Itr implements Iterator<E> {
    		int cursor;	   // index of next element to return
    		int lastRet = -1; // index of last element returned; -1 if no such
    		int expectedModCount = modCount;
    
    		Itr() {}
    
    		public boolean hasNext() {
    			return cursor != size;
    		}
    
    		@SuppressWarnings("unchecked")
    		public E next() {
    			checkForComodification();
    			int i = cursor;
    			if (i >= size)
    				throw new NoSuchElementException();
    			Object[] elementData = ArrayList.this.elementData;
    			if (i >= elementData.length)
    				throw new ConcurrentModificationException();
    			cursor = i + 1;
    			return (E) elementData[lastRet = i];
    		}
    
    		public void remove() {
    			if (lastRet < 0)
    				throw new IllegalStateException();
    			checkForComodification();
    
    			try {
    				ArrayList.this.remove(lastRet);
    				cursor = lastRet;
    				lastRet = -1;
    				expectedModCount = modCount;
    			} catch (IndexOutOfBoundsException ex) {
    				throw new ConcurrentModificationException();
    			}
    		}
    
    		@Override
    		@SuppressWarnings("unchecked")
    		public void forEachRemaining(Consumer<? super E> consumer) {
    			Objects.requireNonNull(consumer);
    			final int size = ArrayList.this.size;
    			int i = cursor;
    			if (i >= size) {
    				return;
    			}
    			final Object[] elementData = ArrayList.this.elementData;
    			if (i >= elementData.length) {
    				throw new ConcurrentModificationException();
    			}
    			while (i != size && modCount == expectedModCount) {
    				consumer.accept((E) elementData[i++]);
    			}
    			// update once at end of iteration to reduce heap write traffic
    			cursor = i;
    			lastRet = i - 1;
    			checkForComodification();
    		}
    
    		final void checkForComodification() {
    			if (modCount != expectedModCount)
    				throw new ConcurrentModificationException();
    		}
    	}
    
    }

HashSet 中

public class HashSet<E> extends AbstractSet<E> implements Set<E>, Cloneable, java.io.Serializable {
    	
    	// HashSet 是基于 HashMap 实现，直接返回 key 的 Set 的 Iterator
    	public Iterator<E> iterator() {
    		return map.keySet().iterator();
    	}
    	
    }

队列 PriorityQueue 中

public class PriorityQueue<E> extends AbstractQueue<E> implements java.io.Serializable {
    	public Iterator<E> iterator() {
    		return new Itr();
    	}
    	
    	//内部对 Iterator 接口进行实现，迭代 PriorityQueue
    	private final class Itr implements Iterator<E> {
    		private int cursor = 0;
    
    		private int lastRet = -1;
    
    		private ArrayDeque<E> forgetMeNot = null;
    
    		private E lastRetElt = null;
    
    		private int expectedModCount = modCount;
    
    		public boolean hasNext() {
    			return cursor < size ||
    				(forgetMeNot != null && !forgetMeNot.isEmpty());
    		}
    
    		@SuppressWarnings("unchecked")
    		public E next() {
    			if (expectedModCount != modCount)
    				throw new ConcurrentModificationException();
    			if (cursor < size)
    				return (E) queue[lastRet = cursor++];
    			if (forgetMeNot != null) {
    				lastRet = -1;
    				lastRetElt = forgetMeNot.poll();
    				if (lastRetElt != null)
    					return lastRetElt;
    			}
    			throw new NoSuchElementException();
    		}
    
    		public void remove() {
    			if (expectedModCount != modCount)
    				throw new ConcurrentModificationException();
    			if (lastRet != -1) {
    				E moved = PriorityQueue.this.removeAt(lastRet);
    				lastRet = -1;
    				if (moved == null)
    					cursor--;
    				else {
    					if (forgetMeNot == null)
    						forgetMeNot = new ArrayDeque<>();
    					forgetMeNot.add(moved);
    				}
    			} else if (lastRetElt != null) {
    				PriorityQueue.this.removeEq(lastRetElt);
    				lastRetElt = null;
    			} else {
    				throw new IllegalStateException();
    			}
    			expectedModCount = modCount;
    		}
    	}
    }

--------------------

### 【Java学习资源】整理推荐 ###

*  [迭代器模式在开源代码中的应用][Link 1]
 *  [中介者模式的实际应用][Link 2]
 *  [观察者模式在开源代码中的应用][Link 3]
 *  [职责链模式在开源代码中的应用][Link 4]
 *  [命令模式在开源代码中的应用][Link 5]
 *  [策略模式在开源代码中应用][Link 6]
 *  [模板方法模式在开源代码中应用][Link 7]
 *  [组合模式在开源代码中的应用][Link 8]
 *  [享元模式在开源代码中的应用][Link 9]
 *  [外观模式在开源代码中的应用][Link 10]
 *  [装饰器模式在开源代码中的应用][Link 11]
 *  [桥接模式在开源代码中的应用][Link 12]
 *  [适配器模式在开源代码中的应用][Link 13]
 *  [代理模式在开源代码中的应用][Link 14]
 *  [原型模式在开源代码中的应用][Link 15]
 *  [建造者模式在开源代码中的应用][Link 16]
 *  [工厂模式在开源代码中的应用][Link 17]
 *  [单例模式在开源代码中的应用][Link 18]
 *  [编码规范][Link 19]
 *  [设计模式][Link 20]
 *  [重构][Link 21]
 *  [设计原则][Link 22]
 *  [面向对象到底是什么][Link 23]
 *  [代码质量有哪些评判标准？][Link 24]

--------------------

### 【Java面试题与答案】整理推荐 ###

*  [基础与语法][Link 25]
 *  [集合][Link 26]
 *  [网络编程][Link 27]
 *  [并发编程][Link 28]
 *  [Web][]
 *  [安全][Link 29]
 *  [设计模式][Link 30]
 *  [框架][Link 31]
 *  [算法与数据结构][Link 32]
 *  [异常][Link 33]
 *  [文件解析与生成][Link 34]
 *  [Linux][]
 *  [MySQL][]
 *  [Oracle][]
 *  [Redis][]
 *  [Dubbo][]

[Link 1]: https://www.javanav.com/val/467a3f3cb7014842961d83379c2a241d.html
[Link 2]: https://www.javanav.com/val/4ed6da84a1734b9ebfc33fc0aa650f99.html
[Link 3]: https://www.javanav.com/val/187b108ea42d4992a1534e016c9ac618.html
[Link 4]: https://www.javanav.com/val/dc8fdb1954b1438ca55148e3c62547bd.html
[Link 5]: https://www.javanav.com/val/37ea584b5a9646f88e3916d13037e13f.html
[Link 6]: https://www.javanav.com/val/21eda51d16904f2798dc30974fe0fed9.html
[Link 7]: https://www.javanav.com/val/acd6815d8bcd45ce9db38659a049e778.html
[Link 8]: https://www.javanav.com/val/12f35b774b514c47a219bd860148f179.html
[Link 9]: https://www.javanav.com/val/72ac6d1ddd2d46b2a5312ac9b3050986.html
[Link 10]: https://www.javanav.com/val/f4a27593b46b46bc89d77d9f92c0f50c.html
[Link 11]: https://www.javanav.com/val/40716af16cda47ffae5fcf4090e69e14.html
[Link 12]: https://www.javanav.com/val/75bfae90731d40c781926a0dbec9edca.html
[Link 13]: https://www.javanav.com/val/f35536fdc771448f8d70574d830b7616.html
[Link 14]: https://www.javanav.com/val/24468130d26e460187c9280b90146649.html
[Link 15]: https://www.javanav.com/val/ffd6d3d1ceed414daafeb3ce10794c60.html
[Link 16]: https://www.javanav.com/val/e8afb788fdc54712aaf981c705796b46.html
[Link 17]: https://www.javanav.com/val/6f367ed6ee894adb830987f11536141c.html
[Link 18]: https://www.javanav.com/val/838b98837f574aa6a09c840921984707.html
[Link 19]: https://www.javanav.com/val/2b9f8790e8564bc0a2cb36357a66502f.html
[Link 20]: https://www.javanav.com/val/90b430ff0cbc4ef997e64cf7a0e1e745.html
[Link 21]: https://www.javanav.com/val/d9095cb3712040c0bee8054732321d6d.html
[Link 22]: https://www.javanav.com/val/9916617e210c4e0eae8649874a2cedd5.html
[Link 23]: https://www.javanav.com/val/5a834b46cfd945f7be9c4ea652306fd4.html
[Link 24]: https://www.javanav.com/val/0cea6c7c082043ab83ad87a9c5a48d9d.html
[Link 25]: https://www.javanav.com/interview/93b0069472fd479393006c0e73043fc4.html
[Link 26]: https://www.javanav.com/interview/4147d95e693945e7a50345fd33ec817e.html
[Link 27]: https://www.javanav.com/interview/68a57ffc78de4133bb890bdd502ac418.html
[Link 28]: https://www.javanav.com/interview/36a24fa3258e45c89873f474ce914912.html
[Web]: https://www.javanav.com/interview/4e27cb63adb440c6825a159d35cf4010.html
[Link 29]: https://www.javanav.com/interview/03affb2ce3f04fda8853f714e5764906.html
[Link 30]: https://www.javanav.com/interview/07a32a9ff17a4006a53550ce658cafed.html
[Link 31]: https://www.javanav.com/interview/5c466456e9b54ab0a749b5948e51f1d3.html
[Link 32]: https://www.javanav.com/interview/943f917041ee4f05add24539f5b861b2.html
[Link 33]: https://www.javanav.com/interview/d3f058cfc05d4c6dadd821b622e84d36.html
[Link 34]: https://www.javanav.com/interview/67a50996c28f418e83b109ea42fc3eff.html
[Linux]: https://www.javanav.com/interview/00cccb81729540d1923bd0a0ef49533a.html
[MySQL]: https://www.javanav.com/interview/d311e78502a845f1a4bb307bd6aec2b3.html
[Oracle]: https://www.javanav.com/interview/5f29e9677edf4a16be3dce30d257c9ab.html
[Redis]: https://www.javanav.com/interview/066c62b3af4d4827b2243a822c3084a9.html
[Dubbo]: https://www.javanav.com/interview/9a3e7a7740324757abaab953f7ebc455.html