java集合遍歷刪除指定元素異常分析總結
在使用集合的過程中，我們經常會有遍歷集合元素，刪除指定的元素的需求，而對於這種需求我們往往使用會犯些小錯誤，導致程序拋異常或者與預期結果不對，本人很早之前就遇到過這個坑，當時沒註意總結，結果前段時間又遇到了這個問題，因此，總結下遍歷集合的同時如何刪除集合中指定的元素；
1.錯誤場景復原
public class ListRemoveTest {
public static void main(String[] args) {
List<User> users = new ArrayList<User>();
users.add(new User("liu1",24));
users.add(new User("liu2",24));
users.add(new User("liu3",24));
users.add(new User("liu4",24));
Iterator<User> iterator = users.iterator();
while(iterator.hasNext()) {
User user = iterator.next();
if(user.getName().equals("liu2")) {
users.remove(user)；
或者如下代碼
public class ListRemoveTest {
public static void main(String[] args) {
List<User> users = new ArrayList<User>();
users.add(new User("liu1",24));
users.add(new User("liu2",24));
users.add(new User("liu3",24));
users.add(new User("liu4",24));
for (User user : users) {
if(user.getName().equals("liu2")) {
users.remove(user);
}
System.out.println(user);
}
}
}
以上兩種用法都會跑出如下異常：
2.原因分析
上面兩種錯誤，我想很多人都遇到過，這是我們很容易犯的錯誤，但是為啥會出現上述異常呢，我們又該如何正確遍歷集合的同時，刪除指定的元素呢！
2.1 原因解析
首先，對於foreach循環遍歷，本質上還是叠代器的模式，上面的for語句等價於如下代碼：
for (Iterator<User> iterator = users.iterator(); iterator.hasNext();) {
User user = iterator.next();
if(user.getName().equals("liu2")) {
users.remove(user);
}
System.out.println(user);
}
因此，上述錯誤的本質，就要看叠代器iterator的源碼啦
在ArrayList中，它的修改操作(add/remove)都會對modCount這個字段+1，modCount可以看作一個版本號，每次集合中的元素被修改後，都會+1(即使溢出)。
public boolean remove(Object o) {
if (o == null) {
for (int index = 0; index < size; index++)
if (elementData[index] == null) {
fastRemove(index);
return true;
}
} else {
for (int index = 0; index < size; index++)
if (o.equals(elementData[index])) {
fastRemove(index);
return true;
}
}
return false;
}
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
}
接下來再看看AbsrtactList中iteraor方法
public Iterator<E> iterator() {
return new Itr();
}
它返回一個內部類，這個類實現了iterator接口，代碼如下：
private class Itr implements Iterator<E> {
int cursor = 0;
int lastRet = -1;
int expectedModCount = modCount;
public boolean hasNext() {
return cursor != size();
}
public E next() {
checkForComodification();
try {
E next = get(cursor);
lastRet = cursor++;
return next;
} catch (IndexOutOfBoundsException e) {
checkForComodification();
throw new NoSuchElementException();
}
}
public void remove() {
if (lastRet == -1)
throw new IllegalStateException();
checkForComodification();
try {
AbstractList.this.remove(lastRet);
if (lastRet < cursor)
cursor--;
lastRet = -1;
// 修改expectedModCount 的值
expectedModCount = modCount;
} catch (IndexOutOfBoundsException e) {
throw new ConcurrentModificationException();
}
}
final void checkForComodification() {
if (modCount != expectedModCount)
throw new ConcurrentModificationException();
}
}
在內部類Itr中，有一個字段expectedModCount ，初始化時等於modCount，即當我們調用list.iterator()返回叠代器時，該字段被初始化為等於modCount。在類Itr中next/remove方法都有調用checkForComodification()方法，在該方法中檢測modCount == expectedModCount，如果不相等則拋出ConcurrentModificationException。
前面說過，在集合的修改操作(add/remove)中，都對modCount進行了+1。
在叠代過程中，執行list.remove(val)，使得modCount+1，當下一次循環時，執行 it.next()，checkForComodification方法發現modCount != expectedModCount，則拋出異常。
2.2 預期結果不對，但是不拋異常
註意：還有一種更坑的場景，當刪除集合的倒數第二個元素時，程序不會拋出任何異常，只是結果與預期的不相符，如果在應用過程中不認真觀察，很難發現該錯誤！
錯誤實例如下：
public static void main(String[] args) {
List<User> users = new ArrayList<User>();
users.add(new User("liu1",24));
users.add(new User("liu2",24));
users.add(new User("liu3",24));
users.add(new User("liu4",24));
Iterator<User> iterator = users.iterator();
while(iterator.hasNext()) {
User user = iterator.next();
if(user.getName().equals("liu3")) {
users.remove(user);
}
System.out.println(user);
}
}
運行結果如下：
遍歷過程刪除了倒數第二個元素，那麽最後一個元素就永遠遍歷不到了，這個主要原因就是Iterator源碼中hasNext方法中，判斷當前元素下標和集合大小是否相等
public boolean hasNext() {
return cursor != size;
}
當刪除倒數第二個元素後，當前元素下標和集合的大小相等了，跳出了循環，就會遍歷最後一個集合元素了；
3.正確用法
要想在集合遍歷的過程中刪除指定元素，就務必使用叠代器自身的remove方法；
再來看看內部類Itr的remove()方法，在刪除元素後，有這麽一句expectedModCount
= modCount，同步修改expectedModCount
的值。所以，如果需要在使用叠代器叠代時，刪除元素，可以使用叠代器提供的remove方法。
其他集合(Map/Set)使用叠代器叠代也是一樣。
所以 Iterator 在工作的時候是不允許被叠代的對象被改變的。
但你可以使用 Iterator 本身的方法 remove() 來刪除對象， Iterator.remove() 方法會在刪除當前叠代對象的同時維護索引的一致
具體正確用法代碼如下：
public class ListRemoveTest {
public static void main(String[] args) {
List<User> users = new ArrayList<User>();
users.add(new User("liu1",24));
users.add(new User("liu2",24));
users.add(new User("liu3",24));
users.add(new User("liu4",24));
Iterator<User> iterator = users.iterator();
while(iterator.hasNext()) {
User user = iterator.next();
if(user.getName().equals("liu2")) {
iterator.remove();
}
System.out.println(user);
}
System.out.println(users);
}
}
運行結果如下：
與預期結果一致；
java集合遍歷刪除指定元素異常分析總結