什麼樣的程式碼該警惕?我的答案是:超過兩個 else 的 if,或超過兩個 case 的 switch。或許有人覺得,大量使用 if else 和 switch case 是家常便飯,哪有那麼嚴重?但絕大多數分支超過兩個的條件判斷,都不該以硬編碼的形式出現。
首先要探討的是:為什麼遺留程式碼裡常有那麼多複雜分支?這些分支在初版往往並不存在。如果設計者稍有經驗,應該能預見未來可能擴充的地方,並預留抽象介面。
但程式碼經過多個版本迭代、尤其是無數次需求細節調整後,複雜分支就冒出來了。需求細節的調整往往不會反映到 UML 上,而是直接反映在程式碼裡。舉例來說,原本訊息分為聊天訊息和系統訊息兩類,設計時自然做成訊息類的兩個子類。但某天需求調整:系統訊息裡有一部分是重要的,標題要顯示為紅色。這時工程師往往會這樣改:
在系統消息類上加一個 important 屬性;在 render 方法裡加入一個關於 important 的分支,用來控制標題顏色。
為什麼會這樣改?可能是他沒意識到應該抽象。需求說的是「系統消息裡面有一部分是重要的」,對熟悉命令式語言的工程師而言,直覺會想到用標誌位區分重要與否,而沒想到這其實可以解讀為「系統消息分為重要和不重要兩類」。換個角度想,就知道該對系統消息進行抽象了。
當然,也可能是工程師知道可以抽象,卻基於某些原因選擇不這麼做。最常見的情況就是有人在趕進度,逼工程師犧牲程式碼品質——加一個屬性和分支,遠比抽象重構快得多。要做十個這種修改,是做十個分支快,還是做十個抽象快?差別顯而易見。
if else 一多,就有人提議改寫成 switch case。某些情況確實能提升可讀性(前提是每個分支互斥),但當 case 數量也多起來,程式碼同樣會變得難讀。
從百度 Hi 網頁版的老程式碼擷取一段來說明:
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!"
}
}
不難得出:命中「render chat message」。但你是怎麼判斷的?你得先確認它命中 case "ok",再看它命中 case "message",接著排除 if 與 else if 的條件,最後才落到 else。
問題就在這裡:為什麼你不能看著這個 else 就直接說出答案?因為 else 本身不含任何條件,它只「隱含」條件!每個 else 的條件,都是對它之前所有 if 和 else if 進行「先非後與」運算的結果。也就是說,判斷命中這個 else,等同於判斷命中這麼一長串複雜條件:
!(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")
去掉重複邏輯後可簡化為:
json.result == "ok" && json.command == "message" && !(json.content.from == "" && json.content.content == "kicked") && !(json.content.type == "sysmsg")
我們花了多大力氣,才從區區 else 四個字母推導出這麼一長串邏輯運算式?更別說不仔細看還真看不懂。這正是複雜分支難以閱讀與管理之處:每個分支的條件,都隱含了它所有前置分支與祖先分支的「先非後與」結果。
首先,複雜的邏輯運算本身無法避免。重構的結果應該是等價邏輯,我們能做的,是讓程式碼更易讀、易管理。
做法一,抽象為類或工廠。對習慣物件導向設計的人而言,這意味著把複雜邏輯打散、分布到不同的類裡:
switch (json.result) {
case "ok":
var factory = commandFactories.getFactory(json.command);
var command = factory.buildCommand(json);
command.execute();
break;
這樣分支變短了,程式碼也更好讀。這個 switch case 只管狀態碼分支,「ok」狀態碼具體怎麼處理,交給其他類負責。getFactory 內部可能有一組分支,專注於選擇哪個工廠;buildCommand 又有另一些瑣碎分支,決定如何構建指令。好處是分支之間的嵌套關係解除了,每個分支只要在自己的上下文中保持正確即可。
做法二,抽象為模式匹配:
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 */ });
這樣是不是清晰多了?第一種是被踢下線,須匹配指定的 from 與 content;第二種是顯示系統消息,因兩個版本協議略有不同,要捕捉兩種 JSON,命中任一即可;第三種是顯示聊天消息,為相容舊協議,需排除踢下線與系統消息兩種情況,於是使用 "$ne"(not equal)後綴。
由於 listen 是上下文無關的,每個 listen 都獨立聲明要匹配什麼,不存在任何隱含邏輯。要捕捉聊天消息,就必須顯式排除 from == "" 與 type == "sysmsg",而不必依賴上下文的 if else 推斷。使用模式匹配,能大幅提升程式碼的可讀性與可維護性,因為我們用 JSON 直接描述每個分支要捕捉什麼,遠比一長串邏輯運算清晰,而且每處修改彼此獨立、互不干擾。