参考文献:https://juejin.im/post/6844903794795347981
在阿里巴巴Java开发手册中,有这样一条规定:
但是手册中并没有给出具体原因,本文就来深入分析一下该规定背后的思考。
foreach循环
以下实例演示了 普通for循环 和 foreach循环使用:
public static void main(String[] args) {
List<String> userNames=ListUser();
System.out.println("使用for循环遍历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);
}
}
private static List<String> ListUser() {
List<String> userNames = new ArrayList();
userNames.add("Hollis");
userNames.add("hollis");
userNames.add("HollisChuang");
userNames.add("H");
return userNames;
}
结果:
可以看到,使用foreach语法遍历集合或者数组的时候,可以起到和普通for循环同样的效果,并且代码更加简洁。所以,foreach循环也通常也被称为增强for循环。
其实,增强for循环也是Java给我们提供的一个语法糖,如果将以上代码编译后的class文件进行反编译(使用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);
可以发现,原本的增强for循环,其实是依赖了while循环和Iterator实现的。
问题重现
规范中指出不让我们在foreach循环中对集合元素做add/remove操作,那么,我们尝试着做一下看看会发生什么问题。
List<String> userNames = new ArrayList<String>() {{
add("Hollis");
add("hollis");
add("HollisChuang");
add("H");
}};
System.out.println("刪除之前"+userNames);
for (int i = 0; i < userNames.size(); i++) {
if(userNames.get(i).equals("Hollis"));
userNames.remove(i);
}
System.out.println("刪除之后"+userNames);
结果:
以上是哪使用普通的for循环在遍历的同时进行删除,那么,我们再看下,如果使用增强for循环的话会发生什么:
List<String> userNames = new ArrayList<String>() {{
add("Hollis");
add("hollis");
add("HollisChuang");
add("H");
}};
System.out.println("刪除之前"+userNames);
for (String userName : userNames) {
if (userName.equals("Hollis")) {
userNames.remove(userName);
}
}
System.out.println("刪除之后"+userNames);
以上代码,使用增强for循环遍历元素,并尝试删除其中的Hollis字符串元素。运行以上代码,会抛出以下异常:
同样的,读者可以尝试下在增强for循环中使用add方法添加元素,结果也会同样抛出该异常。之所以会出现这个异常,是因为触发了一个Java集合的错误检测机制——fail-fast 。
正确姿势
1、直接使用Iterator进行操作
可以直接使用Iterator提供的remove方法。
List<String> userNames = new ArrayList<String>() {{
add("Hollis");
add("hollis");
add("HollisChuang");
add("H");
}};
System.out.println("刪除之前"+userNames);
Iterator iterator = userNames.iterator();
while (iterator.hasNext()) {
if (iterator.next().equals("Hollis")) {
iterator.remove();
}
}
System.out.println("刪除之后"+userNames);
2、使用Java 8中提供的filter过滤
List<String> userNames = new ArrayList<String>() {{
add("Hollis");
add("hollis");
add("HollisChuang");
add("H");
}};
System.out.println("刪除之前"+userNames);
userNames = userNames.stream().filter(userName -> !userName.equals("Hollis")).collect(Collectors.toList());
System.out.println("刪除之后"+userNames);
3.使用增强for循环其实也可以
如果,我们非常确定在一个集合中,某个即将删除的元素只包含一个的话, 比如对Set进行操作,那么其实也是可以使用增强for循环的,只要在删除之后,立刻结束循环体,不要再继续进行遍历就可以了,也就是说不让代码执行到下一次的next方法。
List<String> userNames = new ArrayList<String>() {{
add("Hollis");
add("hollis");
add("HollisChuang");
add("H");
}};
System.out.println("刪除之前"+userNames);
for (int i = 0; i < userNames.size(); i++) {
if(userNames.get(i).equals("Hollis"));
userNames.remove(i);
break;
}
System.out.println("刪除之后"+userNames);
4、直接使用fail-safe的集合类
在Java中,除了一些普通的集合类以外,还有一些采用了fail-safe机制的集合类。这样的集合容器在遍历时不是直接在集合内容上访问的,而是先复制原有集合内容,在拷贝的集合上进行遍历。
由于迭代时是对原集合的拷贝进行遍历,所以在遍历过程中对原集合所作的修改并不能被迭代器检测到,所以不会触发ConcurrentModificationException。
public static void main(String[] args) {
ConcurrentLinkedDeque<String> userNames = new ConcurrentLinkedDeque<String>() {{
add("Hollis");
add("hollis");
add("HollisChuang");
add("H");
}};
System.out.println("刪除之前"+userNames);
for (String userName : userNames) {
if (userName.equals("Hollis")) {
userNames.remove();
}
}
System.out.println("刪除之后"+userNames);
}
基于拷贝内容的优点是避免了ConcurrentModificationException,但同样地,迭代器并不能访问到修改后的内容,即:迭代器遍历的是开始遍历那一刻拿到的集合拷贝,在遍历期间原集合发生的修改迭代器是不知道的。
java.util.concurrent包下的容器都是安全失败,可以在多线程下并发使用,并发修改。
总结
我们使用的增强for循环,其实是Java提供的语法糖,其实现原理是借助Iterator进行元素的遍历。
但是如果在遍历过程中,不通过Iterator,而是通过集合类自身的方法对集合进行添加/删除操作。那么在Iterator进行下一次的遍历时,经检测发现有一次集合的修改操作并未通过自身进行,那么可能是发生了并发被其他线程执行的,这时候就会抛出异常,来提示用户可能发生了并发修改,这就是所谓的fail-fast机制。
当然还是有很多种方法可以解决这类问题的。比如使用Iterator进行元素删除、使用Stream的filter、使用fail-safe的类等。