为什么阿里巴巴Java开发手册强制要求Arrays.asList()不能使用其修改方法?

简介:

在阅读《阿里巴巴Java开发手册》时,发现有一条关于在 foreach 循环里进行元素的 remove/add 操作的规约,具体内容如下:

阿里巴巴Java开发手册

错误演示

我们首先在 IDEA 中编写一个在 foreach 循环里进行 remove 操作的代码:

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

public class ForEachTest {
    public static void main(String[] args) {
        List<String> list = new ArrayList<>();
        list.add("wupx");
        list.add("love");
        list.add("huxy");
        for (String temp : list) {
            if ("love".equals(temp)) {
                list.remove(temp);
            }
        }
        System.out.println(list);
    }
}

此时执行代码,编译正确,执行成功!输出 [wupx, huxy]。

接着我们把 “love” 换成 “wupx” 或是 “huxy” 再来运行下,执行结果如下:

纳尼,居然报错了,为什么第一次运行没有报错呢?让我们一起来进行探讨吧!

追根溯源

为了研究为什么会出现这样的情况,我们可以根据异常堆栈信息,去追踪错误,其中涉及到的部分源码如下:

private class Itr implements Iterator<E> {
    int cursor;       // 下一个要返回的元素的索引
    int lastRet = -1; // 返回的最后一个元素的索引(如果没有返回-1)
    int expectedModCount = modCount;

    public boolean hasNext() {
        return cursor != size;
    }
    
    public void remove() {
        if (lastRet < 0)
            throw new IllegalStateException();
        checkForComodification();

        try {
            ArrayList.this.remove(lastRet);
            cursor = lastRet;
            lastRet = -1;
            expectedModCount = modCount;
        } catch (IndexOutOfBoundsException ex) {
            throw new ConcurrentModificationException();
        }
    }

    @Override
    @SuppressWarnings("unchecked")
    public void forEachRemaining(Consumer<? super E> consumer) {
        Objects.requireNonNull(consumer);
        final int size = ArrayList.this.size;
        int i = cursor;
        if (i >= size) {
            return;
        }
        final Object[] elementData = ArrayList.this.elementData;
        if (i >= elementData.length) {
            throw new ConcurrentModificationException();
        }
        while (i != size && modCount == expectedModCount) {
            consumer.accept((E) elementData[i++]);
        }
        cursor = i;
        lastRet = i - 1;
        checkForComodification();
    }
    
    @SuppressWarnings("unchecked")
    public E next() {
        checkForComodification();
        int i = cursor;
        if (i >= size)
            throw new NoSuchElementException();
        Object[] elementData = ArrayList.this.elementData;
        if (i >= elementData.length)
            throw new ConcurrentModificationException();
        cursor = i + 1;
        return (E) elementData[lastRet = i];
    }

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

从代码中可以看出,其实在集合遍历时维护一个初始值为 0 的游标 cursor,从头到尾地进行扫描,在 cursor==size 时,退出遍历。如下图所示,执行 remove 这个元素后,所有元素往前拷贝, size=size-1 即为2 ,这时 cursor 也等于 2。在执行
hasNext() 时, 结果为 false ,退出循环体,并没有机会执行到 next() 的第一行代码
checkForComodification() ,此方法用来判断 expectedModCount 和 modCount 是否相等,
如果不相等,则抛出 ConcurrentModificationException 异常。

集合的cursor与size

之所以会报 ConcurrentModificationException 异常,是因为触发了 Java 的 fail-fast 机制,该机制是集合中比较常见的错误检测机制,通常出现在遍历集合元素的过程中。举个生活中的栗子:

比如上体育课时,在上课前都会依次报数,如果在报数期间,有人突然加进来,还要重新报数,再次报数,又有同学溜出去了,又要重新报数,这就是 fail-fast 机制,它是对集合(班级同学)遍历操作的错误检测机制,在遍历中途出现意料之外的修改时,通过 unchecked 异常反馈出来。这种机制经常出现在多线程环境下,当前线程会维护一个计数比较器(expectedModCount),记录已经修改的次数。在进入遍历前,会把实时修改次数
modCount 赋值给 expectedModCount,如果这两个数据不相等,则抛出异常。java.util 下的所有集合类都是 fail-fast。

不二法门

既然在 foreach 循环里进行元素的 remove/add 操作会有问题,那么我们可以使用手册中推荐的 Iterator 机制进行遍历时的删除或新增,代码如下:

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

public class ForEachTest {
    public static void main(String[] args) {
        List<String> list = new ArrayList<>();
        list.add("wupx");
        list.add("love");
        list.add("huxy");

        Iterator iterator = list.iterator();
        while (iterator.hasNext()) {
            if (iterator.next().equals("wupx")) {
                iterator.remove();
            }
        }
        System.out.println(list);
    }
}

如果是多线程并发,还需要在 Iterator 遍历时加锁,或者使用并发容器 CopyOnWriteArrayList 代替 ArrayList,该容器内部会对 Iterator 进行加锁操作。

总结

本文针对《阿里巴巴Java开发手册》中的强制要求不要在 foreach 循环里进行元素的 remove/add 操作出发,从源码层面来解释为什么,还用生活中的栗子来介绍 Java 中的 fail-fast 机制,因此在进行元素的 remove/add 操作时要用 Iterator 去遍历删除或新增。

参考

《Java开发手册》华山版

《码出高效:Java开发手册》

目录
相关文章
|
Java
Java开发规范01 - 集合篇_Arrays.asList 坑
Java开发规范01 - 集合篇_Arrays.asList 坑
119 0
|
Java
【Java数组转集合】Arrays.asList() 方法(案例详解)
Java基础之Arrays.asList() 方法案例详解!
166 0
【Java数组转集合】Arrays.asList() 方法(案例详解)
|
6天前
|
存储 缓存 安全
【Java面试题汇总】多线程、JUC、锁篇(2023版)
线程和进程的区别、CAS的ABA问题、AQS、哪些地方使用了CAS、怎么保证线程安全、线程同步方式、synchronized的用法及原理、Lock、volatile、线程的六个状态、ThreadLocal、线程通信方式、创建方式、两种创建线程池的方法、线程池设置合适的线程数、线程安全的集合?ConcurrentHashMap、JUC
【Java面试题汇总】多线程、JUC、锁篇(2023版)
|
17天前
|
监控 Java 调度
【Java学习】多线程&JUC万字超详解
本文详细介绍了多线程的概念和三种实现方式,还有一些常见的成员方法,CPU的调动方式,多线程的生命周期,还有线程安全问题,锁和死锁的概念,以及等待唤醒机制,阻塞队列,多线程的六种状态,线程池等
79 6
【Java学习】多线程&JUC万字超详解
|
3天前
|
Java
深入理解Java中的多线程编程
本文将探讨Java多线程编程的核心概念和技术,包括线程的创建与管理、同步机制以及并发工具类的应用。我们将通过实例分析,帮助读者更好地理解和应用Java多线程编程,提高程序的性能和响应能力。
15 4
|
11天前
|
Java 调度 开发者
Java并发编程:深入理解线程池
在Java的世界中,线程池是提升应用性能、实现高效并发处理的关键工具。本文将深入浅出地介绍线程池的核心概念、工作原理以及如何在实际应用中有效利用线程池来优化资源管理和任务调度。通过本文的学习,读者能够掌握线程池的基本使用技巧,并理解其背后的设计哲学。
|
2天前
|
安全 Java 调度
Java 并发编程中的线程安全和性能优化
本文将深入探讨Java并发编程中的关键概念,包括线程安全、同步机制以及性能优化。我们将从基础入手,逐步解析高级技术,并通过实例展示如何在实际开发中应用这些知识。阅读完本文后,读者将对如何在多线程环境中编写高效且安全的Java代码有一个全面的了解。
|
10天前
|
缓存 监控 Java
Java中的并发编程:理解并应用线程池
在Java的并发编程中,线程池是提高应用程序性能的关键工具。本文将深入探讨如何有效利用线程池来管理资源、提升效率和简化代码结构。我们将从基础概念出发,逐步介绍线程池的配置、使用场景以及最佳实践,帮助开发者更好地掌握并发编程的核心技巧。
|
7天前
|
Java 调度 开发者
Java中的多线程基础及其应用
【9月更文挑战第13天】本文将深入探讨Java中的多线程概念,从基本理论到实际应用,带你一步步了解如何有效使用多线程来提升程序的性能。我们将通过实际代码示例,展示如何在Java中创建和管理线程,以及如何利用线程池优化资源管理。无论你是初学者还是有经验的开发者,这篇文章都将为你提供有价值的见解和技巧,帮助你更好地理解和应用多线程编程。
|
12天前
|
缓存 监控 Java
java中线程池的使用
java中线程池的使用