【阿里规范】不要在 foreach 循环里进行元素的 remove/add 操作

叁歲伎倆 2023-10-03 19:23 11阅读 0赞

这几天没事的时候把阿里的Java开发手册大概看了一遍，其中有一条如下：

> 【强制】不要在foreach循环里进行元素的remove/add操作。remove元素请使用Iterator方式，如果并发操作，需要对Iterator对象加锁。

正例：

Iterator<String> iterator = list.iterator();
    while (iterator.hasNext()) {
        String item = iterator.next();
        if (删除元素条件) {
            iterator.remove();
        }
    }

反例：

List<String> list = new ArrayList<String>();
    list.add("1");
    list.add("2");
    for (String item : list) {
        if ("1".equals(item)) {
            list.remove(item);
        }
    }

> 说明：以上代码的执行结果肯定会出乎大家的意料，那么试一下把“1”换成“2”，会是同样的结果吗？

这个规则我之前是知道的，但是看到上面这个说明，就有点不太淡定了，难道还会有什么奇葩的事不成。于是把这行代码考到IDEA运行了一下，正例自然是不必说。

果然`remove`元素`1`的时候正常，`remove` `2`报`java.util.ConcurrentModificationException`异常。然后我又添加元素`3`,这下情况又变了，`remove` `1`和`3`异常，`remove` `2`正常。发现一个规律，`remove`倒数第二元素正常，其他元素就会抛异常。

因为`foreach`这种遍历的语法，本身就是Java的语法糖，我们要看真实的代码实现，上述反例经过Java编译器编译后实际上代码如下：

ArrayList list = new ArrayList();
    list.add("1");
    list.add("2");
    Iterator i$ = list.iterator();
    
    while(i$.hasNext()) {
        String item = (String)i$.next();
        if("2".equals(item)) {
            list.remove(item);
        }
    }

简单的打了几个断点发现，问题和`hasNext()`有很大关系。 看一下ArrayList的hasNext()的实现

public boolean hasNext() {
        return cursor != size;
    }

看ArrayList的源码，很多方法比如：`next()`、`previous()`、`remove()`在执行前都会先执行以下方法:

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

简单的说`checkForComodification()`是为了保证访问的一致性。 下面我们通过人肉执行循环来看一下这其中报异常或者不报异常的原因 `remove` `1`的循环如下：

`remove` `2`的循环如下：

<table> 
 <thead> 
  <tr> 
   <th>步骤</th> 
   <th>代码</th> 
   <th>表达式值</th> 
   <th>cursor</th> 
   <th>size</th> 
   <th>备注</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>1</td> 
   <td><code>i$.hasNext()</code></td> 
   <td>true</td> 
   <td>0</td> 
   <td>2</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>2</td> 
   <td><code>String item = (String)i$.next();</code></td> 
   <td>-</td> 
   <td>1</td> 
   <td>2</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>3</td> 
   <td><code>if("2".equals(item))</code></td> 
   <td>false</td> 
   <td>1</td> 
   <td>2</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>4</td> 
   <td><code>i$.hasNext()</code></td> 
   <td>true</td> 
   <td>1</td> 
   <td>2</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>5</td> 
   <td><code>String item = (String)i$.next();</code></td> 
   <td>-</td> 
   <td>2</td> 
   <td>2</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>6</td> 
   <td><code>if("2".equals(item))</code></td> 
   <td>true</td> 
   <td>2</td> 
   <td>2</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>7</td> 
   <td><code>list.remove(item);</code></td> 
   <td>-</td> 
   <td>2</td> 
   <td>1</td> 
   <td><code>remove</code>操作完成后<code>modCount != expectedModCount</code>，因为没有执行到<code>next()</code>方法，此时还不会抛出异常</td> 
  </tr> 
  <tr> 
   <td>8</td> 
   <td><code>i$.hasNext()</code></td> 
   <td>true</td> 
   <td>2</td> 
   <td>1</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>9</td> 
   <td><code>String item = (String)i$.next();</code></td> 
   <td>-</td> 
   <td>2</td> 
   <td>1</td> 
   <td>此时抛出异常</td> 
  </tr> 
 </tbody> 
</table>

**现在终于明白为什么`remove`倒数第二个元素不报错的原因了，因为`remove`倒数第二元素后刚好`cursor == size`，此时`hasNext()`返回false。**

关于`modCount`和`expectedModCount`可参考如下资料：

*  [Arraylist中的modCount\_溪苏的博客-CSDN博客][Arraylist_modCount_-CSDN]
 *  [Arraylist中的modCount 的作用\_游离于移动互联网边缘的博客-CSDN博客\_list的modcount][Arraylist_modCount _-CSDN_list_modcount]

[Arraylist_modCount_-CSDN]: http://blog.csdn.net/qq_24235325/article/details/52450331
[Arraylist_modCount _-CSDN_list_modcount]: http://blog.csdn.net/java_zone/article/details/53127897