1、看一个具体的需求
编写程序展示一个学校院系结构:需求是这样的,要在一个页面中展示出学校的院系组成,一个学校有多个学院,一个学院有多个系。如下:
---------计算机学院有以下专业----------
Java 工程师
大数据工程师
前端工程师
信息安全
---------信息工程学院有以下专业--------
网路信息安全
电子技术
2、传统方案
2.1 类图
2.2 问题分析
1)将学院看做是学校的子类,系是学院的子类,这样实际上是站在组织大小来进行分层次的
2)实际上我们的要求是:在一个页面中展示出学校的院系组成,一个学校有多个学院,一个学院有多个系,因此这种方案。不能很好实现的遍历的操作
3)解决方案:迭代器模式
3、迭代器模式
3.1 基本介绍
1)迭代器模式(Iterator Pattern)是常用的设计模式,属于行为型模式
2)如果我们的集合元素是用不同的方式实现的,有数组,还有 java 的集合类,或者还有其他方式,当客户端要遍历这些集合元素的时候就要使用多种遍历方式,而且还会暴露元素的内部结构,可以考虑使用迭代器模式解决。
3)迭代器模式,提供一种遍历集合元素的统一接口,用一致的方法遍历集合元素,不需要知道集合对象的底层表示,即:不暴露其内部的结构。
3.2 原理类图
说明:
- Iterator:迭代器接口,是系统提供,含有 hasNext、next、remove
- ConcreteIterator:具体的迭代器类,管理迭代
- Aggregate:一个统一的聚合接口,将客户端和具体聚合解耦
- ConcreteAggregate:具体的聚合,持有对象集合,并提供一个方法,返回一个迭代器,该迭代器可以正确遍历集合
- Client:客户端。通过 Iterator 和 Aggregate 依赖子类。
3.3 应用实例
1)要求
编写程序展示一个学校院系结构:需求是这样,要在一个页面中展示出学校的院系组成,一个学校有多个学院,一个学院有多个系
2)思路分析
3)代码实现
Department 系
package com.wenze.design.iterator;
import lombok.AllArgsConstructor;
import lombok.Getter;
import lombok.Setter;
/**
* 系
*
* @author wenze
* @version 1.0
* @Date 2023-11-06 15:34:33
* @since 1.0
*/
@Setter
@Getter
@AllArgsConstructor
public class Department {
private String name;
private String description;
}
ComputerCollegeIterator 计算机学院迭代器
package com.wenze.design.iterator;
import java.util.Iterator;
/**
* 计算机学院迭代器
*
* @author wenze
* @version 1.0
* @Date 2023-11-06 15:35:15
* @since 1.0
*/
public class ComputerCollegeIterator implements Iterator<Department> {
// 这里我们需要知道 Department 是以怎样的方式存放的 ==> 数组
private final Department[] departments;
int position = 0;
public ComputerCollegeIterator(Department[] departments) {
this.departments = departments;
}
@Override
public boolean hasNext() {
return position < departments.length && departments[position] != null;
}
@Override
public Department next() {
Department department = departments[position];
position += 1;
return department;
}
/**
* 默认空实现
*/
@Override
public void remove() {}
}
InfoCollegeIterator 信息学院迭代器
package com.wenze.design.iterator;
import java.util.Iterator;
import java.util.List;
import java.util.NoSuchElementException;
/**
* 信息学院迭代器
*
* @author wenze
* @version 1.0
* @Date 2023-11-06 15:41:49
* @since 1.0
*/
public class InfoCollegeIterator implements Iterator<Department> {
// 信息工程学院是以 List 的方式存放
private final List<Department> departments;
int index = -1;
public InfoCollegeIterator(List<Department> departments){
this.departments = departments;
}
@Override
public boolean hasNext() {
if (index >= departments.size() - 1) {
return false;
}
index += 1;
return true;
}
@Override
public Department next() {
return departments.get(index);
}
@Override
public void remove() {}
}
College 学院接口
package com.wenze.design.iterator;
import java.util.Iterator;
/**
* 学院接口
*
* @author wenze
* @version 1.0
* @Date 2023-11-06 15:46:36
* @since 1.0
*/
public interface College {
String getName();
void addDepartment(String name, String description);
Iterator createIterator();
}
ComputerCollege 计算机学院
package com.wenze.design.iterator;
import java.util.Iterator;
/**
* 计算机学院
*
* @author wenze
* @version 1.0
* @Date 2023-11-06 16:04:58
* @since 1.0
*/
public class ComputerCollege implements College {
private final Department[] departments;
// 保存当前数组的对象个数
int numberOfDepartment = 0;
public ComputerCollege() {
departments = new Department[5];
addDepartment("Java专业", "Java专业");
addDepartment("PHP专业", "PHP专业");
addDepartment("大数据专业", "大数据专业");
}
@Override
public String getName() {
return "计算机学院";
}
@Override
public void addDepartment(final String name, final String description) {
final Department department = new Department(name, description);
departments[numberOfDepartment] = department;
numberOfDepartment += 1;
}
@Override
public Iterator createIterator() {
return new ComputerCollegeIterator(departments);
}
}
InfoCollege 信息学院
package com.wenze.design.iterator;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;
/**
* 信息学院
*
* @author wenze
* @version 1.0
* @Date 2023-11-06 16:09:20
* @since 1.0
*/
public class InfoCollege implements College {
private final List<Department> departments;
public InfoCollege() {
departments = new ArrayList<>();
addDepartment("信息安全专业", "信息安全专业");
addDepartment("网络安全专业", "网络安全专业");
addDepartment("服务器安全专业", "服务器安全专业");
}
@Override
public String getName() {
return "信息学院";
}
@Override
public void addDepartment(final String name, final String description) {
final Department department = new Department(name, description);
departments.add(department);
}
@Override
public Iterator createIterator() {
return new InfoCollegeIterator(departments);
}
}
OutputImpl 输出实现类
package com.wenze.design.iterator;
import java.util.Iterator;
import java.util.List;
/**
* 输出实现
*
* @author wenze
* @version 1.0
* @Date 2023-11-06 16:11:25
* @since 1.0
*/
public class OutputImpl {
// 学院集合
private final List<College> collegeList;
public OutputImpl(List<College> collegeList) {
this.collegeList = collegeList;
}
public void printCollege() {
final Iterator<College> iterator = collegeList.iterator();
while (iterator.hasNext()) {
final College next = iterator.next();
System.out.println("=======" + next.getName() + "========");
printDepartment(next.createIterator());
}
}
public void printDepartment(Iterator iterator) {
while (iterator.hasNext()) {
Department department = (Department) iterator.next();
System.out.println(department.getName());
}
}
}
Client 客户端
package com.wenze.design.iterator;
import java.util.ArrayList;
import java.util.List;
/**
* 客户端
*
* @author wenze
* @version 1.0
* @Date 2023-11-06 16:15:47
* @since 1.0
*/
public class Client {
public static void main(String[] args) {
// 创建学院
List<College> collegeList = new ArrayList<>();
collegeList.add(new ComputerCollege());
collegeList.add(new InfoCollege());
final OutputImpl output = new OutputImpl(collegeList);
output.printCollege();
}
}
4、迭代器模式在 JDK-ArrayList 集合应用的源码分析
1)JDK 的 ArrayList 集合中就是用了迭代器模式
2)代码分析 + 类图 + 说明
代码分析:
类图:
3)角色分析说明
- 内部类 Itr 充当具体实现迭代器 Iterator 的类,作为 ArrayList 内部类
- List 就是充当了聚合接口,含有一个 iterator() 方法,返回一个迭代器对象
- ArrayList 是实现聚合接口 List 的子诶,实现了 iterator()
- Iterator 接口系统提供
- 迭代器模式解决了不同集合(ArrayList, LinkedList)统一遍历问题
5、迭代器模式的注意事项和细节
5.1 优点
1)提供了一个统一的方法遍历对象,客户不用再考虑聚合的类型,使用一种方法就可以遍历对象了。
2)隐藏了聚合的内部结构,客户端要遍历聚合的时候只能取到迭代器,而不会知道聚合的具体组成
3)提供了一种设计思想,就是一个类应该只有一个引起变化的原因(叫做单一职责原则)。在聚合类中,我们把迭代器分开,就是要把管理对象集合和遍历对象集合的责任分开,这样一来集合改变的话,只影响到聚合对象。而如果遍历方式改变的话,只影响到了迭代器。
4)当要展示一组显示对象,或者遍历一组相同对象时使用,适合使用迭代器模式
5.2 缺点
每个聚合对象都要一个迭代器,会生成多个迭代器不好管理类