【Java代码规范系列集合】之避免在foreach循环中进行元素的removeadd操作

Java代码规范之避免在foreach循环中进行元素的remove/add操作

目录

• 该条规范是什么
• 为什么这么规定
• 多种主要用法及其代码示例
• 其他类似规范
• 详细区别
• 官方链接

该条规范是什么

该规范建议在Java编程中，不要在foreach循环中进行元素的remove/add操作。对于需要删除元素的操作，应使用Iterator进行操作，并在并发操作时对Iterator对象加锁。

为什么这么规定

以下是该规范的原因：

1. 避免并发修改异常：在foreach循环中进行元素的remove/add操作可能会导致并发修改异常(ConcurrentModificationException)的发生，因为foreach循环底层使用的是迭代器，当集合结构发生变化时，迭代器会检测到并抛出异常。
2. 提高性能：使用Iterator进行元素的删除操作可以避免遍历整个集合来寻找要删除的元素，从而提高执行效率。
3. 并发安全：在并发操作中，对Iterator对象加锁可以确保在多线程环境下对集合进行安全的操作。

多种主要用法及其代码示例

使用Iterator进行元素的删除操作

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

public class IteratorExample {
    public static void main(String[] args) {
        List<String> list = new ArrayList<>();
        
        // 添加元素
        list.add("apple");
        list.add("banana");
        list.add("orange");
        
        // 使用Iterator进行元素的删除操作
        Iterator<String> iterator = list.iterator();
        while (iterator.hasNext()) {
            String element = iterator.next();
            if (element.equals("banana")) {
                iterator.remove();
            }
        }
        
        // 输出剩余的元素
        for (String element : list) {
            System.out.println(element);
        }
    }
}

在并发操作中对Iterator对象加锁

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

public class ConcurrentIteratorExample {
    public static void main(String[] args) {
        List<String> list = new ArrayList<>();
        
        // 添加元素
        list.add("apple");
        list.add("banana");
        list.add("orange");
        
        // 对Iterator对象加锁
        synchronized (list) {
            Iterator<String> iterator = list.iterator();
            while (iterator.hasNext()) {
                String element = iterator.next();
                if (element.equals("banana")) {
                    iterator.remove();
                }
            }
        }
        
        // 输出剩余的元素
        for (String element : list) {
            System.out.println(element);
        }
    }
}

其他类似规范

• 避免在foreach循环中进行元素的add操作，这可能导致遍历过程中出现无限循环或跳过部分元素的问题。

详细区别

与在foreach循环中进行元素的remove/add操作相比，使用Iterator进行元素的删除操作具有以下区别：

1. 并发修改异常：在foreach循环中进行元素的remove/add操作可能会导致并发修改异常的发生，而使用Iterator进行元素的删除操作可以避免此异常。
2. 性能优化：使用Iterator进行元素的删除操作不需要遍历整个集合来寻找要删除的元素，从而提高执行效率。
3. 并发安全：在并发操作时，对Iterator对象加锁可以确保多线程环境下对集合进行安全的操作。

官方链接

• Java Collection文档