对fast-fail机制(ConcurrentModificationException)的备忘小结

Collection下如List、Set等是我们常用的数据结构,良好的使用这些结构和提供的工具类,能帮助我们极大的提高开发效率。比如其中基于迭代器模式所实现的Iterator和封装的foreach是比较常用的遍历神器。

但是在实际使用iterator和foreach的开发过程中,有时候会遇到一些ConcurrentModificationException的错误,可能会造成不熟悉这些数据结构的同学觉得比较迷惑。而有时候,虽然清楚会存在这种潜在的问题,但是总是忘记哪种方式才是安全的。因此这里做一个小结,避免出现遗忘的时候又要重新看源码的情况。

Exception in thread "main" java.util.ConcurrentModificationException
    at java.util.ArrayList$Itr.checkForComodification(ArrayList.java:901)
    at java.util.ArrayList$Itr.next(ArrayList.java:851)
    at com.company.Main.singleThreadDeleteFail(Main.java:69)
    at com.company.Main.main(Main.java:40)

总的来说,fast-fail的发生只会发生在迭代期间做出了数据修改的情况下(因为Collection下的数据结构情况都差不多,就没有每个都去细细分析了,这里仅以ArrayList为例,如果其它Set之类的结构有差异化的地方,需要自己多注意下):

分类 方法 fast-fail问题 线程安全
foreach ArrayList.remove yes no
Iterator ArrayList.remove yes no
Iterator Iterator.remove no no
CopyOnWriteArrayList ArrayList.remove no depends
CopyOnWriteArrayList Iterator.remove not support not support
synchronizedList ArrayList.remove yes yes
synchronizedList Iterator.remove no no

下面我们根据每种情况的源码,来具体分析以下:

foreach

foreach的功能在实际使用种应该是最常见的,因为确实十分方便而且代码会变得十分简洁和清晰。因为foreach本身内部不会有再次使用iterator的情况,因此我们仅考虑ArrayList自身的remove情况。

我们重点关注以下代码,从中可以发现在foreach的循环过程中,一旦检测到modCount和expectedModCount不一致就会导致遍历中断,且抛出ConcurrentModificationException。而之所以modCount和expectedModCount会不一致就是因为数据结构自身的Remove等方法会改变起ModCount值:

    @Override
    public void forEach(Consumer<? super E> action) {
        Objects.requireNonNull(action);
        final int expectedModCount = modCount;
        @SuppressWarnings("unchecked")
        final E[] elementData = (E[]) this.elementData;
        final int size = this.size;
        for (int i=0; modCount == expectedModCount && i < size; i++) {
            action.accept(elementData[i]);
        }

        // 犯人就是你!
        if (modCount != expectedModCount) {
            throw new ConcurrentModificationException();
        }
    }


    public E remove(int index) {
        rangeCheck(index);

        // 凶器和犯罪动机在这里!
        modCount++;
        E oldValue = elementData(index);
        int numMoved = size - index - 1;
        if (numMoved > 0)
            System.arraycopy(elementData, index+1, elementData, index,numMoved);
        elementData[--size] = null; // clear to let GC do its work
        return oldValue;
    }

iterator

iterator在这种需要一边遍历一边修改的场景下,应该就是最推荐的实现方式了,因为其Iterator.Remove方法不仅不会造成Fast-fail问题,而且实现起来也简单。但是值得注意的是,在使用Iterator的场景下,直接使用ArrayList的remove方法也是不行的(会抛出ConcurrentModificationException),原因如下,在Iterator的Remove方法中,会设置expectedModCount = modCount从而造成了不会抛出异常:

    // ArrayList自身的remove方法
    public E remove(int index) {
        rangeCheck(index);
        modCount++;
        E oldValue = elementData(index);
        int numMoved = size - index - 1;
        if (numMoved > 0)
            System.arraycopy(elementData, index+1, elementData, index, numMoved);
        elementData[--size] = null; // clear to let GC do its work
        return oldValue;
    }

    // Iterator提供的remove方法
    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();
        }
    }

CopyOnWriteArrayList

网上很多的资料里面都推荐使用CopyOnWriteArrayList的方式来解决Fast-fail问题,诚然这是没有问题的,透过CopyOnWriteArrayList的原理我们发现,其实质是通过不断的拷贝数组来最终实现了所有的Remove和Add等方法,自然前后两个ArrayList已经不是同一个对象了(而是互相独立的两个对象),自然修改也不会带来Fast-fail问题,而且在这种修改过程中通过ReentrantLock来保证了复制和修改的原子性。这种实现且不论空间和时间的多余消耗,会给人一种是多线程安全的错觉,因为确实他是线程安全的,但是问题是两个线程操作的完全可能是不同的两个对象(也因此线程安全一项里面我觉得应该给出depands的结果)。也大概可以看一下其代码实现,copy是关键所在:

    public E remove(int index) {
        final ReentrantLock lock = this.lock;
        lock.lock();
        try {
            Object[] elements = getArray();
            int len = elements.length;
            E oldValue = get(elements, index);
            int numMoved = len - index - 1;
            if (numMoved == 0)

                // 犯人就是你!
                setArray(Arrays.copyOf(elements, len - 1));
            else {
                Object[] newElements = new Object[len - 1];

                // 犯人就是你!
                System.arraycopy(elements, 0, newElements, 0, index);
                System.arraycopy(elements, index + 1, newElements, index,
                                 numMoved);
                setArray(newElements);
            }
            return oldValue;
        } finally {
            lock.unlock();
        }
    }

还有个值得注意的问题是,因为CopyOnWriteArrayList是不支持Iterator的Remove方法的,所以这个乱用是要抛出异常的(具体代码就不贴了)

synchronizedList

最后想说一下synchronizedList这个这个数据结构。它和ArrayList本身的实现其实完全是一致的,只是在实现中加入了sychronised关键字保证其线程安全性。
但是需要特别注意的是,如果使用Iterator需要自己来保证线程安全。这一点比较容易忽略掉。

public E remove(int index) {
    synchronized (mutex) {return list.remove(index);}
}

public ListIterator<E> listIterator() {
    return list.listIterator(); // Must be manually synched by user
}

结语

其实仔细品味一下fast-fail设计,可以感受到作者在考虑到尽量保护数据一致性和避免一些不可预期的错误的初衷,也对我们的具体使用会有很大的帮助来避免一些比较难以察觉到的问题。
越过这种机制本身会给我们具体的编码中带来一些问题,就更需要我们充分的明白其中的原理和缺陷,做到更好的掌控代码的质量,不要掉到深坑里面。

Anyway,enjoy~ : )

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

推荐阅读更多精彩内容