設計模式 | 迭代器模式及典型應用
阿新 • • 發佈：2018-11-12
本文的主要內容：
- 介紹迭代器模式
- 原始碼分析迭代器模式的典型應用
- Java集合中的迭代器模式
- Mybatis中的迭代器模式
更多內容可訪問我的個人部落格：laijianfeng.org
關注【小旋鋒】微信公眾號，及時接收博文推送
迭代器模式
迭代器模式(Iterator Pattern)：提供一種方法來訪問聚合物件，而不用暴露這個物件的內部表示，其別名為遊標(Cursor)。迭代器模式是一種物件行為型模式。
角色
Iterator（抽象迭代器）：它定義了訪問和遍歷元素的介面，聲明瞭用於遍歷資料元素的方法，例如：用於獲取第一個元素的first()方法，用於訪問下一個元素的next()方法，用於判斷是否還有下一個元素的hasNext()方法，用於獲取當前元素的currentItem()方法等，在具體迭代器中將實現這些方法。
ConcreteIterator（具體迭代器）：它實現了抽象迭代器介面，完成對聚合物件的遍歷，同時在具體迭代器中通過遊標來記錄在聚合物件中所處的當前位置，在具體實現時，遊標通常是一個表示位置的非負整數。
Aggregate（抽象聚合類）：它用於儲存和管理元素物件，宣告一個createIterator()方法用於建立一個迭代器物件，充當抽象迭代器工廠角色。
ConcreteAggregate（具體聚合類）：它實現了在抽象聚合類中宣告的createIterator()方法，該方法返回一個與該具體聚合類對應的具體迭代器ConcreteIterator例項。
在迭代器模式中，提供了一個外部的迭代器來對聚合物件進行訪問和遍歷，迭代器定義了一個訪問該聚合元素的介面，並且可以跟蹤當前遍歷的元素，瞭解哪些元素已經遍歷過而哪些沒有。迭代器的引入，將使得對一個複雜聚合物件的操作變得簡單。
在迭代器模式中應用了工廠方法模式，抽象迭代器對應於抽象產品角色，具體迭代器對應於具體產品角色，抽象聚合類對應於抽象工廠角色，具體聚合類對應於具體工廠角色。
示例
我們來實現一個學生報數的示例
定義一個學生類，有一個報數方法 count()
@Getter
@Setter
@ToString
public class Student {
private String name;
private Integer number;
public Student(String name, Integer number) {
this.name = name;
this 定義班級介面和班級類
public interface StudentAggregate {
void addStudent(Student student);
void removeStudent(Student student);
StudentIterator getStudentIterator();
}
public class StudentAggregateImpl implements StudentAggregate {
private List<Student> list; // 學生列表
public StudentAggregateImpl() {
this.list = new ArrayList<Student>();
}
@Override
public void addStudent(Student student) {
this.list.add(student);
}
@Override
public void removeStudent(Student student) {
this.list.remove(student);
}
@Override
public StudentIterator getStudentIterator() {
return new StudentIteratorImpl(list);
}
}
複製程式碼定義迭代器介面並實現迭代器
public interface StudentIterator {
boolean hashNext();
Student next();
}
public class StudentIteratorImpl implements StudentIterator{
private List<Student> list;
private int position = 0;
private Student currentStudent;
public StudentIteratorImpl(List<Student> list) {
this.list = list;
}
@Override
public boolean hashNext() {
return position < list.size();
}
@Override
public Student next() {
currentStudent = list.get(position);
position ++;
return currentStudent;
}
}
複製程式碼測試，進行報數
public class Test {
public static void main(String[] args) {
StudentAggregate classOne = new StudentAggregateImpl();
classOne.addStudent(new Student("張三", 1));
classOne.addStudent(new Student("李四", 2));
classOne.addStudent(new Student("王五", 3));
classOne.addStudent(new Student("趙六", 4));
// 遍歷，報數
StudentIterator iterator = classOne.getStudentIterator();
while (iterator.hashNext()){
Student student = iterator.next();
student.count();
}
}
}
複製程式碼輸出
我是 1 號 張三
我是 2 號 李四
我是 3 號 王五
我是 4 號 趙六
複製程式碼迭代器模式類圖如下
迭代器模式總結
迭代器模式的主要優點如下：
- 它支援以不同的方式遍歷一個聚合物件，在同一個聚合物件上可以定義多種遍歷方式。在迭代器模式中只需要用一個不同的迭代器來替換原有迭代器即可改變遍歷演算法，我們也可以自己定義迭代器的子類以支援新的遍歷方式。
- 迭代器簡化了聚合類。由於引入了迭代器，在原有的聚合物件中不需要再自行提供資料遍歷等方法，這樣可以簡化聚合類的設計。
- 在迭代器模式中，由於引入了抽象層，增加新的聚合類和迭代器類都很方便，無須修改原有程式碼，滿足 "開閉原則" 的要求。
迭代器模式的主要缺點如下：
- 由於迭代器模式將儲存資料和遍歷資料的職責分離，增加新的聚合類需要對應增加新的迭代器類，類的個數成對增加，這在一定程度上增加了系統的複雜性。
- 抽象迭代器的設計難度較大，需要充分考慮到系統將來的擴充套件，例如JDK內建迭代器Iterator就無法實現逆向遍歷，如果需要實現逆向遍歷，只能通過其子類ListIterator等來實現，而ListIterator迭代器無法用於操作Set型別的聚合物件。在自定義迭代器時，建立一個考慮全面的抽象迭代器並不是件很容易的事情。
適用場景:
- 訪問一個聚合物件的內容而無須暴露它的內部表示。將聚合物件的訪問與內部資料的儲存分離，使得訪問聚合物件時無須瞭解其內部實現細節。
- 需要為一個聚合物件提供多種遍歷方式。
- 為遍歷不同的聚合結構提供一個統一的介面，在該介面的實現類中為不同的聚合結構提供不同的遍歷方式，而客戶端可以一致性地操作該介面。
原始碼分析迭代器模式的典型應用
Java集合中的迭代器模式
看 java.util.ArrayList 類
public class ArrayList<E> extends AbstractList<E> implements List<E>, RandomAccess, Cloneable, java.io.Serializable {
transient Object[] elementData; // non-private to simplify nested class access
private int size;
public E get(int index) {
rangeCheck(index);
return elementData(index);
}
public boolean add(E e) {
ensureCapacityInternal(size + 1); // Increments modCount!!
elementData[size++] = e;
return true;
}
public ListIterator<E> listIterator() {
return new ListItr(0);
}
public ListIterator<E> listIterator(int index) {
if (index < 0 || index > size)
throw new IndexOutOfBoundsException("Index: "+index);
return new ListItr(index);
}
public Iterator<E> iterator() {
return new Itr();
}
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;
public boolean hasNext() {
return cursor != size;
}
public E next() {
//...
}
public E next() {
//...
}
public void remove() {
//...
}
//...
}
private class ListItr extends Itr implements ListIterator<E> {
public boolean hasPrevious() {
return cursor != 0;
}
public int nextIndex() {
return cursor;
}
public int previousIndex() {
return cursor - 1;
}
public E previous() {
//...
}
public void set(E e) {
//...
}
public void add(E e) {
//...
}
//...
}
複製程式碼從 ArrayList 原始碼中看到了有兩個迭代器 Itr 和 ListItr，分別實現 Iterator 和 ListIterator 介面；
第一個當然很容易看明白，它跟我們示例的迭代器的區別是這裡是一個內部類，可以直接使用 ArrayList 的資料列表；第二個迭代器是第一次見到， ListIterator 跟 Iterator 有什麼區別呢？
先看 ListIterator 原始碼
public interface ListIterator<E> extends Iterator<E> {
boolean hasNext();
E next();
boolean hasPrevious(); // 返回該迭代器關聯的集合是否還有上一個元素
E previous(); // 返回該迭代器的上一個元素
int nextIndex(); // 返回列表中ListIterator所需位置後面元素的索引
int previousIndex(); // 返回列表中ListIterator所需位置前面元素的索引
void remove();
void set(E var1); // 從列表中將next()或previous()返回的最後一個元素更改為指定元素e
void add(E var1);
}
複製程式碼接著是 Iterator 的原始碼
public interface Iterator<E> {
boolean hasNext();
E next();
default void remove() {
throw new UnsupportedOperationException("remove");
}
// 備註：JAVA8允許介面方法定義預設實現
default void forEachRemaining(Consumer<? super E> action) {
Objects.requireNonNull(action);
while (hasNext())
action.accept(next());
}
}
複製程式碼通過原始碼我們看出：ListIterator 是一個功能更加強大的迭代器，它繼承於 Iterator 介面，只能用於各種List型別的訪問。可以通過呼叫 listIterator() 方法產生一個指向List開始處的 ListIterator, 還可以呼叫 listIterator(n) 方法建立一個一開始就指向列表索引為n的元素處的 ListIterator。
Iterator 和 ListIterator 主要區別概括如下:
ListIterator有add()方法，可以向List中新增物件，而Iterator不能ListIterator和Iterator都有hasNext()和next()方法，可以實現順序向後遍歷，但是ListIterator有hasPrevious()和previous()方法，可以實現逆向（順序向前）遍歷。Iterator就不可以。ListIterator可以定位當前的索引位置，nextIndex()和previousIndex()可以實現。Iterator沒有此功能。- 都可實現刪除物件，但是
ListIterator可以實現物件的修改，set()方法可以實現。Iierator僅能遍歷，不能修改。
敲一個 Iterator 的 Demo 探究一下
public class Test3 {
public static void main(String[] args) {
List<String> list = new ArrayList<String>();
list.add("張三");
list.add("李四");
list.add("王五");
list.add("趙六");
Iterator<String> iterator = list.iterator();
String first = iterator.next();
System.out.println("first: " + first);
System.out.println("-----------next-------------");
while (iterator.hasNext()){
System.out.println(iterator.next());
}
iterator.remove();
System.out.println("-----------list-------------");
for (String name: list){
System.out.println(name);
}
}
}
複製程式碼輸出結果
first: 張三
-----------next-------------
李四
王五
趙六
-----------list-------------
張三
李四
王五
複製程式碼可以看到 Iterator.remove() 會刪除原來的 List 物件的資料
再敲一個 ListIterator 的 Demo 探究一下
public class Test2 {
public static void main(String[] args) {
List<String> list = new ArrayList<String>();
list.add("張三");
list.add("李四");
list.add("王五");
list.add("趙六");
ListIterator<String> listIterator = list.listIterator();
String first = listIterator.next();
listIterator.set("小明");
System.out.println("first: " + first);
System.out.println("-----------next-------------");
listIterator.add("大明");
while (listIterator.hasNext()){
System.out.println(listIterator.nextIndex() + ": " + listIterator.next());
}
listIterator.remove();
System.out.println("------------previous------------");
while (listIterator.hasPrevious()){
System.out.println(listIterator.previousIndex() + ": " + listIterator.previous());
}
System.out.println("-----------list-------------");
for (String name: list){
System.out.println(name);
}
}
}
複製程式碼結果如下
first: 張三
-----------next-------------
2: 李四
3: 王五
4: 趙六
------------previous------------
3: 王五
2: 李四
1: 大明
0: 小明
-----------list-------------
小明
大明
李四
王五
複製程式碼可以看出 ListIterator 的 add、set、remove 方法會直接改變原來的 List 物件，而且可以通過 previous 反向遍歷
Mybatis中的迭代器模式
當查詢資料庫返回大量的資料項時可以使用遊標 Cursor，利用其中的迭代器可以懶載入資料，避免因為一次性載入所有資料導致記憶體奔潰，Mybatis 為 Cursor 介面提供了一個預設實現類 DefaultCursor，程式碼如下
public interface Cursor<T> extends Closeable, Iterable<T> {
boolean isOpen();
boolean isConsumed();
int getCurrentIndex();
}
public class DefaultCursor<T> implements Cursor<T> {
private final DefaultResultSetHandler resultSetHandler;
private final ResultMap resultMap;
private final ResultSetWrapper rsw;
private final RowBounds rowBounds;
private final ObjectWrapperResultHandler<T> objectWrapperResultHandler = new ObjectWrapperResultHandler<T>();
// 遊標迭代器
private final CursorIterator cursorIterator = new CursorIterator();
protected T fetchNextUsingRowBound() {
T result = fetchNextObjectFromDatabase();
while (result != null && indexWithRowBound < rowBounds.getOffset()) {
result = fetchNextObjectFromDatabase();
}
return result;
}
@Override
public Iterator<T> iterator() {
if (iteratorRetrieved) {
throw new IllegalStateException("Cannot open more than one iterator on a Cursor");
}
iteratorRetrieved = true;
return cursorIterator;
}
private class CursorIterator implements Iterator<T> {
T object;
int iteratorIndex = -1;
@Override
public boolean hasNext() {
if (object == null) {
object = fetchNextUsingRowBound();
}
return object != null;
}
@Override
public T next() {
T next = object;
if (next == null) {
next = fetchNextUsingRowBound();
}
if (next != null) {
object = null;
iteratorIndex++;
return next;
}
throw new NoSuchElementException();
}
@Override
public void remove() {
throw new UnsupportedOperationException("Cannot remove element from Cursor");
}
}
// ...
}
複製程式碼遊標迭代器 CursorIterator 實現了 java.util.Iterator 迭代器介面，這裡的迭代器模式跟 ArrayList 中的迭代器幾乎一樣
參考：
劉偉：設計模式Java版
慕課網java設計模式精講 Debug 方式+記憶體分析
Java 集合中關於Iterator 和ListIterator的詳解
推薦閱讀
設計模式 | 簡單工廠模式及典型應用
設計模式 | 工廠方法模式及典型應用
設計模式 | 抽象工廠模式及典型應用
設計模式 | 建造者模式及典型應用
設計模式 | 原型模式及典型應用
設計模式 | 外觀模式及典型應用
設計模式 | 裝飾者模式及典型應用
設計模式 | 介面卡模式及典型應用
設計模式 | 享元模式及典型應用
設計模式 | 組合模式及典型應用
設計模式 | 模板方法模式及典型應用