Java集合框架中,通过modCount来实现Fail-Fast机制

一、Fail-Fast与Fail-Safe

1. Fail-Fast

即是快速失败机制。
遍历集合元素时候,如果集合结构发生了修改立即抛出异常,以防止继续遍历。

2. Fail-Safe

相对于Fail-Fast来讲,不会抛出异常。它会将集合复制出一份以进行操作,存在缺点如下:

  1. 复制过程的额外时间和空间开销。
  2. 不能保证遍历的是最新的内容。

二、Fail-Fast案例

1. 案例一:增强for循环中调用list对象的remove方法移除元素

public class FailFastTest {

    @Test
    @SuppressWarnings("all")
    public void testFail() {
        List<Integer> ints = new ArrayList<>(Arrays.asList(1, 2, 3, 4, 5, 6));
        for (Integer anInt : ints) {
            if (anInt % 3 == 0) {
                // 在用增强for循环遍历的时候,修改集合结构,会抛出ConcurrentModificationException
                ints.remove(anInt);
            }
        }
        ints.forEach(System.out::println);
    }
}

运行结果即是,抛出了并发修改异常。
增强for循环的具体实现,其实是迭代器。所以我们继续看案例二。

java.util.ConcurrentModificationException
    at java.util.ArrayList$Itr.checkForComodification(ArrayList.java:911)
    at java.util.ArrayList$Itr.next(ArrayList.java:861)
    at com.se.FailFastTest.testFail(FailFastTest.java:24)

2. 案例二:迭代器中调用list对象的remove方法移除元素

public class FailFastTest {

    @Test
    @SuppressWarnings("all")
    public void testFail2() {
        // 两种实现交替打开,以观察运行结果
        List<Integer> list = new ArrayList<>(Arrays.asList(1, 2, 3, 4, 5, 6));
//        List<Integer> list = new CopyOnWriteArrayList<>(Arrays.asList(1, 2, 3, 4, 5, 6));

        Iterator<Integer> iterator = list.iterator();
        while(iterator.hasNext()){
            Integer next = iterator.next();
            if (next % 3 == 0) {
                list.remove(next);
            }
        }
        list.forEach(System.out::println);
    }
}

不出意外,运行结果和以上一致,抛出并发修改异常。

三、Fail-Fast实现机制分析

1. 报错源定位

报错的方法,即是【ArrayList类】的【内部类迭代器Itr】的checkForComodification方法。我们来看看代码。

private class Itr implements Iterator<E> {
    // ...省略其他属性
    
    // 【期待修改次数】
    int expectedModCount = modCount;

    @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];
    }

    final void checkForComodification() {
        // 修改次数不一致则抛出异常
        if (modCount != expectedModCount)
            throw new ConcurrentModificationException();
    }

    // ...省略其他方法
}

当modCount与expectedModCount不一致时候,则抛出了并发修改异常。

  1. expectedModCount变量,是内部类迭代器维护的属性。
  2. modCount呢?

2. 相关变量来源及定义——modCount。

modCount是ArrayList抽象类【AbstractList】的属性。用于记录结构修改(如添加、删除)的次数。

public abstract class AbstractList<E> extends AbstractCollection<E> implements List<E> {
    
    // 省略其他属性和方法
    
    protected transient int modCount = 0;
}

实例类ArrayList进行【添加和移除】等操作的时候,会将此属性进行自增操作,标记我们对集合进行了结构修改。以添加为例:

public class ArrayList<E> extends AbstractList<E>
        implements List<E>, RandomAccess, Cloneable, java.io.Serializable {

    public boolean add(E e) {
        ensureCapacityInternal(size + 1);  // Increments modCount!!
        elementData[size++] = e;
        return true;
    }
    
    private void ensureCapacityInternal(int minCapacity) {
        ensureExplicitCapacity(calculateCapacity(elementData, minCapacity));
    }

    private void ensureExplicitCapacity(int minCapacity) {
        modCount++;

        // overflow-conscious code
        if (minCapacity - elementData.length > 0)
            grow(minCapacity);
    }
    
    // ...省略其属性和方法
}

3. 机制分析

迭代时,不论是增强for还是forEach,还是iterator,都会创建一个内部迭代器对象。将modCount的值,赋值给expectedModCount。
这个值在该迭代器生命周期内,是不会修改的。

重新看我们的代码。

public class FailFastTest {

    @Test
    @SuppressWarnings("all")
    public void testFail2() {
        // 两种实现交替打开,以观察运行结果
        List<Integer> list = new ArrayList<>(Arrays.asList(1, 2, 3, 4, 5, 6));
//        List<Integer> list = new CopyOnWriteArrayList<>(Arrays.asList(1, 2, 3, 4, 5, 6));

        Iterator<Integer> iterator = list.iterator();
        while(iterator.hasNext()){
            Integer next = iterator.next();
            if (next % 3 == 0) {
                list.remove(next);
            }
        }
        list.forEach(System.out::println);
    }
}
  1. 报错的行数是第12行next方法。说明检测到了modCount与expectedModCount不一致。
  2. 进行代码调试时发现。
    1. list移除第3个元素list[2]已经成功;
    2. 迭代下一个元素list[3] = 4时,抛出异常。

4. Fail-Fast理解

  1. 移除元素已经成功;
  2. 通过标记变量可以发现它是在迭代时修改,所以阻止了它继续执行,果然是快速失败。

5. 优化替代方案

1) 通过迭代器的remove方法进行移除

迭代器中的remove()方法不带参数,内部维护索引,看它的实现。

private class Itr implements Iterator<E> {
    // ...省略其他属性
    
    // 【期待修改次数】
    int expectedModCount = modCount;

    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();
        }
    }

    // ...省略其他方法
}

该方法每次执行时,会同步list的修改次数到迭代器中,保证一致。所以在进行next迭代时候,不会抛出异常。

2) 通过CopyOnWriteArrayList替代ArrayList

CopyOnWriteArrayList

  1. 当你想要对一块内存进行修改时,我们不在原有内存块中进行操作,而是将内存拷贝一份,在新的内存中进行操作;
  2. 完之后呢,就将指向原来内存指针指向新的内存,原来的内存就可以被回收掉。

具体实现细节不再本文赘述。

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

推荐阅读更多精彩内容