Java集合-Iterator

Java Iterator接口表示一个对象，该对象能够遍历Java对象的集合，一次迭代一个对象。Iterator 接口是Java中用于迭代对象集合的最古老的机制之一（尽管不是最早的-Enumerator 早于Iterator ）。

使用java的Iterator ，首先从需要迭代的对象集合中获取一个Iterator 实例。获得的迭代器跟踪底层集合中的元素，以确保遍历所有元素。如果在遍历指向该集合的迭代器时，修改基础集合，迭代器通常会检测到它，并在下次尝试从迭代器获取下一个元素时抛出异常。下面会继续讲述。

Iterator核心方法

Iterator接口非常简单，下面是核心方法：

获取Iterator

通常情况下，将通过从包含多个嵌套对象的Java对象获取迭代器来与它交互。标准的java集合接口Collection 包含一个iterator()方法，调用iterator()方法可以从Collection中获取一个迭代器。可以从java集合各个数据结构中获取Iterator 例如, List, Set, Map, Queue, Deque或者 Map。下面是从各个集合中获取Iterator 的例子：

List<String> list = new ArrayList<>();
list.add("one");
list.add("two");
list.add("three");
 
Iterator<String> iterator = list.iterator();

Set<String> set = new HashSet<>();
set.add("one");
set.add("two");
set.add("three");
 
Iterator<String> iterator2 = set.iterator();

迭代Iterator

可以用while 循环迭代Iterator ，下面是例子：

Iterator iterator = list.iterator();
 
while(iterator.hasNext()) {
    Object nextObject = iterator.next();
 
}

上面的例子使用了Iterator 的两个方法，第一个 hasNext()，如果Iterator 还有元素则返回true。换句话说，如果迭代器还没有遍历从中获取迭代器的集合中的所有元素，hasNext（）方法将返回true。如果迭代器迭代了底层集合中的所有元素，hasNext（）方法返回false。

第二个方法是next()，next()返回Iterator 的下一个元素。

迭代顺序

Iterator的顺序取决于迭代的集合，例如从List中获取的Iterator ，则元素的存储顺序与List中的元素引用，另一方面，从Set中获得的迭代器并不保证集合中元素的精确迭代顺序。

List的Iterator

下面是从List 实例中获取Iterator ：

List list = new ArrayList();
 
list.add("123");
list.add("456");
list.add("789");
 
Iterator iterator = list.iterator();

Set的Iterator

下面是从Set中获取Iterator 实例：

Set set = new HashSet();
 
set.add("123");
set.add("456");
set.add("789");
 
Iterator iterator = set.iterator();

迭代时修改集合

有些集合使用Iterator 迭代时不允许修改集合，否则在迭代器下一次调用next()方法时，会抛ConcurrentModificationException ，下面是例子：

package cn.com.codingce.collection;
 
 
 
import java.util.ArrayList;
 
import java.util.Iterator;
 
import java.util.List;
 
 
 
public class IteratorTest {
 
 
 
    public static void main(String[] args) {
 
        List<String> list = new ArrayList<>();
 
 
 
        list.add("123");
 
        list.add("456");
 
        list.add("789");
 
 
 
        Iterator<String> iterator = list.iterator();
 
 
 
        while(iterator.hasNext()) {
 
            String value = iterator.next();
 
 
 
            if(value.equals("456")){
 
                list.add("999");
 
            }
 
        }
 
    }
 
}

执行结果：

Exception in thread "main" java.util.ConcurrentModificationException
 
    at java.util.ArrayList$Itr.checkForComodification(Unknown Source)
 
    at java.util.ArrayList$Itr.next(Unknown Source)
 
    at com.ck.collection.IteratorTest.main(IteratorTest.java:19)

如果通过Iterator迭代集合的同时修改了集合，则会引发ConcurrentModificationException，因为迭代器与集合不同步。

迭代时移除元素

Java迭代器接口有一个remove（）方法，可以从底层集合中移除next（）刚刚返回的元素,调用remove()方法不会抛ConcurrentModificationException 异常，下面是代码：

List<String> list = new ArrayList<>();
 
list.add("123");
list.add("456");
list.add("789");
 
Iterator<String> iterator = list.iterator();
 
while(iterator.hasNext()) {
    String value = iterator.next();
 
    if(value.equals("456")){
        iterator.remove();
    }
}

forEachRemaining()

forEachRemaining()方法，可以迭代Iterator内部剩余的元素，对于每个元素，调用作为参数传递给forEachRemaining（）的Lambda表达式，下面是代码：

List<String> list = new ArrayList<>();
list.add("Jane");
list.add("Heidi");
list.add("Hannah");
 
Iterator<String> iterator = list.iterator();
        
iterator.forEachRemaining((element) -> {
    System.out.println(element);
});

ListIterator

Java 还有一个接口ListIterator继承了Iterator接口，ListIterator接口，它表示一个双向迭代器，意味着可以向前和向后迭代元素的迭代器。

这儿不详细讲解，用一个例子说明怎么使用:

List<String> list = new ArrayList<>();
list.add("Jane");
list.add("Heidi");
list.add("Hannah");
 
ListIterator<String> listIterator = list.listIterator();
        
while(listIterator.hasNext()) {
    System.out.println(listIterator.next());
}
        
while(listIterator.hasPrevious()) {
    System.out.println(listIterator.previous());
}

上面可以看到，第一个例子ListIterator向后迭代，第二个例子向前迭代。

实现Iterator接口

如果有一个特殊的、定制的集合类型，那么可以自己实现Iterator接口来创建一个迭代器，该迭代器可以遍历自定义集合的元素。在本节中，将展示一个超简单的Java迭代器接口的定制实现，将了解实现迭代器接口的外观。将为其实现迭代器的集合是一个标准的List,它不是一个完全完美的实现，因为它不能在迭代期间检测到列表内容的更改，但是它足以让您了解迭代器实现的外观,下面是代码：

import java.util.Iterator;
import java.util.List;
 
public class ListIterator <T> implements Iterator<T> {
 
    private List<T> source = null;
    private int index = 0;
 
    public ListIterator(List<T> source){
        this.source = source;
    }
 
 
    @Override
    public boolean hasNext() {
        return this.index < this.source.size();
    }
 
    @Override
    public T next() {
        return this.source.get(this.index++);
    }
 
}

下面是一个在上面的ListIterator的迭代过程中它的外观的示例：

import java.util.ArrayList;
import java.util.List;
 
public class ListIteratorExample {
 
    public static void main(String[] args) {
        List<String> list = new ArrayList();
 
        list.add("one");
        list.add("two");
        list.add("three");
 
        ListIterator<String> iterator = new ListIterator<>(list);
        while(iterator.hasNext()) {
            System.out.println( iterator.next() );
        }
 
    }
}