從if else 到 switch case再到抽象
大家覺得在接手遺留代碼時，見到什么東東是最讓人感到不耐煩的？復(fù)雜無比的 UML ？我覺得不是。我的答案是，超過兩個 else 的if ，或者是超過兩個case的switch 。可是在代碼中大量使用 if else 和 switch case 是很正常的事情吧？錯！絕大多數(shù)分支超過兩個的 if else 和 switch case 都不應(yīng)該以硬編碼（ hard-coded ）的形式出現(xiàn)。
復(fù)雜分支從何而來
首先我們要討論的***個問題是，為什么遺留代碼里面往往有那么多復(fù)雜分支。這些復(fù)雜分支在代碼的***版本中往往是不存在的，假設(shè)做設(shè)計的人還是有點經(jīng)驗的話，他應(yīng)該預(yù)見將來可能需要進行擴展的地方，并且預(yù)留抽象接口。
但是代碼經(jīng)過若干個版本的迭代以后，尤其是經(jīng)過若干次需求細節(jié)的調(diào)整以后，復(fù)雜分支就會出現(xiàn)了。需求的細節(jié)調(diào)整，往往不會反映到 UML 上，而會直接反映到代碼上。例如說，原本消息分為聊天消息和系統(tǒng)消息兩類，設(shè)計的時候自然會把這設(shè)計為消息類的兩個子類。但接著有一天需求發(fā)生細節(jié)調(diào)整了，系統(tǒng)消息里面有一部分是重要的，它們的標題要顯示為紅色，這時候程序員往往會做如下修改：
1.在系統(tǒng)消息類上面加一個 important 屬性
2.在相應(yīng)的 render 方法里面加入一個關(guān)于 important 屬性的分支，用于控制標題顏色
程序員為什么會作出這樣的修改？有可能因為他沒意識到應(yīng)該抽象。因為需求說的是「系統(tǒng)消息里面有一部分是重要的」，對于接受命令式編程語言訓(xùn)練比較多的程序員來說，他或許首先想到的是標志位──一個標志位就可以區(qū)分重要跟不重要。他沒想到這個需求可以用另一種方式來解讀，「系統(tǒng)消息分為重要和不重要兩種類別」。這樣子解讀，他就知道應(yīng)該對系統(tǒng)消息進行抽象了。
當然也有可能，程序員知道可以抽象，但基于某些原因，他選擇了不這樣做。很常見的一種情況就是有人逼著程序員，以犧牲代碼質(zhì)量來換取項目進展速度──加入一個屬性和一個分支，遠比抽象重構(gòu)要簡單得多，如果要做10個這種形式的修改，是做10個分支快還是做10個抽象快？區(qū)別顯而易見。
當然， if else 多了，就有聰明人站出來說「不如我們改成 switch case 」吧。在某些情況下，這確實能夠提升代碼可讀性，假設(shè)每一個分支都是互斥的話。但是當 switch case 的數(shù)量也多起來以后，代碼一樣會變得不可讀。
復(fù)雜分支有何壞處
復(fù)雜分支有什么壞處？讓我從百度 Hi 網(wǎng)頁版的老代碼里面截取一段出來做個例子。
- switch (json.result) {
- case "ok":
- switch (json.command) {
- case "message":
- case "systemmessage":
- if (json.content.from == ""
- && json.content.content == "kicked") {
- /* disconnect */
- } else if (json.command == "systemmessage"
- || json.content.type == "sysmsg") {
- /* render system message */
- } else {
- /* render chat message */
- }
- break;
- }
- break;
這段代碼要看懂不難，因此我提一個簡單問題，以下這個 JSON 命中哪個分支：
- { "result": "ok",
- "command": "message",
- "content": { "from": "CatChen",
- "content": "Hello!" } }
你很容易就能得到正確答案：這個 JSON 命中 /* render chat message */ （顯示聊天消息）這個分支。那么我想了解一下，你是如何作出這個判斷的？首先，你要看它是否命中 case “ok”: 分支，結(jié)果是命中了；然后，你要看它是否命中 case “message”: 分支，結(jié)果也是命中了，所以 case “systemmessage”: 就不用看了；接下來，它不命中 if 里面的條件；并且，它也不命中 else if 里面的條件，所以它命中了 else 這個分支。
看出問題來了嗎？為什么你不能看著這個 else 就說出這個 JSON 命中這個分支？因為 else 本身不包含任何條件，它只隱含條件！每一個 else 的條件，都是對它之前的每一個 if 和 else if 進行先非后與運算的結(jié)果。也就是說，判斷命中這個 else ，相當于判斷命中這樣一組復(fù)雜的條件：
- !(json.content.from == "" && json.content.content == "kicked") &&
- !(json.command == "systemmessage" || json.content.type == "sysmsg")
再套上外層的兩個 switch case ，這個分支的條件就是這樣子的：
- json.result == "ok" &&
- (json.command == "message" ||
- json.command == "systemmessage") &&
- !(json.content.from == "" &&
- json.content.content == "kicked") &&
- !(json.command == "systemmessage" ||
- json.content.type == "sysmsg")
這里面有重復(fù)邏輯，省略后是這樣子的：
- json.result == "ok" &&
- json.command == "message" &&
- !(json.content.from == "" &&
- json.content.content == "kicked") &&
- !(json.content.type == "sysmsg")
我們花了多大力氣才從簡簡單單的 else 這四個字母中推導(dǎo)出這樣一長串邏輯運算表達式來？況且，不仔細看還真的看不懂這個表達式說的是什么。
這就是復(fù)雜分支難以閱讀和管理的地方。想象你面對一個 switch case 套一個 if else ，總共有3個 case ，每個 case 里面有3個 else ，這就夠你研究的了──每一個分支，條件中都隱含著它所有前置分支以及所有祖先分支的前置分支先非后與的結(jié)果。
如何避免復(fù)雜分支
首先，復(fù)雜邏輯運算是不能避免的。重構(gòu)得到的結(jié)果應(yīng)該是等價的邏輯，我們能做的只是讓代碼變得更加容易閱讀和管理。因此，我們的重點應(yīng)該在于如何使得復(fù)雜邏輯運算變得易于閱讀和管理。
抽象為類或者工廠
對于習(xí)慣于做面向?qū)ο笤O(shè)計的人來說，可能這意味著將復(fù)雜邏輯運算打散并分布到不同的類里面：
- switch (json.result)
- {
- case "ok":
- var factory = commandFactories.getFactory(json.command);
- var command = factory.buildCommand(json);
- command.execute();
- break; }
這看起來不錯，至少分支變短了，代碼變得容易閱讀了。這個 switch case 只管狀態(tài)碼分支，對于 “ok” 這個狀態(tài)碼具體怎么處理，那是其他類管的事情。 getFactory 里面可能有一組分支，專注于創(chuàng)建這條指令應(yīng)該選擇哪一個工廠的選擇。同時 buildCommand 可能又有另外一些瑣碎的分支，決定如何構(gòu)建這條指令。
這樣做的好處是，分支之間的嵌套關(guān)系解除了，每一個分支只要在自己的上下文中保持正確就可以了。舉個例子來說， getFactory 現(xiàn)在是一個具名函數(shù)，因此這個函數(shù)內(nèi)的分支只要實現(xiàn) getFactory 這個名字暗示的契約就可以了，無需關(guān)注實際調(diào)用 getFactory 的上下文。
抽象為模式匹配
另外一種做法，就是把這種復(fù)雜邏輯運算轉(zhuǎn)述為模式匹配：
- Network.listen({ "result": "ok",
- "command": "message",
- "content": { "from": "", "content": "kicked" } },
- function(json) { /* disconnect */ });
- Network.listen([{ "result": "ok",
- "command": "message",
- "content": { "type": "sysmsg" } },
- { "result": "ok", "command": "systemmessage" }], function(json) { /* render system message */ });
- Network.listen({ "result": "ok",
- "command": "message",
- "content": { "from$ne": "",
- "type$ne": "sysmsg" } },
- function(json) { /* render chat message */ });
現(xiàn)在這樣子是不是清晰多了？***種情況，是被踢下線，必須匹配指定的 from 和 content 值。第二種情況，是顯示系統(tǒng)消息，由于系統(tǒng)消息在兩個版本的協(xié)議中略有不同，所以我們要捕捉兩種不同的 JSON ，匹配任意一個都算是命中。第三種情況，是顯示聊天消息，由于在老版本協(xié)議中系統(tǒng)消息和踢下線指令都屬于特殊的聊天消息，為了兼容老版本協(xié)議，這兩種情況要從顯示聊天消息中排除出去，所以就使用了 “$ne” （表示 not equal ）這樣的后綴進行匹配。
由于 listen 方法是上下文無關(guān)的，每一個 listen 都獨立聲明自己匹配什么樣的 JSON ，因此不存在任何隱含邏輯。例如說，要捕捉聊天消息，就必須顯式聲明排除 from == “” 以及 type == “sysmsg” 這兩種情況，這不需要由上下文的 if else 推斷得出。
使用模式匹配，可以大大提高代碼的可讀性和可維護性。
由于我們要捕捉的是 JSON ，所以我們就使用 JSON 來描述每一個分支要捕捉什么，這比一個長長的邏輯運算表達式要清晰多了。同時在這個 JSON 上的每一處修改都是獨立的，修改一個條件并不影響其他條件。
【編輯推薦】
