不要在foreach循环里进行元素的remove/add操作

Posted 2020-10-25 how-to-say-how-to-do

不要在 foreach 循环里进行元素的 remove/add 操作。remove 元素请使用 Iterator 方式。 

反例：

public class ForeachTest {
    private List<String> list = new ArrayList<String>();

    @Test
    public void forTest() {
        list.add("1");
        list.add("2");
        for(String temp : list) {
            if("1".equals(temp)) {
                list.remove(temp);
            }
        }
        for(String temp : list) {
            System.out.println(temp + " ");
        }
    }
}

结果

如果将1换成2，结果就出错了

产生Concurrent Modification Exception原因是：当list.remove(Object o)方法之后，modCount和expectedModCount不相等了，然后当代码执行到next()方法时，判断了checkForComodification()，发现两个数值不等，就抛出该Exception；add(Object o)方法也是一样原因；

另外，Iterator是工作在一个独立的线程中，并且拥有一个mutex锁， Iterator 被创建之后会建立一个指向原来对象的单链索引表，当原来的list对象数量发生变化时，这个索引表的内容不会同步改变，所以当索引指针往后移动的时候就找不到要迭代的对象，所以按照 fail-fast 原则 Iterator 会马上抛出 java.util.ConcurrentModificationException 异常。 所以 Iterator 在工作的时候是不允许被迭代的对象被改变的。

但你可以使用 Iterator 本身的方法 remove() 来删除对象， Iterator.remove() 方法会在删除当前迭代对象的同时维护索引的一致性。

正例：

public class ForeachTest {
    private List<String> list = new ArrayList<String>();

    @Test
    public void forTest2() {
        list.add("1");
        list.add("2");
        Iterator<String> it = list.iterator();
        while(it.hasNext()) {
            String temp = it.next();
            if("2".equals(temp)) {
                it.remove();
            }
        }
        for(String temp : list) {
            System.out.println(temp + " ");
        }
    }
}

结果很完美，

如果并发操作，需要对 Iterator 对象加锁。