Iterator迭代器使用注意事项

1、Iterator迭代器

我们在平常经常会使用到foreach,for关键字,其实他们的内部原理使用的都是Iterator迭代器的原理。
但是在使用的时候需要注意的是,如果在遍历的过程中增加元素、删除元素等改变了List、HashMap之类的List的结构时,会产生ConcurrentModificationException(并发修改)异常。

2、分析

我们使用HashMap来分析,先看下面的一段代码:

HashMap<String, String> map = new HashMap<>();
map.put("1", "111");
map.put("2", "222");
map.put("3", "333);
Iterator<Map.Entry<String, String>> iterator = map.entrySet().iterator();
while(iterator.hasNext()) {
    Map.Entry<String, String> entry = iterator.next(); //这里会引发ConcurrentModificationException异常
    String key = entry.getKey();
    String value = entry.getValue();
    if(value.equals("111") {
        map.remove(key); 
        //map.put("444");
    }
}

从引发异常的代码行跟踪进去,进入到HashMap的HashIterator类,该类实现了Iterator接口。而next()方法最终会执行到nextEntry()方法。看一下nextEntry()方法的实现:

final Entry<K,V> nextEntry() {
    if (modCount != expectedModCount)
        throw new ConcurrentModificationException();
    HashMapEntry<K,V> e = next;
    if (e == null)
        throw new NoSuchElementException();

    if ((next = e.next) == null) {
        HashMapEntry[] t = table;
        while (index < t.length && (next = t[index++]) == null)
            ;
    }
    current = e;
    return e;
}

可以看到抛出异常的原因是modCount != expectedModCount。modCount是HashMap中的一个变量,当HashMap结构改变时(比如put进去了一个新的元素,删除了一个新的元素等),这个modCount记录的是改变的次数,而expectedModCount是HashIterator类对象的一个变量,在HashIterator构造函数中赋值,如下所示:

HashIterator() {
    expectedModCount = modCount;
    if (size > 0) { // advance to first entry
        HashMapEntry[] t = table;
        while (index < t.length && (next = t[index++]) == null)
            ;
    }
}

上面的expectedModCount = modCount即为赋值语句。
返回上面举的例子,当我们在遍历HashMap时删除了一个元素,即map.remove(key); 最终执行removeEntryForKey(key)方法,在该方法中执行了modCount++,也即modCount的值改变了。当在HashIterator中继续往下执行到nextEntry()方法时,由于modCount的值不等于expectedModCount,那么就抛出了ConcurrentModificationException异常。

3、为什么不相等就抛出异常

我们发散一下,如果将if (modCount != expectedModCount)这句判断语句去掉呢?
来看一种情况,还是用上面的remove(key)作为例子,如果这个key刚好是下一个需要访问到的key呢?顺着nextEntry()看下来:

final Entry<K,V> nextEntry() {
        ...省略
    HashMapEntry<K,V> e = next;
        ...省略
    if ((next = e.next) == null) {
        HashMapEntry[] t = table;
        while (index < t.length && (next = t[index++]) == null)
            ;
    }
    current = e;
    return e;
}

我们将异常的情况去掉。这个时候next就是我们之前删除掉的entry,这个entry.next为空,进入if语句块,if语句块要做的事情是,从index开始寻找下一个不为空的元素。而index的值是entry还没有被删除时所处的位置。说起来听抽象的,还是看图说话好了:



例如,我们在遍历的时候删除了3号的元素,这个时候index指向了下一个元素,即index=3。当我们继续执行nextEntry时,由于hasMap改变了,也即table改变了,那么下次访问到就是5号的元素,也就是说4号元素完全没有被我们访问到,所以这是有问题的。所以Java规定了如果HashMap的结构发生了变化,那么就抛出并发修改异常。

4、怎么在遍历时增加或者删除元素?

上面分析了既然在遍历时不允许删除HashMap的元素,那么我们有什么样的方法删除或者添加吗?因为我们在工作时肯定会遇到这样的问题的。
对于删除,我们可以看到Iterator有一个remove()的方法。而HashIterator的remove()方法如下:

public void remove() {
    if (current == null)
        throw new IllegalStateException();
    if (modCount != expectedModCount)
        throw new ConcurrentModificationException();
    Object k = current.key;
    current = null;
    HashMap.this.removeEntryForKey(k);
    expectedModCount = modCount;
}

可以看到在这里通过调用HashMap的removeEntryForKey删除了当前的元素,并且同步地将expectedModCount修改为modCount,所以下次执行nextEntry()方法时就不会报并发修改异常了。

上面的情况只是在单线程不会出问题,但是如果在多线程下,即使使用了remove()方法,也会有可能出现ConcurrentModificationException错误。所以在多线程下为了保证现场安全,我们需要对要操作的HashMap进行一个加锁操作,这样就可以防止在遍历的过程中有其他现场去修改HashMap的结构,从而导致出现ConcurrentModificationException错误。

那么如果我们想要添加元素呢?好像Iterator只实现了remove()这样一个方法,对于其他操作并没有为我们实现,那么我们就需要自己来实现了:

    LinkedList<Map.Entry<String, String>> tempList = new LinkedList<Map.Entry<String, String>>();
    tempList.addAll(map.entrySet());
    ListIterator<Map.Entry<String, String>> itor = tempList.listIterator();
    Map.Entry entry = null;

    while (itor.hasNext()) {
         entry = (Map.Entry) itor.next();
         Object key = entry.getKey();

         if (key.toString().equals("3")) {
            map.put("33", "33");
         }
    }

我们可以使用一个LinkedList来装载HashMap的entrySet,然后在遍历时修改或者添加map的元素,由于该LinkedList的Iterator和HashMap的Iterator是不同的对象,所以不用担心会引发并发修改异常。

5、文档参考:

http://www.cnblogs.com/Scott007/p/3560255.html

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

推荐阅读更多精彩内容