作者：小傅哥
部落格：https://bugstack.cn - 原創系列專題文章
沉澱、分享、成長，讓自己和他人都能有所收穫！?
一、前言
相信相信的力量！
從懵懂的少年，到拿起鍵盤，可以寫一個HelloWorld。多數人在這並不會感覺有多難，也不會認為做不出來。因為這樣的例子，有老師的指導、有書本的例子、有前人的經驗。但隨著你的開發時間越來越長，要解決更復雜的問題或者技術創新，因此在網上搜了幾天幾夜都沒有答案，這個時候是否想過放棄，還是一直堅持不斷的嘗試一點點完成自己心裡要的結果。往往這種沒有前車之鑑需要自己解決問題的時候，可能真的會折磨到要崩潰，但你要願意執著、願意倔強，願意選擇相信相信的力量，就一定能解決。哪怕解決不了，也可以在這條路上摸索出其他更多的收穫，為後續前進的道路填充好墊腳石。
時間緊是寫垃圾程式碼的理由？
擰螺絲？Ctrl+C、Ctrl+V？貼膏藥一樣寫程式碼？沒有辦法，沒有時間，往往真的是藉口，胸中沒用筆墨，才只能湊合。難道一定是好好寫程式碼就浪費時間，拼湊CRUD就快嗎，根本不可能的。因為不會，沒用實操過，很少架構出全場景的設計，才很難寫出優良的程式碼。多增強自身的編碼(武術)修為，在各種編碼場景中讓自己變得老練，才好應對緊急情況下的需求開發和人員安排。就像韓信一樣有謀有略，才能執掌百萬雄兵。
不要只是做個工具人！
因為日常的編寫簡單業務需求，導致自己像個工具人一樣，日久天長的也就很少去深入學習更多技術棧。看見有工具、有元件、有框架，拿來就用用，反正沒什麼體量也不會出什麼問題。但如果你想要更多的收入，哪怕是重複的造輪子，你也要去嘗試造一個，就算不用到生產，自己玩玩總可以吧。有些事情只有自己經歷過，才能有最深的感觸，參與過實踐過，才好總結點評學習。
二、開發環境
- JDK 1.8
- Idea + Maven
- 涉及工程一個，可以通過關注公眾號：
bugstack蟲洞棧，回覆原始碼下載獲取(開啟獲取的連結，找到序號18)
| 工程 | 描述 |
|---|---|
| itstack-demo-design-15-00 | 開發樹形組織架構關係迭代器 |
三、迭代器模式介紹
迭代器模式，常見的就是我們日常使用的iterator遍歷。雖然這個設計模式在我們的實際業務開發中的場景並不多，但卻幾乎每天都要使用jdk為我們提供的list集合遍歷。另外增強的for迴圈雖然是迴圈輸出資料，但是他不是迭代器模式。迭代器模式的特點是實現Iterable介面，通過next的方式獲取集合元素，同時具備對元素的刪除等操作。而增強的for迴圈是不可以的。
這種設計模式的優點是可以讓我們以相同的方式，遍歷不同的資料結構元素，這些資料結構包括；陣列、連結串列、樹等，而使用者在使用遍歷的時候並不需要去關心每一種資料結構的遍歷處理邏輯，從讓使用變得統一易用。
四、案例場景模擬
在本案例中我們模擬迭代遍歷輸出公司中樹形結構的組織架構關係中僱員列表
大部分公司的組織架構都是金字塔結構，也就這種樹形結構，分為一級、二級、三級等部門，每個組織部門由僱員填充，最終體現出一個整體的樹形組織架構關係。
一般我們常用的遍歷就是jdk預設提供的方法，對list集合遍歷。但是對於這樣的偏業務特性較大的樹形結構，如果需要使用到遍歷，那麼就可以自己來實現。接下來我們會把這個組織層次關係通過樹形資料結構來實現，並完成迭代器功能。
五、迭代器模式遍歷組織結構
在實現迭代器模式之前可以先閱讀下java中list方法關於iterator的實現部分，幾乎所有的迭代器開發都會按照這個模式來實現，這個模式主要分為以下幾塊；
- Collection，集合方法部分用於對自定義的資料結構新增通用方法；
add、remove、iterator等核心方法。 - Iterable，提供獲取迭代器，這個介面類會被
Collection繼承。 - Iterator，提供了兩個方法的定義；
hasNext、next，會在具體的資料結構中寫實現方式。
除了這樣通用的迭代器實現方式外，我們的組織關係結構樹，是由節點和節點間的關係鏈構成，所以會比上述的內容多一些入參。
1. 工程結構
itstack-demo-design-15-02
└── src
├── main
│ └── java
│ └── org.itstack.demo.design
│ ├── group
│ │ ├── Employee.java
│ │ ├── GroupStructure.java
│ │ └── Link.java
│ └── lang
│ ├── Collection.java
│ ├── Iterable.java
│ └── Iterator.java
└── test
└── java
└── org.itstack.demo.design.test
└── ApiTest.java迭代器模式模型結構
- 以上是我們工程類圖的模型結構，左側是對迭代器的定義，右側是在資料結構中實現迭代器功能。
- 關於左側部分的實現與jdk中的方式是一樣的，所以在學習的過程中可以互相參考，也可以自己擴充套件學習。
- 另外這個遍歷方式一個樹形結構的深度遍歷，為了可以更加讓學習的小夥伴容易理解，這裡我實現了一種比較簡單的樹形結構深度遍歷方式。後續讀者也可以把遍歷擴充套件為橫向遍歷也就是寬度遍歷。
2. 程式碼實現
2.1 僱員實體類
/**
* 僱員
*/
public class Employee {
private String uId; // ID
private String name; // 姓名
private String desc; // 備註
// ...get/set
}- 這是一個簡單的僱員類，也就是公司員工的資訊類，包括必要的資訊；id、姓名、備註。
2.2 樹節點鏈路
/**
* 樹節點鏈路
*/
public class Link {
private String fromId; // 僱員ID
private String toId; // 僱員ID
// ...get/set
}- 這個類用於描述結構樹中的各個節點之間的關係鏈，也就是
A to B、B to C、B to D，以此描述出一套完整的樹組織結構。
2.3 迭代器定義
public interface Iterator<E> {
boolean hasNext();
E next();
}- 這裡的這個類和
java的jdk中提供的是一樣的，這樣也方面後續讀者可以對照list的Iterator進行原始碼學習。 - 方法描述；
hasNext，判斷是否有下一個元素、next，獲取下一個元素。這個在list的遍歷中是經常用到的。
2.4 可迭代介面定義
public interface Iterable<E> {
Iterator<E> iterator();
}- 這個介面中提供了上面迭代器的實現
Iterator的獲取，也就是後續在自己的資料結構中需要實現迭代器的功能並交給Iterable，由此讓外部呼叫方進行獲取使用。
2.5 集合功能介面定義
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);
Iterator<E> iterator();
}- 這裡我們定義集合操作介面；
Collection，同時繼承了另外一個介面Iterable的方法iterator()。這樣後續誰來實現這個介面，就需要實現上述定義的一些基本功能；新增元素、刪除元素、遍歷。 - 同時你可能注意到這裡定義了兩個泛型
<E, L>，因為我們的資料結構一個是用於新增元素，另外一個是用於新增樹節點的鏈路關係。
2.6 (核心)迭代器功能實現
public class GroupStructure implements Collection<Employee, Link> {
private String groupId; // 組織ID，也是一個組織鏈的頭部ID
private String groupName; // 組織名稱
private Map<String, Employee> employeeMap = new ConcurrentHashMap<String, Employee>(); // 僱員列表
private Map<String, List<Link>> linkMap = new ConcurrentHashMap<String, List<Link>>(); // 組織架構關係；id->list
private Map<String, String> invertedMap = new ConcurrentHashMap<String, String>(); // 反向關係鏈
public GroupStructure(String groupId, String groupName) {
this.groupId = groupId;
this.groupName = groupName;
}
public boolean add(Employee employee) {
return null != employeeMap.put(employee.getuId(), employee);
}
public boolean remove(Employee o) {
return null != employeeMap.remove(o.getuId());
}
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<Link>();
links.add(link);
linkMap.put(key, links);
return true;
}
}
public boolean removeLink(String key) {
return null != linkMap.remove(key);
}
public Iterator<Employee> iterator() {
return new Iterator<Employee>() {
HashMap<String, Integer> keyMap = new HashMap<String, Integer>();
int totalIdx = 0;
private String fromId = groupId; // 僱員ID，From
private String toId = groupId; // 僱員ID，To
public boolean hasNext() {
return totalIdx < employeeMap.size();
}
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;
}
};
}
}- 以上的這部分程式碼稍微有點長，主要包括了對元素的新增和刪除。另外最重要的是對遍歷的實現
new Iterator<Employee>。 - 新增和刪除元素相對來說比較簡單，使用了兩個map陣列結構進行定義；
僱員列表、組織架構關係；id->list。當元素新增元素的時候，會分別在不同的方法中向map結構中進行填充指向關係(A->B)，也就構建出了我們的樹形組織關係。
迭代器實現思路
- 這裡的樹形結構我們需要做的是深度遍歷，也就是左側的一直遍歷到最深節點。
- 當遍歷到最深節點後，開始遍歷最深節點的橫向節點。
- 當橫向節點遍歷完成後則向上尋找橫向節點，直至樹結構全部遍歷完成。
3. 測試驗證
3.1 編寫測試類
@Test
public void test_iterator() {
// 資料填充
GroupStructure groupStructure = new GroupStructure("1", "小傅哥");
// 僱員資訊
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", "秋雅", "四級部門"));
// 節點關係 1->(1,2) 2->(4,5)
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());
}
}3.2 測試結果
22:23:37.166 [main] INFO org.itstack.demo.design.test.ApiTest - 二級部門，僱員 Id：2 Name：花花
22:23:37.168 [main] INFO org.itstack.demo.design.test.ApiTest - 三級部門，僱員 Id：4 Name：蹦蹦
22:23:37.169 [main] INFO org.itstack.demo.design.test.ApiTest - 三級部門，僱員 Id：5 Name：大燒
22:23:37.169 [main] INFO org.itstack.demo.design.test.ApiTest - 四級部門，僱員 Id：6 Name：虎哥
22:23:37.169 [main] INFO org.itstack.demo.design.test.ApiTest - 四級部門，僱員 Id：7 Name：玲姐
22:23:37.169 [main] INFO org.itstack.demo.design.test.ApiTest - 四級部門，僱員 Id：8 Name：秋雅
22:23:37.169 [main] INFO org.itstack.demo.design.test.ApiTest - 二級部門，僱員 Id：3 Name：豆包
Process finished with exit code 0- 從遍歷的結果可以看到，我們是順著樹形結構的深度開始遍歷，一直到右側的節點3；
僱員 Id：2、僱員 Id：4...僱員 Id：3
六、總結
- 迭代器的設計模式從以上的功能實現可以看到，滿足了單一職責和開閉原則，外界的呼叫方也不需要知道任何一個不同的資料結構在使用上的遍歷差異。可以非常方便的擴充套件，也讓整個遍歷變得更加乾淨整潔。
- 但從結構的實現上可以看到，迭代器模式的實現過程相對來說是比較負責的，類的實現上也擴增了需要外部定義的類，使得遍歷與原資料結構分開。雖然這是比較麻煩的，但可以看到在使用java的jdk時候，迭代器的模式還是很好用的，可以非常方便擴充套件和升級。
- 以上的設計模式場景實現過程可能對新人有一些不好理解點，包括；迭代器三個和介面的定義、樹形結構的資料關係、樹結構深度遍歷思路。這些都需要反覆實現練習才能深入的理解，事必躬親，親歷親為，才能讓自己掌握這些知識。