设计模式之迭代器模式

迭代器模式

概述

迭代器模式（Iterator），提供一种方法顺序访问一个聚合对象中的各种元素，而又不暴露该对象的内部表示。

对于Java来说迭代器并不陌生，比如map的遍历就是使用迭代器来实现的。

示例程序

我们模拟将书放在书架上，并且按照顺序显示出来

名字	说明
Aggregate	表示集合的接口
Iterator	遍历集合的接口
Book	表示书的类
BookShelf	表示书架的类
BookShelfIterator	遍历书架的类

UML类图

代码实现

Aggregate

想要遍历集合中的元素时，可以调用iterator方法来生成Iterator实例

public interface Aggregate {
    Iterator iterator();
}

Iterator

hasNext方法判断集合中是否还有下一个元素，next方法是获取集合中的下一个元素

public interface Iterator {
    boolean hasNext();
    Object next();
}

Book

粗略的写一下Book实体类，在这段程序中并不重要

@Data
@NoArgsConstructor
@AllArgsConstructor
public class Book {
    private String name;
}

BookShelf

BookShelf可以将他看成类似于集合的东西，底层使用数组来存储数据

public class BookShelf implements Aggregate {
    private Book[] books;
    private int last;

    public BookShelf(int maxSize){
        this.books = new Book[maxSize];
    }
	//根据下标获取书
    public Book getBookAt(int index){
        return books[index];
    }
	//添加书籍
    public void appendBook(Book book){
        this.books[last] = book;
        last++;
    }
	//获取集合的长度
    public int getLength(){
        return last;
    }

    @Override
    public Iterator iterator() {
        return new BookShelfIterator(this);
    }
}

BookShelfIterator

BookShelfIterator是核心类，主要实现Iterator接口中的方法

public class BookShelfIterator implements Iterator {
    private BookShelf bookShelf;
    private int index;

    public BookShelfIterator(BookShelf bookShelf) {
        this.bookShelf = bookShelf;
        this.index = 0;
    }

    @Override
    public boolean hasNext() {
        if (index < bookShelf.getLength()){
            return true;
        }
        return false;
    }

    @Override
    public Object next() {
        Book bookAt = bookShelf.getBookAt(index);
        index++;
        return bookAt;
    }
}

Test

@SpringBootTest
class Practice1800ApplicationTests {

    @Test
    void contextLoads() {
        BookShelf bookShelf = new BookShelf(4);
        bookShelf.appendBook(new Book("钢铁是怎样练成的"));
        bookShelf.appendBook(new Book("八十天环游世界"));
        bookShelf.appendBook(new Book("孔乙己"));
        bookShelf.appendBook(new Book("朝花夕拾"));

        Iterator iterator = bookShelf.iterator();
        while (iterator.hasNext()){
            Book book = (Book) iterator.next();
            System.out.println(book);
        }
    }

}

//结果
Book(name=钢铁是怎样练成的)
Book(name=八十天环游世界)
Book(name=孔乙己)
Book(name=朝花夕拾)

登场角色

• Iterator（迭代器）

  该角色负责定义按顺序逐个遍历元素的接口，在示例程序中由Iterator接口扮演。它定义了两个方法，hasNext判断集合是否遍历完，next返回当前元素，并指向下一个原色

• ConcreteIterator（具体的迭代器）

  该角色实现了Iterator角色定义的接口，在示例程序中由BookShelfIterator扮演该角色。该角色包含了遍历集合所需要的信息

• Aggregate（集合）

  该角色负责定义创建Iterator角色的接口。这个接口是一个方法，会创建出按顺序访问保存在内部元素的人。在示例程序中由Aggregate扮演该角色

• ConcreteAggregate（具体的集合）

  该角色负责实现Aggregate角色所定义的接口。他会创建出Iterator角色。在示例程序中由BookShelf扮演该角色

总结

迭代器模式从以上的功能实现可以看到，满足了单一职责和开闭原则，外界的调用方不需要知道任何一个不同的数据结构在使用上的遍历差异。可以非常方便的扩展，也让整个遍历变得更加干净。