Java設計模式之java迭代器模式詳解
前言
很早之前，我們的電視調節頻道是需要用電視上的按鈕去控制的，那時並沒有遙控器，如果我們想要調臺，隻能一次又一次的擰按鈕。
越來越高級的電視機相繼出現，現在的電話機，我們有瞭電視遙控器，我們使用電視遙控器來調臺，這個時候，無需直接操作電視。
我們可以將電視機看成一個存儲電視頻道的集合對象，通過遙控器可以對電視機中的電視頻道集合進行操作，如返回上一個頻道、跳轉到下一個頻道或者跳轉至指定的頻道。遙控器為我們操作電視頻道帶來很大的方便，用戶並不需要知道這些頻道到底如何存儲在電視機中。
介紹
迭代器模式(Iterator Pattern)：提供一種方法來訪問聚合對象，而不用暴露這個對象的內部表示，其別名為遊標(Cursor)。迭代器模式是一種對象行為型模式。
角色
Iterator（抽象迭代器）：它定義瞭訪問和遍歷元素的接口，聲明瞭用於遍歷數據元素的方法，例如：用於獲取第一個元素的first()方法，用於訪問下一個元素的next()方法，用於判斷是否還有下一個元素的hasNext()方法，用於獲取當前元素的currentItem()方法等，在具體迭代器中將實現這些方法。
ConcreteIterator（具體迭代器）：它實現瞭抽象迭代器接口，完成對聚合對象的遍歷，同時在具體迭代器中通過遊標來記錄在聚合對象中所處的當前位置，在具體實現時，遊標通常是一個表示位置的非負整數。
Aggregate（抽象聚合類）：它用於存儲和管理元素對象，聲明一個createIterator()方法用於創建一個迭代器對象，充當抽象迭代器工廠角色。
ConcreteAggregate（具體聚合類）：它實現瞭在抽象聚合類中聲明的createIterator()方法，該方法返回一個與該具體聚合類對應的具體迭代器ConcreteIterator實例。
在迭代器模式中，提供瞭一個外部的迭代器來對聚合對象進行訪問和遍歷，迭代器定義瞭一個訪問該聚合元素的接口，並且可以跟蹤當前遍歷的元素，瞭解哪些元素已經遍歷過而哪些沒有。迭代器的引入，將使得對一個復雜聚合對象的操作變得簡單。
迭代器模式中的工廠模式
在迭代器模式中應用瞭工廠方法模式，抽象迭代器對應於抽象產品角色，具體迭代器對應於具體產品角色，抽象聚合類對應於抽象工廠角色，具體聚合類對應於具體工廠角色。
學院遍歷的案例
編寫程序展示一個學校院系結構：需求是這樣，要在一個頁面中展示出學校的院系 組成， 一個學校有多個學院，一個學院有多個系。
分析
每一個學院都有添加系的功能，如果我們將遍歷的方法hasNext() next()等寫入。這將導致聚合類的職責過重，它既負責存儲和管理數據，又負責遍歷數據，違反瞭“單一職責原則”，由於聚合類非常龐大，實現代碼過長，還將給測試和維護增加難度。
那麼這個時候，我們也許會這樣想，因為有多個學院，我們不妨將學院封裝為接口，但是在這個接口中充斥著大量方法，不利於子類實現，違反瞭“接口隔離原則”。
解決方案
解決方案之一就是將聚合類中負責遍歷數據的方法提取出來，封裝到專門的類中，實現數據存儲和數據遍歷分離，無須暴露聚合類的內部屬性即可對其進行操作，而這正是迭代器模式的意圖所在。
基本介紹
- 迭代器模式（Iterator Pattern）是常用的設計模式，屬於行為型模式
- 如果我們的集合元素是用不同的方式實現的，有數組，還有java的集合類，或者還有其他方式，當客戶端要遍歷這些集合元素的時候就要使用多種遍歷 方式，而且還會暴露元素的內部結構，可以考慮使用迭代器模式解決。
- 迭代器模式，提供一種遍歷集合元素的統一接口，用一致的方法遍歷集合元素， 不需要知道集合對象的底層表示，即：不暴露其內部的結構。
原理類圖
上面案例的類圖
案例實現代碼
頂層迭代器接口為Java內部提供的Iterator接口:
計算機學院迭代器類，負責遍歷計算機學院類下面的系集合
public class ComputerCollegeIterator implements Iterator {
//以數組的方式存放計算機學院下面的各個系
private Department[] departments;
//當前遍歷到的位置
private Integer position=0;
//通過構造器獲得要遍歷的集合
public ComputerCollegeIterator(Department[] departments)
{
this.departments=departments;
}
//判斷是否還存在下一個元素
@Override
public boolean hasNext() {
if(position>departments.length-1||departments[position]==null)
{
return false;
}
return true;
}
//返回下一個元素
@Override
public Object next() {
return departments[position++];
}
//刪除的方法默認空實現
@Override
public void remove()
{}
}
信息學院迭代器類，負責遍歷信息學院下面的系集合
//信息學院
public class InfoCollegeIterator implements Iterator
{
//以list的方式存放系
private List<Department> departments;
//索引
private Integer index=0;
//構造器得到要遍歷的集合
InfoCollegeIterator(List<Department> departments)
{
this.departments=departments;
}
//判斷list集合中是否還有下一個元素
@Override
public boolean hasNext() {
if(index>departments.size()-1)
{
return false;
}
return true;
}
@Override
public Object next() {
return departments.get(index++);
}
@Override
public void remove() {
}
}
這裡對應的各個學院的迭代器類，單獨負責遍歷當前學院下面系集合的邏輯
這裡的優化措施可以將兩個迭代器裡面重復內容抽取出來，放到CollegeIterator類裡面進行默認實現，該類繼承Iterator接口，而上面兩個學院迭代器類繼承該默認實現類
迭代器遍歷集合裡面存放的元素:
@Data
@AllArgsConstructor
@NoArgsConstructor
//學院下面的各個系--也是迭代器需要遍歷的對象
public class Department
{
private String name;//名字
private Integer score;//分數線
}
頂層抽象學院接口
//抽象學院接口
public interface College
{
//獲取當前系的名字
void getName();
//增加系
void addDepartment(String name,Integer score);
//返回一個迭代器，負責遍歷
Iterator createIterator();
}
計算機學院，管理學院下面的各個系
public class ComputerCollege implements College{
//數組默認大小為10
private Department[] departments=new Department[10];
private Integer numOfDepartment=0;//當前數組中保存的對象個數
@Override
public void getName() {
System.out.println("計算機學院");
}
//獲取到對應的系集合
public ComputerCollege(Department[] departments)
{
int i=0;
for (Department department : departments) {
this.departments[i++]=department;
}
}
//增加系
@Override
public void addDepartment(String name,Integer score)
{
Department department=new Department(name,score);
departments[numOfDepartment++]=department;
}
//創建對應的迭代器，並傳入要遍歷的集合給迭代器
@Override
public Iterator createIterator() {
return new ComputerCollegeIterator(departments);
}
}
信息學院，負責管理下面的各個系:
//信息學院
public class InfoCollegeIterator implements Iterator
{
//以list的方式存放系
private List<Department> departments;
//索引
private Integer index=0;
InfoCollegeIterator(List<Department> departments)
{
this.departments=departments;
}
//判斷list集合中是否還有下一個元素
@Override
public boolean hasNext() {
if(index>departments.size()-1)
{
return false;
}
return true;
}
@Override
public Object next() {
return departments.get(index++);
}
@Override
public void remove() {
}
}
輸出類，主要負責輸出功能:
public class OutputImp
{
//學院集合
private List<College> collegeList;
public OutputImp(List<College> collegeList)
{
this.collegeList=collegeList;
}
//輸出所有學院，以及學院下面的所有系
public void printColleges()
{
//獲取到遍歷學院集合需要用到的迭代器
//list集合實現瞭iterator接口
Iterator<College> collegeIterator = collegeList.iterator();
while(collegeIterator.hasNext())
{
College college = collegeIterator.next();
System.out.println("當前學院:");
college.getName();
System.out.println("當前學院下面的系:");
//如果要遍歷當前學院下面的所有系，需要獲取對應的迭代器
printDeparts(college.createIterator());
System.out.println("=============================");
}
}
//輸出當前學院的所有系
protected void printDeparts(Iterator iterator)
{
while(iterator.hasNext())
{
Department department=(Department)iterator.next();
System.out.println(department.getName());
}
}
}
客戶端調用:
public static void main(String[] args) {
List<College> collegeList=new ArrayList<>();
Department[] departments=new Department[3];
departments[0]=new Department("c++",520);
departments[1]=new Department("java",521);
College college=new ComputerCollege(departments);
List<Department> departmentList=new ArrayList<>();
departmentList.add(new Department("密碼學",520));
College college1=new InfoCollege(departmentList);
collegeList.add(college);
collegeList.add(college1);
OutputImp outputImp=new OutputImp(collegeList);
outputImp.printColleges();
}
案例總結
如果需要增加一個新的具體聚合類，隻需增加一個新的聚合子類和一個新的具體迭代器類即可,原有類庫代碼無須修改，符合“開閉原則”；
如果需要為聚合類更換一個迭代器，隻需要增加一個新的具體迭代器類作為抽象迭代器類的子類，重新實現遍歷方法，原有迭代器代碼無須修改，也符合“開閉原則”；
但是如果要在迭代器中增加新的方法，則需要修改抽象迭代器源代碼，這將違背“開閉原則”。
應用實例
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僅能遍歷，不能修改。
角色說明
- 內部類Itr 充當具體實現迭代器Iterator 的類， 作為ArrayList 內部類
- List 就是充當瞭聚合接口，含有一個iterator() 方法，返回一個迭代器對象
- ArrayList 是實現聚合接口List 的子類，實現瞭iterator()
- Iterator 接口系統提供
- 迭代器模式解決瞭 不同集合(ArrayList ,LinkedList) 統一遍歷問題
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 中的迭代器幾乎一樣
優點
- 提供一個統一的方法遍歷對象，客戶不用再考慮聚合的類型，使用一種方法就可以遍歷對象瞭。
- 隱藏瞭聚合的內部結構，客戶端要遍歷聚合的時候隻能取到迭代器，而不會知道聚合的具體組成。
- 提供瞭一種設計思想，就是一個類應該隻有一個引起變化的原因（叫做單一責任
- 原則）。在聚合類中，我們把迭代器分開，就是要把管理對象集合和遍歷對象集
- 合的責任分開，這樣一來集合改變的話，隻影響到聚合對象。而如果遍歷方式改變的話，隻影響到瞭迭代器。
- 當要展示一組相似對象，或者遍歷一組相同對象時使用, 適合使用迭代器模式
缺點
- 每個聚合對象都要一個迭代器，會生成多個迭代器不好管理類
總結
本篇文章就到這裡瞭，希望能夠給你帶來幫助，也希望您能夠多多關註WalkonNet的更多內容!
推薦閱讀：
- Java集合的Collection接口和List接口詳解
- Java設計模式中的組合模式
- Java中Iterator與ListIterator迭代的區別
- Java中關於泛型、包裝類及ArrayList的詳細教程
- java中LinkedList使用迭代器優化移除批量元素原理