設計模式(十七)迭代器模式

迭代器模式java

迭代器模式(Iterator Pattern):提供一種方法來訪問聚合對象,而不用暴露這個對象的內部表示,其別名爲遊標(Cursor)。迭代器模式是一種對象行爲型模式。算法

角色數據庫

Iterator(抽象迭代器):它定義了訪問和遍歷元素的接口,聲明瞭用於遍歷數據元素的方法,例如:用於獲取第一個元素的first()方法,用於訪問下一個元素的next()方法,用於判斷是否還有下一個元素的hasNext()方法,用於獲取當前元素的currentItem()方法等,在具體迭代器中將實現這些方法。bash

ConcreteIterator(具體迭代器):它實現了抽象迭代器接口,完成對聚合對象的遍歷,同時在具體迭代器中經過遊標來記錄在聚合對象中所處的當前位置,在具體實現時,遊標一般是一個表示位置的非負整數。app

Aggregate(抽象聚合類):它用於存儲和管理元素對象,聲明一個createIterator()方法用於建立一個迭代器對象,充當抽象迭代器工廠角色。dom

ConcreteAggregate(具體聚合類):它實現了在抽象聚合類中聲明的createIterator()方法,該方法返回一個與該具體聚合類對應的具體迭代器ConcreteIterator實例。ide

在迭代器模式中,提供了一個外部的迭代器來對聚合對象進行訪問和遍歷,迭代器定義了一個訪問該聚合元素的接口,而且能夠跟蹤當前遍歷的元素,瞭解哪些元素已經遍歷過而哪些沒有。迭代器的引入,將使得對一個複雜聚合對象的操做變得簡單。源碼分析

在迭代器模式中應用了工廠方法模式,抽象迭代器對應於抽象產品角色,具體迭代器對應於具體產品角色,抽象聚合類對應於抽象工廠角色,具體聚合類對應於具體工廠角色。測試

示例fetch

咱們來實現一個學生報數的示例

定義一個學生類,有一個報數方法 count()

@Getter
@Setter
@ToString
public class Student {
    private String name;
    private Integer number;

    public Student(String name, Integer number) {
        this.name = name;
        this.number = number;
    }

    public void count() {
        System.out.println(String.format("我是 %d 號 %s", this.number, this.name));
    }
}


複製代碼

定義班級接口和班級類

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 中的迭代器幾乎同樣

note:被分吹散的是否叫從前,那些年落下太多流連。

相關文章
相關標籤/搜索