设计模式学习笔记（十六）迭代器模式及其在Java 容器中的应用-6ren

设计模式学习笔记（十六）迭代器模式及其在Java 容器中的应用

转载作者：知者更新时间：2024-03-13 02:38:07

迭代器（Iterator）模式，也叫做游标（Cursor）模式。我们知道，在Java 容器中，为了提高容器遍历的方便性，我们利用迭代器把遍历逻辑从不同类型的集合类中抽取出来，从而避免向外部暴露集合容器的内部结构。这就是迭代器模式的

一、迭代器模式介绍

迭代器模式也就是提供一个对象来顺序访问聚合对象中的一系列数据，而不暴露聚合对象的内部表示。它是一种行为型模式，下面就来看看迭代器模式的结构：

1.1 迭代器模式的结构

迭代器模式的结构很简单，就是将聚合对象中的遍历行为分离，并抽象成迭代器类来实现：

Aggregate：抽象聚合接口，定义对聚合对象的一些操作和创建迭代器对象的接口
Iterator：抽象迭代器接口，定义访问和遍历聚合元素的接口
Aggregate1：具体聚合实现，实现抽象聚合接口，返回一个具体迭代器实例对象
Iterator1：具体迭代器实现，实现抽象迭代器接口中所定义的方法

1.2 迭代器模式的实现

根据上面的类图，可以实现如下代码：

/**
 * @description: 抽象聚合接口
 * @author: wjw
 * @date: 2022/4/6
 */
public interface Aggregate {
    /**
     * 增加对象
     * @param obj 对象
     */
    void add(Object obj);

    /**
     * 移除对象
     * @param obj 对象
     */
    void remove(Object obj);

    /**
     * 调用迭代器
     * @return 迭代器
     */
    Iterator getIterator();
}

/**
 * @description: 具体迭代器类
 * @author: wjw
 * @date: 2022/4/6
 */
public class Aggregate1 implements Aggregate{

    private List<Object> list = new ArrayList<>();

    @Override
    public void add(Object obj) {
        list.add(obj);
    }

    @Override
    public void remove(Object obj) {
        list.remove(obj);
    }

    @Override
    public Iterator getIterator() {
        return new Iterator1(list);
    }
}
/**
 * @description: 抽象迭代器
 * @author: wjw
 * @date: 2022/4/6
 */
public interface Iterator {

    /**
     * 调用第一个对象
     * @return 对象
     */
    Object first();

    /**
     * 调用下一个对象
     * @return 对象
     */
    Object next();

    /**
     * 迭代器中是否还有下一个对象
     * @return
     */
    boolean hasNext();

}

/**
 * @description: 具体迭代器类
 * @author: wjw
 * @date: 2022/4/6
 */
public class Iterator1 implements Iterator{

    private List<Object> list = null;
    private int index = -1;

    public Iterator1(List<Object> list) {
        this.list = list;
    }

    @Override
    public Object first() {
        index = 0;
        Object obj = list.get(index);
        return obj;
    }

    @Override
    public Object next() {
        Object obj = null;
        if (this.hasNext()) {
            obj = list.get(++index);
        }
        return obj;
    }

    @Override
    public boolean hasNext() {
        if (index < list.size() - 1) {
            return true;
        } else {
            return false;
        }
    }
}
/**
 * @description: 客户端类
 * @author: wjw
 * @date: 2022/4/6
 */
public class Client {
    public static void main(String[] args) {
        Aggregate1 aggregate1 = new Aggregate1();
        aggregate1.add("A");
        aggregate1.add("B");
        aggregate1.add("C");
        System.out.println("聚合对象有：");
        Iterator iterator = aggregate1.getIterator();
        while (iterator.hasNext()) {
            Object obj = iterator.next();
            System.out.println(obj.toString());
        }
        Object first = iterator.first();
        System.out.println("第一个聚合对象是：" + first.toString());
    }
}

客户端测试场结果为：

聚合对象有：
A
B
C
第一个聚合对象是：A

二、迭代器模式的应用场景

2.1 Java 集合容器

Java 集合容器中的使用就是容器中的迭代器了，以ArrayList为例，ArrayList是继承Collection的：

我们发现ArrayList类里面实现迭代器接口的内部类：

其中Itr实现Iterator，ListItr继承Itr并实现ListIterator，ListIterator是Iterator功能的扩展。所以实际上ArrayList是抽象聚合和抽象迭代器两者的具体实现，可以画出大致结构图如下：

举个使用ArrayList的例子：

public static void main(String[] args) {
    ArrayList<String> list = new ArrayList<>();
    list.add("A");
    list.add("B");
    list.add("C");
    Iterator<String> iterator = list.iterator();
    System.out.println("ArrayList中的聚合对象为：");
    while (iterator.hasNext()) {
        String next = iterator.next();
        System.out.println(next);
    }
}

输出结果：

ArrayList中的聚合对象为：
A
B
C

在日常业务的开发中，迭代器模式使用的场景并不多，下面就来看看关于迭代器的实战

三、迭代器模式实战

在本案例中模拟迭代遍历输出公司中树形结构的组织结构关系中雇员列表：

利用迭代器模式实现的结构如下：

上面结构是以Java容器中迭代器模式基础构建的，左边是迭代器的定义，右边是实现的迭代器功能。具体代码结构图如下：

├─src
│  ├─main
│  │  ├─java
│  │  │  ├─group
│  │  │  │      Employee.java
│  │  │  │      GroupStructure.java
│  │  │  │      Link.java
│  │  │  │
│  │  │  └─lang
│  │  │          Collection.java
│  │  │          Iterable.java
│  │  │          Iterator.java
│  │  │
│  │  └─resources
│  └─test
│      └─java
│              ApiTest.java

对于lang包下是迭代器实现部分，具体代码如下：

/**
 * @description: 可迭代接口定义
 * @author: wjw
 * @date: 2022/4/6
 */
public interface Iterator<E> {

    boolean hasNext();

    E next();
}
/**
 * @description:
 * @author: wjw
 * @date: 2022/4/6
 */
public interface Iterable<E> {

    Iterator<E> iterator();
}
/**
 * @description: 集合功能接口
 * @author: wjw
 * @date: 2022/4/6
 */
public interface Collection<E, L> extends Iterable<E> {

    boolean add(E e);

    boolean remove(E e);

    boolean addLink(String key, L l);

    boolean removeLink(String key);

    /**
     * 继承Iterable接口的方法
     * @return Iterator
     */
    @Override
    Iterator<E> iterator();
}

group包下是组织结构以及聚类对象及其实现，具体代码如下所示：

/**
 * @description: 雇员类
 * @author: wjw
 * @date: 2022/4/6
 */
public class Employee {

    private String uId;
    private String name;
    private String desc;

    public Employee(String uId, String name, String desc) {
        this.uId = uId;
        this.name = name;
        this.desc = desc;
    }

    public String getuId() {
        return uId;
    }

    public void setuId(String uId) {
        this.uId = uId;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public String getDesc() {
        return desc;
    }

    public void setDesc(String desc) {
        this.desc = desc;
    }
}
/**
 * @description: 树节点链路
 * @author: wjw
 * @date: 2022/4/6
 */
public class Link {

    private String fromId;
    private String toId;

    public Link(String fromId, String toId) {
        this.fromId = fromId;
        this.toId = toId;
    }

    public String getFromId() {
        return fromId;
    }

    public void setFromId(String fromId) {
        this.fromId = fromId;
    }

    public String getToId() {
        return toId;
    }

    public void setToId(String toId) {
        this.toId = toId;
    }
}
/**
 * @description: 迭代器功能实现
 * @author: wjw
 * @date: 2022/4/6
 */
public class GroupStructure implements Collection<Employee, Link> {

    /**组织ID*/
    private String groupId;

    /**组织名称*/
    private String groupName;

    /**雇员列表*/
    private Map<String, Employee> employeeMap = new ConcurrentHashMap<>();

    /**组织架构关系*/
    private Map<String, List<Link>> linkMap = new ConcurrentHashMap<>();

    /**反向关系链*/
    private Map<String, String> invertedMap = new ConcurrentHashMap<>();

    public GroupStructure(String groupId, String groupName) {
        this.groupId = groupId;
        this.groupName = groupName;
    }

    @Override
    public boolean add(Employee employee) {
        return null != employeeMap.put(employee.getuId(), employee);
    }

    @Override
    public boolean remove(Employee employee) {
        return null != employeeMap.remove(employee.getuId());
    }

    @Override
    public boolean addLink(String key, Link link) {
        invertedMap.put(link.getToId(), link.getFromId());
        if (linkMap.containsKey(key)) {
            return linkMap.get(key).add(link);
        } else {
            List<Link> links = new LinkedList<>();
            links.add(link);
            linkMap.put(key, links);
            return true;
        }
    }

    @Override
    public boolean removeLink(String key) {
        return null != linkMap.remove(key);
    }

    @Override
    public Iterator<Employee> iterator() {
        return new Iterator<Employee>() {

            HashMap<String, Integer> keyMap = new HashMap<>();
            int totalIdx = 0;
            //雇员ID,From
            private String fromId = groupId;
            //雇员ID,To
            private String toId = groupId;

            @Override
            public boolean hasNext() {
                return totalIdx < employeeMap.size();
            }

            @Override
            public Employee next() {
                List<Link> links = linkMap.get(toId);
                int cursorIdx = getCursorIdx(toId);

                //同级扫描
                if (null == links) {
                    cursorIdx = getCursorIdx(fromId);
                    links = linkMap.get(fromId);
                }
                //上级节点扫描
                while (cursorIdx > links.size() - 1) {
                    fromId = invertedMap.get(fromId);
                    cursorIdx = getCursorIdx(fromId);
                    links = linkMap.get(fromId);
                }

                //获取节点
                Link link = links.get(cursorIdx);
                toId = link.getToId();
                fromId = link.getFromId();
                totalIdx++;

                //返回最终结果
                return employeeMap.get(link.getToId());
            }

            //给每个层级定义宽度遍历进度
            public int getCursorIdx(String key) {
                int idx = 0;
                if (keyMap.containsKey(key)) {
                    idx = keyMap.get(key);
                    keyMap.put(key, ++idx);
                } else {
                    keyMap.put(key, idx);
                }
                return idx;
            }
        };
    }
}

最后是测试类及其结果：

/**
 * @description: 单元测试类
 * @author: wjw
 * @date: 2022/4/6
 */
public class ApiTest {

    private Logger logger = LoggerFactory.getLogger(ApiTest.class);

    @Test
    public void test_iterator() {
        GroupStructure groupStructure = new GroupStructure("1", "ethan");
        groupStructure.add(new Employee("2", "花花", "二级部门"));
        groupStructure.add(new Employee("3", "豆包", "二级部门"));
        groupStructure.add(new Employee("4", "蹦蹦", "三级部门"));
        groupStructure.add(new Employee("5", "大烧", "三级部门"));
        groupStructure.add(new Employee("6", "虎哥", "四级部门"));
        groupStructure.add(new Employee("7", "玲姐", "四级部门"));
        groupStructure.add(new Employee("8", "秋雅", "四级部门"));

        //添加节点链接
        groupStructure.addLink("1", new Link("1", "2"));
        groupStructure.addLink("1", new Link("1", "3"));

        groupStructure.addLink("2", new Link("2", "4"));
        groupStructure.addLink("2", new Link("2", "5"));

        groupStructure.addLink("5", new Link("5", "6"));
        groupStructure.addLink("5", new Link("5", "7"));
        groupStructure.addLink("5", new Link("5", "8"));

        Iterator<Employee> iterator = groupStructure.iterator();
        while (iterator.hasNext()) {
            Employee employee = iterator.next();
            logger.info("{}，雇员 Id: {} Name: {}", employee.getDesc(), employee.getuId(), employee.getName());
        }
    }
}

21:50:11.087 [main] INFO  ApiTest - 二级部门，雇员 Id: 2 Name: 花花
21:50:11.089 [main] INFO  ApiTest - 三级部门，雇员 Id: 4 Name: 蹦蹦
21:50:11.089 [main] INFO  ApiTest - 三级部门，雇员 Id: 5 Name: 大烧
21:50:11.089 [main] INFO  ApiTest - 四级部门，雇员 Id: 6 Name: 虎哥
21:50:11.089 [main] INFO  ApiTest - 四级部门，雇员 Id: 7 Name: 玲姐
21:50:11.089 [main] INFO  ApiTest - 四级部门，雇员 Id: 8 Name: 秋雅
21:50:11.089 [main] INFO  ApiTest - 二级部门，雇员 Id: 3 Name: 豆包

参考资料

《重学Java设计模式》

http://c.biancheng.net/view/1395.html

文章推荐： CSS多列等高如何实现?

文章推荐： kubernetes集群命令行工具kubectl

clojure:(应用 fn coll)与(应用 #(应用 fn %&)coll)
我正在通过 labrepl 工作，我看到了一些遵循此模式的代码: ;; Pattern (apply #(apply f %&) coll) ;; Concrete example user=> (a
ios - 在应用商店提交 iPhone 应用，然后决定提交 iPad 应用？
我从未向应用商店提交过应用，但我会在不久的将来提交。到目前为止，我对为 iPhone 而非 iPad 进行设计感到很自在。我了解，通过将通用PAID 应用放到应用商店，客户只需支付一次就可以同时使
iphone - 使用多个 Facebook 应用 ID 的 iOS 应用
我有一个应用程序，它使用不同的 Facebook 应用程序(2 个不同的 AppID)在 Facebook 上发布并显示它是“通过 iPhone”/“通过 iPad”。当 Facebook 应用程序
javascript - 在 IOS 应用 Webview 中运行 Angular 应用
我有一个要求，我们必须通过将网站源文件保存在本地 iOS 应用程序中来在 iOS 应用程序 Webview 中运行网站。 Angular 需要服务器来运行应用程序，但由于我们将文件保存在本地，我们无法
facebook-graph-api - 应用 > OAuth2 服务器 > Facebook > OAuth2 服务器 > 应用
所以我有一个单页客户端应用程序。正常流程: 应用程序 -> OAuth2 服务器 -> 应用程序我们有自己的 OAuth2 服务器，因此人们可以登录应用程序并获取与用户实体关联的 access_t
Android 应用 A 想要跟踪 Android 应用 B 安装的 Google Play 推荐数据
假设我有一个安装在用户设备上的 Android 应用程序 A，我的应用程序有一个 AppWidget，我们可以让其他 Android 开发人员在其中以每次安装成本为基础发布他们的应用程序推广广告。因此
JavaScript 应用
Secrets of the JavaScript Ninja中有一个例子它提供了以下代码来绕过 JavaScript 的 Math.min() 函数，该函数需要一个可变长度列表。 Example:
JavaScript 应用()
当我分别将数组和对象传递给 function.apply() 时，我得到 NaN 的 o/p，但是当我传递对象和数组时，我得到一个数字。为什么会发生这种情况？由于数组也被视为对象，为什么我无法使用它
ASP转换格林威治时间函数DateDiff()应用
CFSDN坚持开源创造价值，我们致力于搭建一个资源共享平台，让每一个IT人在这里找到属于你的精彩世界. 这篇CFSDN的博客文章ASP转换格林威治时间函数DateDiff()应用由作者收集整理，如果你
应用 map 后保留列表名称
我正在将列表传递给 map并且想要返回一个带有合并名称的 data.frame 对象。例如: library(tidyverse) library(broom) mtcars %>% spl
r - 计算每行的每周返回 - 应用
我有一个非常基本的问题，但我不知道如何实现它:我有一个返回数据框，其中每个工具的返回值是按行排列的: tmp<-as.data.frame(t(data.frame(a=rnorm(250,0,1)
创建第二个群组的 Facebook 应用
我正在使用我的 FB 应用创建群组并邀请用户加入我的应用群组，第一次一切正常。当我尝试创建另一个组时，出现以下错误: {"(OAuthException - #4009) (#4009) 在有更多用户
适用于特定设备的 iOS 应用
我们正在开发一款类似于“会说话的本”应用程序的 child 应用程序。它包含大量用于交互式动画的 JPEG 图像序列。问题是动画在 iPad Air 上播放正常，但在 iPad 2 上播放缓慢或滞后
clojure - 应用 Clojure
我关注 clojure 一段时间了，它的一些功能非常令人兴奋(持久数据结构、函数式方法、不可变状态)。然而，由于我仍在学习，我想了解如何在实际场景中应用，证明其好处，然后演化并应用于更复杂的问题。即，
非英语版本的 iOS 应用
我开发了一个仅使用挪威语的应用程序。该应用程序不使用本地化，因为它应该仅以一种语言(挪威语)显示。但是，我已在 Info.plist 文件中将“本地化 native 开发区域”设置为“no”。我还使用
haskell - 应用 <* 的一元等价物
读完 Anthony's response 后上a style-related parser question ，我试图说服自己编写单体解析器仍然可以相当紧凑。所以而不是 reference ::
r - 多核::应用？
multicore 库中是否有类似 sapply 的东西？还是我必须 unlist(mclapply(..)) 才能实现这一点？如果它不存在:推理是什么？提前致谢，如果这是一个愚蠢的问题，我们深表
r - 如何使用函数查看文件中的结果并*应用？
我喜欢在窗口中弹出结果，以便更容易查看和查找(例如，它们不会随着控制台继续滚动而丢失)。一种方法是使用 sink() 和 file.show()。例如: y <- rnorm(100); x <- r
应用@valid之前的spring mvc进程对象
我有一个如下所示的 spring mvc Controller @RequestMapping(value="/new", method=RequestMethod.POST) public Stri
c# - 应用 Bootstrap
我正在阅读 StructureMap关于依赖注入(inject)，首先有两部分初始化映射，具体类类型的接口(interface)，另一部分只是实例化(请求实例)。第一部分需要配置和设置，这是在 Bo

知者

个人简介

我是一名优秀的程序员,十分优秀！

作者热门文章

滴滴打车优惠券免费领取

全站热门文章

首页

博学

6Ren·AI

商城