Collection遍历边移除其中的元素

原创于 2024-10-27 08:26:06 发布 · 1k 阅读

CC 4.0 BY-SA版权

文章标签：

一、使用`Iterator`的`remove()`方法

最常见和安全的方式是使用Iterator，并调用它的remove()方法。这种方法确保在遍历过程中不会抛出ConcurrentModificationException，因为Iterator的remove()方法能够正确地更新集合的结构状态。

1. 基本示例

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

public class Example {
    public static void main(String[] args) {
        List<String> list = new ArrayList<>();
        list.add("apple");
        list.add("banana");
        list.add("cherry");

        Iterator<String> iterator = list.iterator();
        while (iterator.hasNext()) {
            String fruit = iterator.next();
            if ("banana".equals(fruit)) {
                iterator.remove(); // 安全地移除当前元素
            }
        }

        System.out.println(list); // 输出：[apple, cherry]
    }
}

2. 原理解释

Iterator的工作方式：Iterator在遍历集合时，内部维护了一个指向当前元素的游标。调用next()方法时，游标会移动到下一个元素并返回该元素。调用remove()方法时，Iterator会移除当前游标指向的元素，并调整内部结构，确保下次遍历时状态一致。
为什么不抛出ConcurrentModificationException：Iterator的remove()方法直接修改集合，Iterator内部会记录这种修改，因此不会导致并发修改异常。

3. 适用场景

适用于大多数场景：当需要在遍历过程中删除集合中的某些元素时，使用Iterator是最安全和常见的选择。适用于List、Set、Map等支持Iterator的集合类型。

二、使用`ListIterator`的`remove()`和`add()`方法

对于List集合，还可以使用ListIterator，它是Iterator的子接口，提供了更多的功能，如向前遍历、添加元素等。ListIterator可以更灵活地在遍历过程中删除、添加和替换元素。

1. 基本示例

import java.util.ArrayList;
import java.util.List;
import java.util.ListIterator;

public class Example {
    public static void main(String[] args) {
        List<String> list = new ArrayList<>();
        list.add("apple");
        list.add("banana");
        list.add("cherry");

        ListIterator<String> listIterator = list.listIterator();
        while (listIterator.hasNext()) {
            String fruit = listIterator.next();
            if ("banana".equals(fruit)) {
                listIterator.remove(); // 移除当前元素
            }
            if ("cherry".equals(fruit)) {
                listIterator.add("date"); // 在当前位置添加新元素
            }
        }

        System.out.println(list); // 输出：[apple, cherry, date]
    }
}

2. 原理解释

双向遍历：ListIterator可以在List中双向遍历，既可以使用hasNext()和next()方法向前遍历，也可以使用hasPrevious()和previous()方法向后遍历。
支持更多操作：除了Iterator的基本操作外，ListIterator还提供了add()、set()等方法，允许在遍历过程中添加和替换元素。

3. 适用场景

适用于需要复杂操作的场景：当遍历过程中不仅需要删除，还需要添加或替换元素时，ListIterator是一个理想的选择。

三、使用`Collection.removeIf()`方法

从Java 8开始，Collection接口新增了removeIf()方法，它允许根据给定的条件（Predicate）移除集合中的元素。这种方法简化了代码，特别适合在需要根据某个条件批量删除元素时使用。

1. 基本示例

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

public class Example {
    public static void main(String[] args) {
        List<String> list = new ArrayList<>();
        list.add("apple");
        list.add("banana");
        list.add("cherry");

        list.removeIf(fruit -> "banana".equals(fruit)); // 移除等于"banana"的元素

        System.out.println(list); // 输出：[apple, cherry]
    }
}

2. 原理解释

基于条件的批量删除：removeIf()方法接收一个Predicate（布尔函数接口），对于集合中的每个元素，如果Predicate返回true，则删除该元素。
内部实现：removeIf()方法内部使用了Iterator来遍历集合，并调用Iterator的remove()方法来删除元素，从而避免ConcurrentModificationException。

3. 适用场景

适用于条件删除：当需要根据特定条件删除集合中的元素时，removeIf()方法非常方便且简洁，适用于所有实现了Collection接口的集合类型。

四、使用`CopyOnWriteArrayList`进行安全删除

在多线程环境下，CopyOnWriteArrayList提供了一种安全的方式来遍历和修改集合。CopyOnWriteArrayList是一个线程安全的集合类，它在每次修改操作时都会创建一个新的副本，因此读操作不会受到写操作的影响。

1. 基本示例

import java.util.List;
import java.util.concurrent.CopyOnWriteArrayList;

public class Example {
    public static void main(String[] args) {
        List<String> list = new CopyOnWriteArrayList<>();
        list.add("apple");
        list.add("banana");
        list.add("cherry");

        for (String fruit : list) {
            if ("banana".equals(fruit)) {
                list.remove(fruit); // 在多线程环境中安全地删除元素
            }
        }

        System.out.println(list); // 输出：[apple, cherry]
    }
}

2. 原理解释

写时复制：CopyOnWriteArrayList在进行修改操作（如添加、删除元素）时，会创建底层数组的一个副本。所有读操作都在旧的数组上进行，而写操作则修改新数组并替换旧数组。
线程安全：由于每次修改都是在一个新的数组上进行，因此读操作不会受到影响，确保了多线程环境中的安全性。

3. 适用场景

适用于多线程读多写少的场景：CopyOnWriteArrayList特别适合在多线程环境中，读操作频繁而写操作较少的场景。由于写操作涉及到数组复制，这种方式在写操作频繁时效率较低。

五、避免`ConcurrentModificationException`的注意事项

在使用普通for-each循环遍历集合时，如果尝试直接调用集合的remove()方法，会导致ConcurrentModificationException。这是因为for-each循环使用的是集合的Iterator，而直接调用remove()会干扰到Iterator的内部状态。

1. 错误示例

List<String> list = new ArrayList<>();
list.add("apple");
list.add("banana");
list.add("cherry");

for (String fruit : list) {
    if ("banana".equals(fruit)) {
        list.remove(fruit); // 会抛出 ConcurrentModificationException
    }
}