ArrayList循环遍历并删除元素的常见陷阱

在工作和学习中，经常碰到删除ArrayList里面的某个元素，看似一个很简单的问题，却很容易出bug。不妨把这个问题当做一道面试题目，我想一定能难道不少的人。今天就给大家说一下在ArrayList循环遍历并删除元素的问题。首先请看下面的例子：

 

 

import java.util.ArrayList; publicclassArrayListRemove { publicstaticvoidmain(String[]args) { ArrayList<String>list=newArrayList<String>(); list.add("a"); list.add("b"); list.add("b"); list.add("c"); list.add("c"); list.add("c"); remove(list);   for(Strings:list) { System.out.println("element : "+s); } } publicstaticvoidremove(ArrayList<String>list) { // TODO: } }

 

如果要想删除list的b字符，有下面两种常见的错误例子：

错误写法实例一：

 

 

publicstaticvoidremove(ArrayList<String>list) { for(inti=0;i<list.size();i++) { Strings=list.get(i); if(s.equals("b")) { list.remove(s); } } }

 

错误的原因：这种最普通的循环写法执行后会发现第二个“b”的字符串没有删掉。

错误写法实例二：

 

 

publicstaticvoidremove(ArrayList<String>list) { for(Strings:list) { if(s.equals("b")) { list.remove(s); } } }

 

错误的原因：这种for-each写法会报出著名的并发修改异常：java.util.ConcurrentModificationException。

先解释一下实例一的错误原因。翻开JDK的ArrayList源码，先看下ArrayList中的remove方法（注意ArrayList中的remove有两个同名方法，只是入参不同，这里看的是入参为Object的remove方法）是怎么实现的：

 

 

1 2	publicbooleanremove(Objecto){ if(o==null){ for(intindex=0;index<size;index++) if(elementData[index]==null){ fastRemove(index); returntrue; } }else{ for(intindex=0;index<size;index++) if(o.equals(elementData[index])){ fastRemove(index); returntrue; } } returnfalse; }

 

一般情况下程序的执行路径会走到else路径下最终调用faseRemove方法：

 

 

1 2 3 4 5 6 7

privatevoidfastRemove(intindex){         modCount++;         intnumMoved=size-index-1;         if(numMoved>0)             System.arraycopy(elementData,index+1,elementData,index,numMoved);         elementData[--size]=null;// Let gc do its work     }

 

可以看到会执行System.arraycopy方法，导致删除元素时涉及到数组元素的移动。针对错误写法一，在遍历第一个字符串b时因为符合删除条件，所以将该元素从数组中删除，并且将后一个元素移动（也就是第二个字符串b）至当前位置，导致下一次循环遍历时后一个字符串b并没有遍历到，所以无法删除。针对这种情况可以倒序删除的方式来避免：

 

 

publicstaticvoidremove(ArrayList<String>list) { for(inti=list.size()-1;i>=0;i--) { Strings=list.get(i); if(s.equals("b")) { list.remove(s); } } }

 

因为数组倒序遍历时即使发生元素删除也不影响后序元素遍历。

接着解释一下实例二的错误原因。错误二产生的原因却是foreach写法是对实际的Iterable、hasNext、next方法的简写，问题同样处在上文的fastRemove方法中，可以看到第一行把modCount变量的值加一，但在ArrayList返回的迭代器（该代码在其父类AbstractList中）：

 

 

publicIterator<E>iterator(){ returnnewItr(); }

 

这里返回的是AbstractList类内部的迭代器实现private class Itr implements Iterator，看这个类的next方法：

 

 

publicEnext(){ checkForComodification(); try{ Enext=get(cursor); lastRet=cursor++; returnnext; }catch(IndexOutOfBoundsExceptione){ checkForComodification(); thrownewNoSuchElementException(); } }

 

第一行checkForComodification方法：

 

 

finalvoidcheckForComodification(){ if(modCount!=expectedModCount) thrownewConcurrentModificationException(); }

 

这里会做迭代器内部修改次数检查，因为上面的remove(Object)方法修改了modCount的值，所以才会报出并发修改异常。要避免这种情况的出现则在使用迭代器迭代时（显示或for-each的隐式）不要使用ArrayList的remove，改为用Iterator的remove即可。

 

 

publicstaticvoidremove(ArrayList<String>list) { Iterator<String>it=list.iterator(); while(it.hasNext()) { Strings=it.next(); if(s.equals("b")) { it.remove(); } } }