設(shè)計(jì)模型系列 — 迭代器模式

點(diǎn)贊再看号显,養(yǎng)成習(xí)慣雷蹂,公眾號搜一搜【一角錢技術(shù)】關(guān)注更多原創(chuàng)技術(shù)文章废酷。本文 GitHub org_hejianhui/JavaStudy 已收錄朵你,有我的系列文章崭添。

前言

23種設(shè)計(jì)模式快速記憶的請看上面第一篇,本篇和大家一起來學(xué)習(xí)迭代器模式相關(guān)內(nèi)容吭历。

在現(xiàn)實(shí)生活以及程序設(shè)計(jì)中堕仔,經(jīng)常要訪問一個(gè)聚合對象中的各個(gè)元素,如“數(shù)據(jù)結(jié)構(gòu)”中的鏈表遍歷晌区,通常的做法是將鏈表的創(chuàng)建和遍歷都放在同一個(gè)類中摩骨,但這種方式不利于程序的擴(kuò)展通贞,如果要更換遍歷方法就必須修改程序源代碼,這違背了 “開閉原則”恼五。

既然將遍歷方法封裝在聚合類中不可取昌罩,那么聚合類中不提供遍歷方法,將遍歷方法由用戶自己實(shí)現(xiàn)是否可行呢灾馒?答案是同樣不可取峡迷,因?yàn)檫@種方式會(huì)存在兩個(gè)缺點(diǎn):

  1. 暴露了聚合類的內(nèi)部表示,使其數(shù)據(jù)不安全你虹;
  2. 增加了客戶的負(fù)擔(dān)。

迭代器模式”能較好地克服以上缺點(diǎn)彤避,它在客戶訪問類與聚合類之間插入一個(gè)迭代器傅物,這分離了聚合對象與其遍歷行為,對客戶也隱藏了其內(nèi)部細(xì)節(jié)琉预,且滿足“單一職責(zé)原則”和“開閉原則”董饰,如 Java 中的 Collection、List圆米、Set卒暂、Map 等都包含了迭代器。

模式定義

提供一個(gè)對象來順序訪問聚合對象中的一系列數(shù)據(jù)娄帖,而不暴露聚合對象的內(nèi)部表示也祠。迭代器模式是一種對象行為型模式。

迭代器模式是通過將聚合對象的遍歷行為分離出來近速,抽象成迭代器類來實(shí)現(xiàn)的诈嘿,其目的是在不暴露聚合對象的內(nèi)部結(jié)構(gòu)的情況下,讓外部代碼透明地訪問聚合的內(nèi)部數(shù)據(jù)削葱。

解決的問題

不同的方式來遍歷整個(gè)整合對象奖亚。

模式組成

組成(角色) 作用
抽象聚合(Aggregate)角色 定義存儲、添加析砸、刪除聚合對象以及創(chuàng)建迭代器對象的接口昔字。
具體聚合(ConcreteAggregate)角色 實(shí)現(xiàn)抽象聚合類,返回一個(gè)具體迭代器的實(shí)例首繁。
抽象迭代器(Iterator)角色 定義訪問和遍歷聚合元素的接口作郭,通常包含 hasNext()、first()蛮瞄、next() 等方法所坯。
具體迭代器(Concretelterator)角色 實(shí)現(xiàn)抽象迭代器接口中所定義的方法,完成對聚合對象的遍歷挂捅,記錄遍歷的當(dāng)前位置芹助。

使用步驟

步驟1:定義抽象迭代器角色堂湖。迭代器角色負(fù)責(zé)定義訪問和遍歷元素的接口,一般包括3個(gè)方法状土,即訪問下一個(gè)元素next()无蜂,元素是否已經(jīng)訪問到底部hasNext(),以及刪除當(dāng)前指向的元素remove()蒙谓。

interface Iterator {
    Object first();

    Object next();

    boolean hasNext();
}

步驟2:定義具體迭代器角色斥季。

class ConcreteIterator implements Iterator {
    private List<Object> list = null;
    private int index = -1;

    public ConcreteIterator(List<Object> list) {
        this.list = list;
    }

    public boolean hasNext() {
        if (index < list.size() - 1) {
            return true;
        } else {
            return false;
        }
    }

    public Object first() {
        index = 0;
        Object obj = list.get(index);
        ;
        return obj;
    }

    public Object next() {
        Object obj = null;
        if (this.hasNext()) {
            obj = list.get(++index);
        }
        return obj;
    }
}

步驟3:定義抽象聚合角色。

interface Aggregate {
    public void add(Object obj);

    public void remove(Object obj);

    public Iterator getIterator();
}

步驟4:定義具體聚合角色累驮。

class ConcreteAggregate implements Aggregate {
    private List<Object> list = new ArrayList<Object>();

    public void add(Object obj) {
        list.add(obj);
    }

    public void remove(Object obj) {
        list.remove(obj);
    }

    public Iterator getIterator() {
        return (new ConcreteIterator(list));
    }
}

步驟5:測試

聚合的內(nèi)容有:北京   上海  深圳  
First:北京

優(yōu)點(diǎn)

  1. 訪問一個(gè)聚合對象的內(nèi)容而無須暴露它的內(nèi)部表示酣倾。
  2. 遍歷任務(wù)交由迭代器完成,這簡化了聚合類谤专。
  3. 它支持以不同方式遍歷一個(gè)聚合躁锡,甚至可以自定義迭代器的子類以支持新的遍歷。
  4. 增加新的聚合類和迭代器類都很方便置侍,無須修改原有代碼映之。
  5. 封裝性良好,為遍歷不同的聚合結(jié)構(gòu)提供一個(gè)統(tǒng)一的接口蜡坊。

缺點(diǎn)

增加了類的個(gè)數(shù)杠输,這在一定程度上增加了系統(tǒng)的復(fù)雜性。

應(yīng)用場景

  1. 當(dāng)需要為聚合對象提供多種遍歷方式時(shí)秕衙。
  2. 當(dāng)需要為遍歷不同的聚合結(jié)構(gòu)提供一個(gè)統(tǒng)一的接口時(shí)蠢甲。
  3. 當(dāng)訪問一個(gè)聚合對象的內(nèi)容而無須暴露其內(nèi)部細(xì)節(jié)的表示時(shí)。

由于聚合與迭代器的關(guān)系非常密切据忘,所以大多數(shù)語言在實(shí)現(xiàn)聚合類時(shí)都提供了迭代器類峡钓,因此大數(shù)情況下使用語言中已有的聚合類的迭代器就已經(jīng)夠了。

模式的擴(kuò)展

迭代器模式常常與組合模式結(jié)合起來使用若河,在對組合模式中的容器構(gòu)件進(jìn)行訪問時(shí)能岩,經(jīng)常將迭代器潛藏在組合模式的容器構(gòu)成類中。當(dāng)然萧福,也可以構(gòu)造一個(gè)外部迭代器來對容器構(gòu)件進(jìn)行訪問拉鹃,其結(jié)構(gòu)如下:


源碼中的應(yīng)用

Java 中的容器對象有很多,基本都涉及到迭代器鲫忍,我們以 ArrayList 作為例子膏燕,剖析它是如何應(yīng)用迭代器模式的。

Java集合框架:List, Set, Map 都支持迭代


ArrayList 源碼可以發(fā)現(xiàn):

  • ArrayList 實(shí)現(xiàn)了 List 接口悟民,使用 Object 數(shù)組存儲元素坝辫;
  • 在 List 接口中定義了 iterator() 以及很多對操作集合的方法;
  • 在 ArrayList 中對 iterator() 進(jìn)行了重寫射亏,并返回一個(gè) Itr 對象近忙;
  • Itr 是 ArrayList 的內(nèi)部類竭业,并且實(shí)現(xiàn)了 Iterator 接口。
部分源碼展示

List接口

public interface List<E> extends Collection<E> {
    Iterator<E> iterator();
}

Iterator接口

public interface Iterator<E> {
    
    boolean hasNext();
    E next();
    default void remove() {
        throw new UnsupportedOperationException("remove");
    }
}

ArrayList類和Itr類

public class ArrayList<E> extends AbstractList<E>
        implements List<E>, RandomAccess, Cloneable, java.io.Serializable{
    public Iterator<E> iterator() {
        return new Itr();
    }
    //Itr內(nèi)部類
    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;
        }
        @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();
        }
    }
}

PS:以上代碼提交在 Githubhttps://github.com/Niuh-Study/niuh-designpatterns.git

文章持續(xù)更新及舍,可以公眾號搜一搜「 一角錢技術(shù) 」第一時(shí)間閱讀未辆, 本文 GitHub org_hejianhui/JavaStudy 已經(jīng)收錄,歡迎 Star锯玛。

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末咐柜,一起剝皮案震驚了整個(gè)濱河市,隨后出現(xiàn)的幾起案子攘残,更是在濱河造成了極大的恐慌拙友,老刑警劉巖,帶你破解...
    沈念sama閱讀 222,252評論 6 516
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件歼郭,死亡現(xiàn)場離奇詭異献宫,居然都是意外死亡,警方通過查閱死者的電腦和手機(jī)实撒,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 94,886評論 3 399
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來涉瘾,“玉大人知态,你說我怎么就攤上這事×⑴眩” “怎么了负敏?”我有些...
    開封第一講書人閱讀 168,814評論 0 361
  • 文/不壞的土叔 我叫張陵,是天一觀的道長秘蛇。 經(jīng)常有香客問我其做,道長,這世上最難降的妖魔是什么赁还? 我笑而不...
    開封第一講書人閱讀 59,869評論 1 299
  • 正文 為了忘掉前任妖泄,我火速辦了婚禮,結(jié)果婚禮上艘策,老公的妹妹穿的比我還像新娘蹈胡。我一直安慰自己,他們只是感情好朋蔫,可當(dāng)我...
    茶點(diǎn)故事閱讀 68,888評論 6 398
  • 文/花漫 我一把揭開白布罚渐。 她就那樣靜靜地躺著,像睡著了一般驯妄。 火紅的嫁衣襯著肌膚如雪荷并。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 52,475評論 1 312
  • 那天青扔,我揣著相機(jī)與錄音源织,去河邊找鬼翩伪。 笑死,一個(gè)胖子當(dāng)著我的面吹牛雀鹃,可吹牛的內(nèi)容都是我干的幻工。 我是一名探鬼主播,決...
    沈念sama閱讀 41,010評論 3 422
  • 文/蒼蘭香墨 我猛地睜開眼黎茎,長吁一口氣:“原來是場噩夢啊……” “哼囊颅!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起傅瞻,我...
    開封第一講書人閱讀 39,924評論 0 277
  • 序言:老撾萬榮一對情侶失蹤踢代,失蹤者是張志新(化名)和其女友劉穎,沒想到半個(gè)月后嗅骄,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體胳挎,經(jīng)...
    沈念sama閱讀 46,469評論 1 319
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 38,552評論 3 342
  • 正文 我和宋清朗相戀三年溺森,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了慕爬。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 40,680評論 1 353
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡屏积,死狀恐怖医窿,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情炊林,我是刑警寧澤姥卢,帶...
    沈念sama閱讀 36,362評論 5 351
  • 正文 年R本政府宣布,位于F島的核電站渣聚,受9級特大地震影響独榴,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜奕枝,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 42,037評論 3 335
  • 文/蒙蒙 一棺榔、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧隘道,春花似錦掷豺、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 32,519評論 0 25
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至默辨,卻和暖如春德频,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背缩幸。 一陣腳步聲響...
    開封第一講書人閱讀 33,621評論 1 274
  • 我被黑心中介騙來泰國打工壹置, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留竞思,地道東北人。 一個(gè)月前我還...
    沈念sama閱讀 49,099評論 3 378
  • 正文 我出身青樓钞护,卻偏偏與公主長得像盖喷,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個(gè)殘疾皇子难咕,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 45,691評論 2 361