Java集合系列04之fail-fast机制分析

系列文章

前言

fail-fast机制是Java集合的一种错误机制,当多个线程对同一集合内容操作时,便可能会出现fail-fast现象。例如:存在两个线程(A、B),A通过Iterator在遍历集合C中的元素过程中,B修改了集合C的内容,程序就可能会抛出 ConcurrentModificationException 异常,出现fail-fast现象。

本文源码分析基于jdk 1.8.0_121

实例展示

下面给出一个实际代码展示,来演示fail-fast现象,如下:

import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;

public class Main {

    private static List<Integer> list = new ArrayList<>();

    public static void main(String[] args) {
        for (int i= 0; i<5; i++){
            list.add(i);
        }
        new ThreadA().start();
        new ThreadB().start();
    }

    static class ThreadA extends Thread{
        public void run(){
            Iterator iter = list.iterator();
            int value = 0;
            while(iter.hasNext()) {
                value = (int)iter.next();
                System.out.println(value+", ");
                try{
                    Thread.sleep(10);
                }catch (InterruptedException e){
                    e.printStackTrace();
                }
            }
        }
    }

    static class ThreadB extends Thread{
        public void run(){
            for (int i = 5;i<10;i++){
                list.add(i);
            }
        }
    }
}

运行以上代码,结果如下:

0,
Exception in thread "Thread-0" java.util.ConcurrentModificationException
    at java.util.ArrayList$Itr.checkForComodification(ArrayList.java:901)
    at java.util.ArrayList$Itr.next(ArrayList.java:851)
    at Main$ThreadA.run(Main.java:22)

需要注意的是,如果我们再加一个子线程C,其代码如下:

static class ThreadC extends Thread{
    public void run(){
        for (int i = 0;i<5;i++){
            list.set(i,i+1);
        }
    }
}

new ThreadA().start();
new ThreadC().start();

当我们同时运行子线程A和子线程C时,程序可以顺利执行,因为子线程没有改变原有list的结构,只是重新给每个索引设置了新的值,运行结果如下:

0, 
2, 
3, 
4, 
5, 

解决办法

对于前面的集合ArrayList其不是线程安全的,LinkedList也不是线程安全的,在多线程的环境下,我们可以使用java.util.concurrent包下的类去取代java.util包下的类来避免并发带来的fail-fast现象;对于ArrayList我们可以使用CopyOnWriteArrayList代替即可。

fail-fast原理

当操作Iterator时,如果抛出ConcurrentModificationException便出现了fail-fast现象,而ArrayListiterator方法返回一个Itr对象,Itr类是ArrayList的内部类:

// Itr是迭代器的实现类
private class Itr implements Iterator<E> {
    int cursor;       // index of next element to return
    int lastRet = -1; // index of last element returned; -1 if no such
    
    // 修改次数的记录值
    // 遍历list元素时,会比较expectedModCount和modCount是否相等
    // 如果不相等,则会抛出异常,出现fail-fast现象
    int expectedModCount = modCount;

    public boolean hasNext() {
        return cursor != size;
    }

    @SuppressWarnings("unchecked")
    public E next() {
        // 判断expectedModCount和modCount是否相等
        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];
    }

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

    @Override
    @SuppressWarnings("unchecked")
    public void forEachRemaining(Consumer<? super E> consumer) {
        Objects.requireNonNull(consumer);
        final int size = ArrayList.this.size;
        int i = cursor;
        if (i >= size) {
            return;
        }
        final Object[] elementData = ArrayList.this.elementData;
        if (i >= elementData.length) {
            throw new ConcurrentModificationException();
        }
        while (i != size && modCount == expectedModCount) {
            consumer.accept((E) elementData[i++]);
        }
        // update once at end of iteration to reduce heap write traffic
        cursor = i;
        lastRet = i - 1;
        checkForComodification();
    }
    
    // 不相等,抛出异常
    final void checkForComodification() {
        if (modCount != expectedModCount)
            throw new ConcurrentModificationException();
    }
}

modCountAbstractList中的一个成员变量,而ArrayList继承自AbstractListArrayList的以下方法会修改modCount

public void trimToSize() {
    modCount++;
    if (size < elementData.length) {
        elementData = (size == 0)
          ? EMPTY_ELEMENTDATA
          : Arrays.copyOf(elementData, size);
    }
}

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

    // overflow-conscious code
    if (minCapacity - elementData.length > 0)
        grow(minCapacity);
}

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

private void fastRemove(int index) {
    modCount++;
    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
}


public void clear() {
    modCount++;

    // clear to let GC do its work
    for (int i = 0; i < size; i++)
        elementData[i] = null;

    size = 0;
}

protected void removeRange(int fromIndex, int toIndex) {
    modCount++;
    int numMoved = size - toIndex;
    System.arraycopy(elementData, toIndex, elementData, fromIndex,
                     numMoved);

    // clear to let GC do its work
    int newSize = size - (toIndex-fromIndex);
    for (int i = newSize; i < size; i++) {
        elementData[i] = null;
    }
    size = newSize;
}

...

从以上我们可以发现,当涉及到修改ArrayList中元素个数的方法(remove(),clear(),ensureExplicitCapacity()...),便会修改modCount

因此在前文演示代码中,子线程A正在通过迭代器遍历集合元素,而子线程B中add()方法修改了集合中元素的数量,导致此时expectedModCountmodCount不相等,因此执行checkForComodification方法时,便会抛出异常。

CopyOnWriteArrayList源码分析

前文说了CopyOnWriteArrayList可以解决集合面对并发,下面我们从源码角度分析下CopyOnWriteArrayList

public class CopyOnWriteArrayList<E>
    implements List<E>, RandomAccess, Cloneable, java.io.Serializable {
    
    ...
    
    public Iterator<E> iterator() {
        return new COWIterator<E>(getArray(), 0);
    }
    
    ...
    static final class COWIterator<E> implements ListIterator<E> {
    
        // 创建COWIterator时,将集合中的元素保存到一个新的数组
        // 当原始集合的数据改变,拷贝数据中的值也不会变化
        private final Object[] snapshot;
        /** Index of element to be returned by subsequent call to next.  */
        private int cursor;
        
        private COWIterator(Object[] elements, int initialCursor) {
            cursor = initialCursor;
            snapshot = elements;
        }
        
        public boolean hasNext() {
            return cursor < snapshot.length;
        }
        
        public boolean hasPrevious() {
            return cursor > 0;
        }
        
        @SuppressWarnings("unchecked")
        public E next() {
            if (! hasNext())
                throw new NoSuchElementException();
            return (E) snapshot[cursor++];
        }
        
        @SuppressWarnings("unchecked")
        public E previous() {
            if (! hasPrevious())
                throw new NoSuchElementException();
            return (E) snapshot[--cursor];
        }
        
        public int nextIndex() {
            return cursor;
        }
        
        public int previousIndex() {
            return cursor-1;
        }
        
        // 不支持的方法
        public void remove() {
            throw new UnsupportedOperationException();
        }
        
        // 不支持的方法
        public void set(E e) {
            throw new UnsupportedOperationException();
        }
        
        // 不支持的方法
        public void add(E e) {
            throw new UnsupportedOperationException();
        }
        
        ...
        
    }
}

从以上代码,我们可以看到以下几点:

  • CopyOnWriteArrayList没有继承AbstractList,只是实现了List接口
  • ArrayList返回的Iterator是在AbstractList中实现的,而CopyOnWriteArrayList是自己实现的Iterator
  • CopyOnWriteArrayList的各个方法中不会抛出ConcurrentModificationException异常

参考内容

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

推荐阅读更多精彩内容