行為型模式:迭代器模式

LieBrother發表於2019-02-28

LieBrother原文行為型模式:迭代器模式

景

十一大行為型模式之六:迭代器模式。

簡介

姓名 :迭代器模式

英文名 :Iterator Pattern

價值觀 :人生沒有回頭路

個人介紹

Provide a way to access the elements of an aggregate object sequentially without exposing its underlying representation. 它提供一種方法訪問一個容器物件中各個元素,而又不需暴露該物件的內部細節。 (來自《設計模式之禪》)

你要的故事

大傢伙聽歌頻率高麼?是不是經常聽歌曲來放鬆心情?我是經常會聽歌,心情不好的時候聽歌,心情好的時候也聽歌。。。今天講的迭代器模式,我們就拿聽歌這件事來說說,大家都知道聽歌有幾種模式:單曲迴圈、列表迴圈、隨機等等。。。現在網易雲音樂還多了一個心動模式。

既然說到迭代器模式,那這裡就要著重講講列表迴圈這個聽歌模式,其他的就先拋到腦後。在列表迴圈中,歌曲從第一條播放到最後一條,也就是一個遍歷歌單的過程。我們有 2 種實現方式,一種是沒有迭代器,通過獲取歌單,用 for 迴圈遍歷每一個歌曲,然後播放;另外一種是使用迭代器,獲取歌單的一個迭代器,通過迭代器來遍歷每一個歌曲,然後播放。下面我們就用程式碼來實現這 2 種方式。

木有迭代器

public class NoIteratorTest {

    public static void main(String[] args) {
        NetEaseMusic1 netEaseMusic1 = new NetEaseMusic1();
        netEaseMusic1.listenToMusicByLoop();
    }
}

/**
 * 網易雲音樂
 */
class NetEaseMusic1 {

    private IList1 songList;

    public NetEaseMusic1() {
        songList = new SongList1(3);
        songList.add(new Song("讓我留在你身邊", "陳奕迅"));
        songList.add(new Song("你曾是少年", "SHE"));
        songList.add(new Song("Perfect", "Ed Sheeran"));
    }

    /**
     * 列表迴圈
     */
    public void listenToMusicByLoop() {
        for (int i = 0; i < songList.size(); i++) {
            System.out.println("聽歌:" + ((ISong)songList.get(i)).getSongInfo());
        }
    }

}

/**
 * 容器介面
 */
interface IList1 {

    void add(Object object);

    Object get(int index);

    int size();
}

/**
 * 歌單
 */
class SongList1 implements IList1 {

    private ISong[] songs;
    private int index;
    private int size;

    public SongList1(int size) {
        songs = new ISong[size];
        index = 0;
        size = 0;
    }

    @Override
    public void add(Object object) {
        songs[index++] = (ISong) object;
        size ++;
    }

    @Override
    public Object get(int index) {
        if (index < size) {
            return songs[index];
        }
        return null;
    }

    @Override
    public int size() {
        return size;
    }
}


/**
 * 歌曲介面
 */
interface ISong {
    String getSongInfo();
}

/**
 * 歌曲
 */
class Song implements ISong{

    private String name;
    private String singer;

    public Song(String name, String singer) {
        this.name = name;
        this.singer = singer;
    }

    @Override
    public String getSongInfo() {
        return this.name + "--" + this.singer;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public String getSinger() {
        return singer;
    }

    public void setSinger(String singer) {
        this.singer = singer;
    }

}

列印結果:
聽歌:讓我留在你身邊--陳奕迅
聽歌:你曾是少年--SHE
聽歌:Perfect--Ed Sheeran
複製程式碼

我們定義了 ISong 介面,裡面有個 getSongInfo() 方法來獲取歌曲資訊,用 Song 類來定義歌曲。沒有用 Java 自帶的容器來存放歌曲,這裡實現了一個自定義容器介面 IList1,定義 SongList1 來做歌曲的容器,為什麼不用 Java 自帶的 ArrayList 等等?因為 Java 自帶的已經實現了迭代器功能了,我們這裡自定義其實就是在模仿自帶的容器的實現。NetEaseMusic1 類是充當網易雲音樂客戶端,在 listenToMusicByLoop() 方法中,我們可以看到是獲取了歌單 songList,然後一個一個遍歷,這是沒有使用迭代器的程式碼。

下面看一下使用迭代器的程式碼是怎麼樣的。

用迭代器實現遍歷

public class IteratorTest {

    public static void main(String[] args) {
        NetEaseMusic2 netEaseMusic2 = new NetEaseMusic2();
        netEaseMusic2.listenToMusicByLoop();
    }

}

/**
 * 網易雲音樂
 */
class NetEaseMusic2{

    private IList2 songList;

    public NetEaseMusic2() {
        songList = new SongList2(3);
        songList.add(new Song("讓我留在你身邊", "陳奕迅"));
        songList.add(new Song("你曾是少年", "SHE"));
        songList.add(new Song("Perfect", "Ed Sheeran"));
    }

    /**
     * 列表迴圈
     */
    public void listenToMusicByLoop() {
        IIterator iterator = songList.iterator();
        while (iterator.hasNext()) {
            System.out.println("聽歌:" + ((ISong)iterator.next()).getSongInfo());
        }

    }

}

/**
 * 容器介面
 */
interface IList2 {

    IIterator iterator();

    void add(Object object);

    Object get(int index);

    int size();
}

/**
 * 歌單
 */
class SongList2 implements IList2 {

    private ISong[] songs;
    private int index;
    private int size;

    public SongList2(int size) {
        songs = new ISong[size];
        index = 0;
        size = 0;
    }

    @Override
    public IIterator iterator() {
        return new IteratorImpl(this);
    }

    @Override
    public void add(Object object) {
        songs[index++] = (ISong) object;
        size ++;
    }

    @Override
    public Object get(int index) {
        if (index < size) {
            return songs[index];
        }
        return null;
    }

    @Override
    public int size() {
        return size;
    }
}


/**
 * 迭代器
 */
interface IIterator {
    Object next();
    boolean hasNext();
}

/**
 * 迭代器實現類
 */
class IteratorImpl implements IIterator {

    private IList2 list;
    private int index;

    public IteratorImpl(IList2 list) {
        this.list = list;
        this.index = 0;
    }

    @Override
    public Object next() {
        return list.get(index++);
    }

    @Override
    public boolean hasNext() {
        if (index < list.size()) {
            return true;
        }
        return false;
    }
}

列印結果:
聽歌:讓我留在你身邊--陳奕迅
聽歌:你曾是少年--SHE
聽歌:Perfect--Ed Sheeran
複製程式碼

程式碼中我們自定義了一個迭代器介面 IIterator 和迭代器具體實現類 IteratorImpl,有關鍵的 2 個方法,hasNext() 判斷是否有存在下一個元素,next() 獲取下一個元素。而 IList2 介面則比 IList1 介面多了一個獲取迭代器的方法 iterator(),這讓網易雲音樂在遍歷歌單的時候,不用直接使用 songList 來遍歷,而可以通過 songList.iterator() 獲取迭代器來實現遍歷的過程。NetEaseMusic2.listenToMusicByLoop() 這個方法裡面就直接獲取迭代器來遍歷了。

程式碼: Iterator Pattern

總結

迭代器模式是所有設計模式中使用最廣泛的,有不少開發同學知道迭代器,但是不知道它是設計模式的。雖然迭代器的程式碼會比沒有迭代器的程式碼複雜,但是加上迭代器可以讓容器有統一的遍歷程式碼風格,不用各自去實現遍歷方法,有更好的封裝性。在 Java 中,迭代器已經運用很廣泛,比如 Java 中訪問 MySQL 獲取資料就是用迭代器來遍歷資料的。好了,迭代器模式就講到這,大家知道的知識就不多說啦。

參考資料:《大話設計模式》、《設計模式之禪》

推薦閱讀:

行為型模式:策略模式

行為型模式:責任鏈模式

行為型模式:命令模式

希望文章對您有所幫助,設計模式系列會持續更新,感興趣的同學可以關注公眾號:LieBrother,第一時間獲取文章推送閱讀,也可以一起交流,交個朋友。

公眾號

相關文章