Java中ArrayList循环遍历并删除元素的陷阱

2023-05-12,,

ava中的ArrayList循环遍历并且删除元素时经常不小心掉坑里,昨天又碰到了,感觉有必要单独写篇文章记一下。

先写个测试代码:

    import java.util.ArrayList;
    public class ArrayListRemove {
    public static void main(String[] args) {
    ArrayList<String> list = new ArrayList<String>();
    list.add("a");
    list.add("bb");
    list.add("bb");
    list.add("ccc");
    list.add("ccc");
    list.add("ccc");
    remove(list);
    for (String s : list) {
    System.out.println("element : " + s);
    }
    }
    public static void remove(ArrayList<String> list) {
    // TODO:
    }
    }

错误写法示例一:

    public static void remove(ArrayList<String> list) {
    for (int i = 0; i < list.size(); i++) {
    String s = list.get(i);
    if (s.equals("bb")) {
    list.remove(s);
    }
    }
    }

这种最普通的循环写法执行后会发现有一个“bb”的字符串没有删掉。

错误写法示例二:

    public static void remove(ArrayList<String> list) {
    for (String s : list) {
    if (s.equals("bb")) {
    list.remove(s);
    }
    }
    }

这种for each写法会发现报出著名的并发修改异常java.util.ConcurrentModificationException。

要分析产生上述错误现象的原因唯有翻一翻jdk的ArrayList源码,先看下ArrayList中的remove方法(注意ArrayList中的remove有两个同名方法,只是入参不同,这里看的是入参为Object的remove方法)是怎么实现的:

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

按一般执行路径会走到else路径下最终调用faseRemove方法:

    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; // Let gc do its work
    }

可以看到会执行System.arraycopy方法,导致删除元素时涉及到数组元素的移动。针对错误写法一,在遍历第二个元素字符串bb时因为符合删除条件,所以将该元素从数组中删除,并且将后一个元素移动(也是字符串bb)至当前位置,导致下一次循环遍历时后一个字符串bb并没有遍历到,所以无法删除。

针对这种情况可以倒序删除的方式来避免:

    public static void remove(ArrayList<String> list) {
    for (int i = list.size() - 1; i >= 0; i--) {
    String s = list.get(i);
    if (s.equals("bb")) {
    list.remove(s);
    }
    }
    }

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

而错误二产生的原因却是foreach写法是对实际的Iterable、hasNext、next方法的简写,问题同样处在上文的fastRemove方法中,可以看到第一行把modCount变量的值加一,但在ArrayList返回的迭代器(该代码在其父类AbstractList中):

    public Iterator<E> iterator() {
    return new Itr();
    }

这里返回的是AbstractList类内部的迭代器实现private class Itr implements Iterator<E>,看这个类的next方法:

    public E next() {
    checkForComodification();
    try {
    E next = get(cursor);
    lastRet = cursor++;
    return next;
    } catch (IndexOutOfBoundsException e) {
    checkForComodification();
    throw new NoSuchElementException();
    }
    }

第一行checkForComodification方法:

    final void checkForComodification() {
    if (modCount != expectedModCount)
    throw new ConcurrentModificationException();
    }

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

    public static void remove(ArrayList<String> list) {
    Iterator<String> it = list.iterator();
    while (it.hasNext()) {
    String s = it.next();
    if (s.equals("bb")) {
    it.remove();
    }
    }
    }

Java中ArrayList循环遍历并删除元素的陷阱的相关教程结束。

《Java中ArrayList循环遍历并删除元素的陷阱.doc》

下载本文的Word格式文档,以方便收藏与打印。