建站
咨詢(xún)
售后
建站咨詢(xún)
新聞中心
在阿里巴巴Java開(kāi)發(fā)手冊(cè)中，有這樣一條規(guī)定：
但是手冊(cè)中并沒(méi)有給出具體原因，本文就來(lái)深入分析一下該規(guī)定背后的思考。
1.foreach循環(huán)
foreach循環(huán)(Foreach loop)是計(jì)算機(jī)編程語(yǔ)言中的一種控制流程語(yǔ)句，通常用來(lái)循環(huán)遍歷數(shù)組或集合中的元素。
Java語(yǔ)言從JDK 1.5.0開(kāi)始引入foreach循環(huán)。在遍歷數(shù)組、集合方面，foreach為開(kāi)發(fā)人員提供了極大的方便。通常也被稱(chēng)之為增強(qiáng)for循環(huán)。
foreach 語(yǔ)法格式如下：
- for(元素類(lèi)型t 元素變量x : 遍歷對(duì)象obj){
- 引用了x的java語(yǔ)句;
- }
以下實(shí)例演示了 普通for循環(huán) 和 foreach循環(huán)使用：
- public static void main(String[] args) {
- // 使用ImmutableList初始化一個(gè)List
- List
userNames = ImmutableList.of("Hollis", "hollis", "HollisChuang", "H"); - System.out.println("使用for循環(huán)遍歷List");
- for (int i = 0; i < userNames.size(); i++) {
- System.out.println(userNames.get(i));
- }
- System.out.println("使用foreach遍歷List");
- for (String userName : userNames) {
- System.out.println(userName);
- }
- }
以上代碼運(yùn)行輸出結(jié)果為：
- 使用for循環(huán)遍歷List
- Hollis
- hollis
- HollisChuang
- H
- 使用foreach遍歷List
- Hollis
- hollis
- HollisChuang
- H
可以看到，使用foreach語(yǔ)法遍歷集合或者數(shù)組的時(shí)候，可以起到和普通for循環(huán)同樣的效果，并且代碼更加簡(jiǎn)潔。所以，foreach循環(huán)也通常也被稱(chēng)為增強(qiáng)for循環(huán)。
但是，作為一個(gè)合格的程序員，我們不僅要知道什么是增強(qiáng)for循環(huán)，還需要知道增強(qiáng)for循環(huán)的原理是什么?
其實(shí)，增強(qiáng)for循環(huán)也是Java給我們提供的一個(gè)語(yǔ)法糖，如果將以上代碼編譯后的class文件進(jìn)行反編譯(使用jad工具)的話，可以得到以下代碼：
- Iterator iterator = userNames.iterator();
- do
- {
- if(!iterator.hasNext())
- break;
- String userName = (String)iterator.next();
- if(userName.equals("Hollis"))
- userNames.remove(userName);
- } while(true);
- System.out.println(userNames);
可以發(fā)現(xiàn)，原本的增強(qiáng)for循環(huán)，其實(shí)是依賴(lài)了while循環(huán)和Iterator實(shí)現(xiàn)的。(請(qǐng)記住這種實(shí)現(xiàn)方式，后面會(huì)用到!)
2.問(wèn)題重現(xiàn)
規(guī)范中指出不讓我們?cè)趂oreach循環(huán)中對(duì)集合元素做add/remove操作，那么，我們嘗試著做一下看看會(huì)發(fā)生什么問(wèn)題。
- // 使用雙括弧語(yǔ)法（double-brace syntax）建立并初始化一個(gè)List
- List
userNames = new ArrayList () {{ - add("Hollis");
- add("hollis");
- add("HollisChuang");
- add("H");
- }};
- for (int i = 0; i < userNames.size(); i++) {
- if (userNames.get(i).equals("Hollis")) {
- userNames.remove(i);
- }
- }
- System.out.println(userNames);
以上代碼，首先使用雙括弧語(yǔ)法(double-brace syntax)建立并初始化一個(gè)List，其中包含四個(gè)字符串，分別是Hollis、hollis、HollisChuang和H。
然后使用普通for循環(huán)對(duì)List進(jìn)行遍歷，刪除List中元素內(nèi)容等于Hollis的元素。然后輸出List，輸出結(jié)果如下：
- [hollis, HollisChuang, H]
以上是使用普通的for循環(huán)在遍歷的同時(shí)進(jìn)行刪除，那么，我們?cè)倏聪拢绻褂迷鰪?qiáng)for循環(huán)的話會(huì)發(fā)生什么：
- List
userNames = new ArrayList () {{ - add("Hollis");
- add("hollis");
- add("HollisChuang");
- add("H");
- }};
- for (String userName : userNames) {
- if (userName.equals("Hollis")) {
- userNames.remove(userName);
- }
- }
- System.out.println(userNames);
以上代碼，使用增強(qiáng)for循環(huán)遍歷元素，并嘗試刪除其中的Hollis字符串元素。運(yùn)行以上代碼，會(huì)拋出以下異常：
- java.util.ConcurrentModificationException
同樣的，讀者可以嘗試下在增強(qiáng)for循環(huán)中使用add方法添加元素，結(jié)果也會(huì)同樣拋出該異常。
之所以會(huì)出現(xiàn)這個(gè)異常，是因?yàn)橛|發(fā)了一個(gè)Java集合的錯(cuò)誤檢測(cè)機(jī)制——fail-fast 。
3.fail-fast
接下來(lái)，我們就來(lái)分析下在增強(qiáng)for循環(huán)中add/remove元素的時(shí)候會(huì)拋出java.util.ConcurrentModificationException的原因，即解釋下到底什么是fail-fast進(jìn)制，fail-fast的原理等。
fail-fast，即快速失敗，它是Java集合的一種錯(cuò)誤檢測(cè)機(jī)制。當(dāng)多個(gè)線程對(duì)集合(非fail-safe的集合類(lèi))進(jìn)行結(jié)構(gòu)上的改變的操作時(shí)，有可能會(huì)產(chǎn)生fail-fast機(jī)制，這個(gè)時(shí)候就會(huì)拋出ConcurrentModificationException(當(dāng)方法檢測(cè)到對(duì)象的并發(fā)修改，但不允許這種修改時(shí)就拋出該異常)。
同時(shí)需要注意的是，即使不是多線程環(huán)境，如果單線程違反了規(guī)則，同樣也有可能會(huì)拋出改異常。
那么，在增強(qiáng)for循環(huán)進(jìn)行元素刪除，是如何違反了規(guī)則的呢?
要分析這個(gè)問(wèn)題，我們先將增強(qiáng)for循環(huán)這個(gè)語(yǔ)法糖進(jìn)行解糖(使用jad對(duì)編譯后的class文件進(jìn)行反編譯)，得到以下代碼：
- public static void main(String[] args) {
- // 使用ImmutableList初始化一個(gè)List
- List
userNames = new ArrayList () {{ - add("Hollis");
- add("hollis");
- add("HollisChuang");
- add("H");
- }};
- Iterator iterator = userNames.iterator();
- do
- {
- if(!iterator.hasNext())
- break;
- String userName = (String)iterator.next();
- if(userName.equals("Hollis"))
- userNames.remove(userName);
- } while(true);
- System.out.println(userNames);
- }
然后運(yùn)行以上代碼，同樣會(huì)拋出異常。我們來(lái)看一下ConcurrentModificationException的完整堆棧：
通過(guò)異常堆棧我們可以到，異常發(fā)生的調(diào)用鏈ForEachDemo的第23行，Iterator.next 調(diào)用了 Iterator.checkForComodification方法 ，而異常就是checkForComodification方法中拋出的。
其實(shí)，經(jīng)過(guò)debug后，我們可以發(fā)現(xiàn)，如果remove代碼沒(méi)有被執(zhí)行過(guò)，iterator.next這一行是一直沒(méi)報(bào)錯(cuò)的。拋異常的時(shí)機(jī)也正是remove執(zhí)行之后的的那一次next方法的調(diào)用。
我們直接看下checkForComodification方法的代碼，看下拋出異常的原因：
- final void checkForComodification() {
- if (modCount != expectedModCount)
- throw new ConcurrentModificationException();
- }
代碼比較簡(jiǎn)單，modCount != expectedModCount的時(shí)候，就會(huì)拋出ConcurrentModificationException。
那么，就來(lái)看一下，remove/add 操作室如何導(dǎo)致modCount和expectedModCount不相等的吧。
4.remove/add 做了什么
首先，我們要搞清楚的是，到底modCount和expectedModCount這兩個(gè)變量都是個(gè)什么東西。
通過(guò)翻源碼，我們可以發(fā)現(xiàn)：
- modCount是ArrayList中的一個(gè)成員變量。它表示該集合實(shí)際被修改的次數(shù)。
- expectedModCount 是 ArrayList中的一個(gè)內(nèi)部類(lèi)——Itr中的成員變量。expectedModCount表示這個(gè)迭代器期望該集合被修改的次數(shù)。其值是在ArrayList.iterator方法被調(diào)用的時(shí)候初始化的。只有通過(guò)迭代器對(duì)集合進(jìn)行操作，該值才會(huì)改變。
- Itr是一個(gè)Iterator的實(shí)現(xiàn)，使用ArrayList.iterator方法可以獲取到的迭代器就是Itr類(lèi)的實(shí)例。
他們之間的關(guān)系如下：
- class ArrayList{
- private int modCount;
- public void add();
- public void remove();
- private class Itr implements Iterator
{ - int expectedModCount = modCount;
- }
- public Iterator
iterator() { - return new Itr();
- }
- }
其實(shí)，看到這里，大概很多人都能猜到為什么remove/add 操作之后，會(huì)導(dǎo)致expectedModCount和modCount不想等了。
通過(guò)翻閱代碼，我們也可以發(fā)現(xiàn)，remove方法核心邏輯如下：
可以看到，它只修改了modCount，并沒(méi)有對(duì)expectedModCount做任何操作。
簡(jiǎn)單總結(jié)一下，之所以會(huì)拋出ConcurrentModificationException異常，是因?yàn)槲覀兊拇a中使用了增強(qiáng)for循環(huán)，而在增強(qiáng)for循環(huán)中，集合遍歷是通過(guò)iterator進(jìn)行的，但是元素的add/remove卻是直接使用的集合類(lèi)自己的方法。這就導(dǎo)致iterator在遍歷的時(shí)候，會(huì)發(fā)現(xiàn)有一個(gè)元素在自己不知不覺(jué)的情況下就被刪除/添加了，就會(huì)拋出一個(gè)異常，用來(lái)提示用戶(hù)，可能發(fā)生了并發(fā)修改。
5.正確姿勢(shì)
至此，我們介紹清楚了不能在foreach循環(huán)體中直接對(duì)集合進(jìn)行add/remove操作的原因。
但是，很多時(shí)候，我們是有需求需要過(guò)濾集合的，比如刪除其中一部分元素，那么應(yīng)該如何做呢?有幾種方法可供參考：
1、直接使用普通for循環(huán)進(jìn)行操作
我們說(shuō)不能在foreach中進(jìn)行，但是使用普通的for循環(huán)還是可以的，因?yàn)槠胀╢or循環(huán)并沒(méi)有用到Iterator的遍歷，所以壓根就沒(méi)有進(jìn)行fail-fast的檢驗(yàn)。
- List
userNames = new ArrayList () {{ - add("Hollis");
- add("hollis");
- add("HollisChuang");
- add("H");
- }};
- for (int i = 0; i < 1; i++) {
- if (userNames.get(i).equals("Hollis")) {
- userNames.remove(i);
- }
- }
- System.out.println(userNames);
2、直接使用Iterator進(jìn)行操作
除了直接使用普通for循環(huán)以外，我們還可以直接使用Iterator提供的remove方法。
- List
userNames = new ArrayList () {{ - add("Hollis");
- add("hollis");
- add("HollisChuang");
- add("H");
- }};
- Iterator iterator = userNames.iterator();
- while (iterator.hasNext()) {
- if (iterator.next().equals("Hollis")) {
- iterator.remove();
- }
- }
- System.out.println(userNames);
如果直接使用Iterator提供的remove方法，那么就可以修改到expectedModCount的值。那么就不會(huì)再拋出異常了。其實(shí)現(xiàn)代碼如下：
3、使用Java 8中提供的filter過(guò)濾
Java 8中可以把集合轉(zhuǎn)換成流，對(duì)于流有一種filter操作， 可以對(duì)原始 Stream 進(jìn)行某項(xiàng)測(cè)試，通過(guò)測(cè)試的元素被留下來(lái)生成一個(gè)新 Stream。
- List
userNames = new ArrayList () {{ - add("Hollis");
- add("hollis");
- add("HollisChuang");
- add("H");
- }};
- userNames = userNames.stream().filter(userName -> !userName.equals("Hollis")).collect(Collectors.toList());
- System.out.println(userNames);
4、直接使用fail-safe的集合類(lèi)
在Java中，除了一些普通的集合類(lèi)以外，還有一些采用了fail-safe機(jī)制的集合類(lèi)。這樣的集合容器在遍歷時(shí)不是直接在集合內(nèi)容上訪問(wèn)的，而是先復(fù)制原有集合內(nèi)容，在拷貝的集合上進(jìn)行遍歷。
由于迭代時(shí)是對(duì)原集合的拷貝進(jìn)行遍歷，所以在遍歷過(guò)程中對(duì)原集合所作的修改并不能被迭代器檢測(cè)到，所以不會(huì)觸發(fā)ConcurrentModificationException。
- ConcurrentLinkedDeque
userNames = new ConcurrentLinkedDeque () {{ - add("Hollis");
- add("hollis");
- add("HollisChuang");
- add("H");
- }};
- for (String userName : userNames) {
- if (userName.equals("Hollis")) {
- userNames.remove();
- }
- }
基于拷貝內(nèi)容的優(yōu)點(diǎn)是避免了ConcurrentModificationException，但同樣地，迭代器并不能訪問(wèn)到修改后的內(nèi)容，即：迭代器遍歷的是開(kāi)始遍歷那一刻拿到的集合拷貝，在遍歷期間原集合發(fā)生的修改迭代器是不知道的。
java.util.concurrent包下的容器都是安全失敗，可以在多線程下并發(fā)使用，并發(fā)修改。
5、使用增強(qiáng)for循環(huán)其實(shí)也可以
如果，我們非常確定在一個(gè)集合中，某個(gè)即將刪除的元素只包含一個(gè)的話， 比如對(duì)Set進(jìn)行操作，那么其實(shí)也是可以使用增強(qiáng)for循環(huán)的，只要在刪除之后，立刻結(jié)束循環(huán)體，不要再繼續(xù)進(jìn)行遍歷就可以了，也就是說(shuō)不讓代碼執(zhí)行到下一次的next方法。
- List
userNames = new ArrayList () {{ - add("Hollis");
- add("hollis");
- add("HollisChuang");
- add("H");
- }};
- for (String userName : userNames) {
- if (userName.equals("Hollis")) {
- userNames.remove(userName);
- break;
- }
- }
- System.out.println(userNames);
以上這五種方式都可以避免觸發(fā)fail-fast機(jī)制，避免拋出異常。如果是并發(fā)場(chǎng)景，建議使用concurrent包中的容器，如果是單線程場(chǎng)景，Java8之前的代碼中，建議使用Iterator進(jìn)行元素刪除，Java8及更新的版本中，可以考慮使用Stream及filter。
6.總結(jié)
我們使用的增強(qiáng)for循環(huán)，其實(shí)是Java提供的語(yǔ)法糖，其實(shí)現(xiàn)原理是借助Iterator進(jìn)行元素的遍歷。
但是如果在遍歷過(guò)程中，不通過(guò)Iterator，而是通過(guò)集合類(lèi)自身的方法對(duì)集合進(jìn)行添加/刪除操作。那么在Iterator進(jìn)行下一次的遍歷時(shí)，經(jīng)檢測(cè)發(fā)現(xiàn)有一次集合的修改操作并未通過(guò)自身進(jìn)行，那么可能是發(fā)生了并發(fā)被其他線程執(zhí)行的，這時(shí)候就會(huì)拋出異常，來(lái)提示用戶(hù)可能發(fā)生了并發(fā)修改，這就是所謂的fail-fast機(jī)制。
當(dāng)然還是有很多種方法可以解決這類(lèi)問(wèn)題的。比如使用普通for循環(huán)、使用Iterator進(jìn)行元素刪除、使用Stream的filter、使用fail-safe的類(lèi)等。
好啦，以上就是本文的全部?jī)?nèi)容。主要介紹了阿里巴巴Java開(kāi)發(fā)手冊(cè)禁止在foreach循環(huán)體中進(jìn)行元素的add/remove等原因及背后原理。
【本文是專(zhuān)欄作者Hollis的原創(chuàng)文章，作者微信公眾號(hào)Hollis(ID：hollischuang)】
文章名稱(chēng)：為什么阿里巴巴禁止在foreach循環(huán)里進(jìn)行元素的remove/add操作
標(biāo)題鏈接：http://fisionsoft.com.cn/article/cdgeehs.html
