Java-迭代器

reve
161 阅读3分钟

Iterator迭代器

Iterator类详解

java中提供了很多个集合，它们在存储元素时，采用的存储方式不同。我们要取出这些集合中的元素，可通过一种通用的获取方式来完成。这样使得对容器的遍历操作与其具体的底层实现相隔离，达到解耦的效果。

Collection 集合元素的通用获取方式：在取元素之前先要判断集合中有没有元素，如果有元素则把元素取出，然后继续再判断下一个元素，如果还有就再取出，直到把集合中的所有元素全部取出为止。这种取出方式专业术语称为迭代。

image.png

Collection 集合中把这种取元素的方式描述在 Iterator 接口中，Iterator 接口的常用方法如下：

方法名描述
boolean hasNext();判断集合中是否有下一个元素可以迭代，如果有，则返回 true。
Object next();返回迭代的下一个元素，并把指针向后移动一位。
void remove();将迭代器当前返回的元素删除(可选操作)。

对于Iterator而言，因为本身是一个接口，所以要想实例化则必须依靠Collection接口完成，也就是使用Collection接口的Iterator iterator()方法。

【示例】使用迭代器遍历ArrayList元素

/*
    @Author xiangge
    @Date 2023/7/19 
    @Description  使用迭代器遍历ArrayList集合
*/
public class IteratorDemo1 {
    public static void main(String[] args) {
        ArrayList<String> list = new ArrayList<>();
        list.add("aa");
        list.add("bb");
        list.add("cc");
        list.add("dd");
        list.add("ee");
​
        // 获取迭代器对象
        Iterator<String> iterator = list.iterator();
​
        // 使用while循环迭代
        while (iterator.hasNext()){
            System.out.println(iterator.next());
        }
        System.out.println("--------------------------------");
        for(  Iterator<String> iterator2 = list.iterator();iterator2.hasNext();){
            System.out.println(iterator2.next());
        }
    }
}

注意：在进行集合元素取出时，如果集合中已经没有元素了，还继续使用迭代器的 next()方法，将会抛出java.util.NoSuchElementException没有集合元素的异常。

image.png

如果在迭代过程中，使用了集合的方法对元素进行操作。导致迭代器并不知道集合中的变化，容易引发数据的不确定性，从而会抛出并发修改异常（java.util.ConcurrentModificationException）。

【示例】使用迭代器时，通过集合的方法对元素进行操作的错误案例

/*
    @Author xiangge
    @Date 2023/7/19 
    @Description  并发修改异常案例
*/
public class IteratorDemo2 {
    public static void main(String[] args) {
        ArrayList<Integer> list = new ArrayList<>();
        list.add(11);
        list.add(22);
        list.add(33);
        list.add(44);
        list.add(55);
        Iterator<Integer> iterator = list.iterator();
        while (iterator.hasNext()){
            Integer yuanSu = iterator.next();
            if (yuanSu < 30) {
                list.remove(yuanSu);
            }
            System.out.println(yuanSu);
        }
    }
}

以上代码执行的时候，会抛出java.util.ConcurrentModificationException异常。

image.png

如果在使用迭代器的过程中，必须要对集合中的元素进行删除操作，那么我们可以使用Iterator 类提供的remove()方法来实现。

【示例】使用迭代器时，通过迭代器的remove()方法删除集合元素案例

public class IteratorDemo2 {
    public static void main(String[] args) {
        ArrayList<Integer> list = new ArrayList<>();
        list.add(11);
        list.add(22);
        list.add(33);
        list.add(44);
        list.add(55);
        Iterator<Integer> iterator = list.iterator();
        while (iterator.hasNext()){
            Integer yuanSu = iterator.next();
            if (yuanSu < 30) {
                iterator.remove();
            }
            System.out.println(yuanSu);
        }
        System.out.println(list);// [33, 44, 55]
    }
}

但是使用Iterator提供的方法只能实现删除元素（remove）操作，如果还想在迭代过程中实现集合的添加元素（add）操作，那么可以使用ListIterator来实现。

另外，通过for-each遍历集合的过程中，不能通过集合的方法对元素进行操作，否则会抛出并发修改异常，因为for-each循环底层用的就是Iterator来实现的。

  • Iterator和for-each的区别

(1) for-each不但能遍历集合，还能遍历数组，但是Iterator只能遍历集合。

(2) 使用for-each遍历集合时不能删除元素，使用Iterator遍历集合时，还可以使用Iterator的remove方法删除元素。

Iterator的实现原理

迭代器是一种设计模式，它是一个对象，它可以遍历并选择序列中的对象，而开发人员不需要了解该序列的底层结构。迭代器通常被称为“轻量级”对象，因为创建它的代价小。

Java中的Iterator功能比较简单，并且只能单向移动（从前往后）：

  • 使用iterator()方法要求容器返回一个Iterator，iterator()方法是java.lang.Iterable接口的抽象方法。
  • 使用hasNext()检查序列中是否还有元素。
  • 使用next()获得序列中的下一个元素。

【示例】模拟ArrayList的Iterator实现

// 集合类实现Iterable接口
class MyArrayList implements Iterable {
    // 存放数据的数组
    private Object[] elementData = {"a", "b", "c", "d", "e"};
    // 数组的长度
    private int size = elementData.length;
    // 获取元素方法
    public Object get(int index) {
        // 断索引是否越界，请字节处理，此处是阉割版。。。
        return elementData[index];
    }
    // 获取迭代器
    @Override
    public Iterator iterator() {
        return new MyIterator(0);
    }
    // 匿名内部类，实现容器的迭代器功能
    private class MyIterator implements Iterator {
        // 游标，表示下一个元素的索引位置
        private int cursor;
        // 构造方法
        public MyIterator() {
            this(0);
        }
        public MyIterator(int cursor) {
            this.cursor = cursor;
        }
        // 判断迭代器是否有下一个元素
        @Override
        public boolean hasNext() {
            return cursor != size;
        }
        // 获取下一个元素
        @Override
        public Object next() {  
            // 获取集合中当前游标对应的元素
            Object value = get(cursor);
            // 游标累加,保存下一个元素的索引位置
            cursor++;
            // 返回元素值
            return value;
        }
    }
}

ListIterator类详解

ListIterator 是 Iterator 的子接口，但它比 Iterator 更加的强大，提供了更多在迭代过程中使用的方法，ListIterator 接口常用方法：

方法名描述
boolean hasNext();以正向遍历列表时，判断迭代器后面是否还有元素。
Object next();返回列表中ListIterator指向位置后面的元素。
boolean hasPrevious();以逆向遍历列表，判断迭代器前面是否还有元素。
Object previous();返回列表中ListIterator指向位置前面的元素。
void remove();从列表中删除next()或previous()返回的最后一个元素。
void set(Object e);从列表中将next()或previous()返回的元素更改为指定元素。
void add(Object e);将指定的元素插入列表，插入位置为迭代器当前位置之前。

ListIterator接口获取方式：

public ListIterator listIterator();返回列表中的列表迭代器，游标位置默认为0。

public ListIterator listIterator(final int index);从列表中的指定位置开始，返回列表中的元素(游标位置为index)的列表迭代器。

【示例】 ListIterator迭代ArrayList元素

package com.huayu.iterator;
​
import java.util.ArrayList;
import java.util.ListIterator;
​
/*
    @Author xiangge
    @Date 2023/7/19 
    @Description 使用ListIterator 迭代 List集合中的元素
*/
public class IteratorDemo4 {
    public static void main(String[] args) {
        ArrayList<Integer> list = new ArrayList<>();
        list.add(11);
        list.add(22);
        list.add(33);
        list.add(44);
        list.add(55);
​
        // 创建listIterator迭代器对象
        ListIterator<Integer> listIterator1 = list.listIterator();
​
        // 迭代遍历: 从前往后
        while (listIterator1.hasNext()) {
            System.out.println(listIterator1.next());
        }
        System.out.println("----------------------------------------");
        // 创建listIterator迭代器对象      list.size() : 指定迭代器在集合的最大索引处
        // 注意：传入集合的长度，最大取到集合的长度-1
        ListIterator<Integer> listIterator2 = list.listIterator(list.size());
​
        // 迭代遍历： 从后往前
        while (listIterator2.hasPrevious()) {
            System.out.println(listIterator2.previous());
        }
    }
}

思考：Iterator只提供了删除元素的方法remove，如果我们想要在遍历的时候添加元素怎么？

通过 ListIterator 迭代器来操作元素，ListIterator接口允许程序员按照任一方向遍历列表，并且允许迭代期间操作集合中的元素。

【示例】迭代过程中对ArrayList元素操作

package com.huayu.iterator;
​
import java.util.ArrayList;
import java.util.ListIterator;
​
/*
    @Author xiangge
    @Date 2023/7/19 
    @Description 使用ListIterator 在迭代过程中修改元素
*/
public class IteratorDemo5 {
    public static void main(String[] args) {
        ArrayList<Integer> list = new ArrayList<>();
        list.add(11);
        list.add(22);
        list.add(33);
        list.add(44);
        list.add(55);
​
        // 创建listIterator迭代器对象
        ListIterator<Integer> listIterator1 = list.listIterator();
​
        // 迭代遍历: 从前往后
        while (listIterator1.hasNext()) {
            listIterator1.add(66);// 每次添加的元素会存入迭代器指针的左边
            System.out.println(listIterator1.next());
            listIterator1.set(77); // 将next() 或者 previous() 方法返回的值更改为： 77
        }
        System.out.println("list = " + list);
    }
}

Iterator和ListIterator的区别

  • Iterator应用于Set和List集合及其子类型，但是ListIterator只能用于List及其子类型。
  • Iterator和ListIterator都有hasNext()和next()方法，可以实现顺序向后遍历，但是ListIterator有hasPrevious()和previous()方法，可以实现逆向(顺序向前)遍历。
  • Iterator和ListIterator都有remove()方法，但是ListIterator还有add()方法和set()方法。
avatar
文章
阅读
粉丝