设计模式大总结(五):迭代器模式

前言#

说到迭代器,所有的Java开发者都不陌生,例如HashSet,当我们需要遍历HashSet的时候,通过iterator不停的next就可以循环遍历集合中的所有元素。但是这么做到底有什么好处呢?

1、使用者不需要关心HashSet内部的实现,不关心遍历的规则(正序倒序等)

2、正因为使用者不需要关心HashSet的内部实现,所以设计者可以随意更改遍历的规则,对使用无影响。

回想一下我们之前分析过HashMap的内部实现,实际上和HashSet是差不多的,面对如此多的代码,我们只需要使用iterator能够遍历就可以了。

正文#

使用迭代器模式,我们可以自己定义接口,但是在JDK中已经有定义好的迭代器接口,可以满足大部分的使用场景:

public interface Iterator<E> {
    boolean hasNext();
    E next();
    default void remove() {
        throw new UnsupportedOperationException("remove");
    }
    default void forEachRemaining(Consumer<? super E> action) {
        Objects.requireNonNull(action);
        while (hasNext())
            action.accept(next());
    }
}

一般情况,我们只需要实现hasNext和next方法就可以了。

接下来我们就下一个简单的例子:

定义自己的集合MyCollection,通过迭代器iterator,按照正序返回集合中的对象。

首先,定义我们的MyCollection类:

/**
 * Created by li.zhipeng on 2017/9/21.
 *
 *      自定义集合类
 */

public class MyCollection<T>{

    private List<T> list = new ArrayList<>();

    public void add(T item){
        list.add(item);
    }

    public void remove(T item){
        list.remove(item);
    }

    public Iterator<T> iterator(){
        return new MyIterator(list);
    }

    /**
     * 自定义迭代器
     * */
    private class MyIterator implements Iterator<T>{

        private List<T> dataSource;

        /**
         * 当前位置的指针
         * */
        private int curPos;

        public MyIterator(List<T> data){
            this.dataSource = data;
        }

        @Override
        public boolean hasNext() {
            return curPos < dataSource.size();
        }

        @Override
        public T next() {
            T item = dataSource.get(curPos);
            curPos ++;
            return item;
        }
    }
}

为了简单方便,我在MyCollection内部使用了ArrayList,然后封装了两个方法,添加和删除ArrayList中的元素,iterator()方法返回我们自定义的迭代器,这里还使用了泛型,规定了添加元素的类型,MyCollection的泛型肯定是要和迭代器是一样的,这里就不多说了。

请注意这里的迭代器最好不要公用,尽量返回一个新的迭代器对象,因为如果多线程同时遍历迭代器,这里可能会影响到迭代器的指针,所以我每次都是创建一个新的迭代器。如果你更加关心多线程的并发操作,这里最好每次创建Iterator的时候,应该加入同步锁,传入List的副本,提高多线程并发的安全性。

然后在MyCollection中定义了内部迭代器MyIterator,有一个私有属性curPos,记录遍历的位置指针。

使用private修饰迭代器的原因

之前说过Iterator需要隐藏集合遍历时获取元素的规则,并且这个Iterator也只为我们当前的MyCollection服务,所以公开这个类是一个不明智的选择,我这里选择隐藏这个类,只能通过MyCollection的iterator方法来获取。

大部分的迭代器模式开发中,往往都是隐藏自定义迭代器。

定义完毕,测试一下我们的MyCollection:

public void test(){
        MyCollection<Student> collection = new MyCollection<>();
        collection.add(new Student("1111"));
        collection.add(new Student("2222"));

        Iterator<Student> iterator = collection.iterator();
        while (iterator.hasNext()){
            Student student = iterator.next();
            System.out.println(student.getName());
        }
}
这里写图片描述

确实是按照我们添加的顺序打印了Student的名字。

当我还沉迷于自己的才华无法自拔的时候,产品君说了:我们现在要改成倒序遍历了,你抓紧时间弄一下,明天我们要上线。

如果我之前使用的是for循环,那么我就需要根据功能逻辑,找到遍历的代码,然后一处一处的修改,如果有个100使用的地方,我觉得今晚是没法睡了。

但是机智如我,我早就看穿了产品君骚动的内心,早早的使用了迭代器模式,我只需要对MyIterator做一点小调整:

/**
     * 自定义迭代器
     * */
    private class MyIterator implements Iterator<T>{

        private List<T> dataSource;

        /**
         * 当前位置的指针
         * */
        private int curPos;

        public MyIterator(List<T> data){
            this.dataSource = data;
            // 把遍历开始的指针,放到最后一个
            curPos = data.size() - 1;
        }

        @Override
        public boolean hasNext() {
            // 修改是否遍历的结束条件,这里需要大于0
//            return curPos < dataSource.size();
            return curPos >= 0;
        }

        @Override
        public T next() {
            T item = dataSource.get(curPos);
            // 这里要把位置--
//            curPos ++;
            curPos--;
            return item;
        }
    }
这里写图片描述

运行完美~

总结#

经过Demo的实际使用,我们看到了迭代器模式是对于集合遍历规则的封装,当一个集合类被大量使用,而这个时候需要修改遍历规则,如果没有迭代器模式,对于开发者来说是多么的蛋疼。

如果集合类需要多种遍历规则,你也可以指定多套迭代器,这个大家按需开发就好,之后的维护我们就能深刻感受到,几行代码就轻松解放我们的双手的快感。

今天的内容就到此结束了,有问题欢迎留言讨论,一起进步。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 213,014评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,796评论 3 386
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 158,484评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,830评论 1 285
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,946评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,114评论 1 292
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,182评论 3 412
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,927评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,369评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,678评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,832评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,533评论 4 335
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,166评论 3 317
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,885评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,128评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,659评论 2 362
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,738评论 2 351

推荐阅读更多精彩内容