[[387241]]

本文轉(zhuǎn)載自微信公眾號(hào)「跨界架構(gòu)師」，作者Zachary。轉(zhuǎn)載本文請(qǐng)聯(lián)系跨界架構(gòu)師公眾號(hào)。

大家好，我是Z哥。

我相信每一位程序員最怕遇到代碼質(zhì)量堪憂的項(xiàng)目，畢竟增加一個(gè)同樣的功能，在一個(gè)代碼整潔、清晰的項(xiàng)目里與在一個(gè)代碼混亂不堪的項(xiàng)目里，效率和質(zhì)量上的差距達(dá)到一個(gè)數(shù)量級(jí)一點(diǎn)也不奇怪。

但是殘酷的現(xiàn)實(shí)是，“垃圾項(xiàng)目”到處存在，哪怕是大廠里也不例外。畢竟，沒(méi)有人天生就能寫(xiě)出無(wú)比優(yōu)雅的代碼，都是通過(guò)寫(xiě)“垃圾代碼”一步一步成長(zhǎng)起來(lái)的，唯一的區(qū)別可能就是成長(zhǎng)的速度不同罷了。

一個(gè)項(xiàng)目如果運(yùn)氣好，未來(lái)成為受重視的項(xiàng)目，那么它還有機(jī)會(huì)擺脫不少的“垃圾代碼”，但是如果沒(méi)那么好運(yùn)，那就苦了后來(lái)人了。

所以，如果你是一位新人程序員，那么我得提醒你，一定要有一個(gè)合理的預(yù)期，這個(gè)合理的預(yù)期就是——與垃圾代碼長(zhǎng)期為伴。因此，如果你以后因?yàn)橛龅?ldquo;垃圾代碼”而破口大罵，這是不講“碼德”的。什么?那么索性跳槽?你怎么能確保下一個(gè)接手的項(xiàng)目會(huì)更好?

在Z哥看來(lái)，一個(gè)項(xiàng)目走向“垃圾”、人見(jiàn)人棄的地步，原因只有一個(gè)，代碼垃圾，而什么樣的代碼才算垃圾代碼?這就多了，我與你分享一些常見(jiàn)的。

01 組件顆粒度過(guò)大

現(xiàn)在三層架構(gòu)基本已經(jīng)成為一個(gè)基礎(chǔ)共識(shí)了，只要不是太古老的項(xiàng)目，不太會(huì)存在UI、業(yè)務(wù)邏輯、數(shù)據(jù)操作寫(xiě)在一起的情況。(雖然架構(gòu)設(shè)計(jì)方面的后起之秀很多，但是三層架構(gòu)因?yàn)楦菀桌斫猓允袌?chǎng)占有率依舊最高)

但是三層架構(gòu)的每一層又該如何進(jìn)一步細(xì)分，如何建模?還沒(méi)有能夠成為共識(shí)的統(tǒng)一標(biāo)準(zhǔn)或者最佳實(shí)踐出來(lái)。

所以，很多項(xiàng)目在經(jīng)歷了一年以上的業(yè)務(wù)發(fā)展和變更后，業(yè)務(wù)邏輯層往往率先淪陷，開(kāi)始出現(xiàn)大對(duì)象，成為開(kāi)發(fā)效率的瓶頸。

近幾年的火熱的領(lǐng)域驅(qū)動(dòng)設(shè)計(jì)其實(shí)已經(jīng)開(kāi)始深入到每一層的內(nèi)部該如何劃分上了。但是離達(dá)到共識(shí)還有很長(zhǎng)的路要走。

02 API數(shù)量泛濫

有一些經(jīng)驗(yàn)的程序員們會(huì)用一招來(lái)讓自己在垃圾代碼中游走自如。這招就是盡量通過(guò)“增加”的方式實(shí)現(xiàn)功能而不是“修改”歷史代碼。

這種方式的確能避開(kāi)很多“屎坑”，但是從長(zhǎng)期來(lái)看，這大概率是在創(chuàng)造新的“屎坑”。

某些核心class里幾百個(gè)function，成千上萬(wàn)行的代碼就是這么來(lái)的。

03 低內(nèi)聚、高耦合

「高內(nèi)聚、低耦合」是軟件開(kāi)發(fā)領(lǐng)域的一條黃金法則，相信每一位程序員都知道。但是現(xiàn)實(shí)是，很多項(xiàng)目都存在低內(nèi)聚、高耦合的問(wèn)題。

出現(xiàn)這個(gè)問(wèn)題倒也不是說(shuō)是由于大量的重復(fù)代碼導(dǎo)致，而是過(guò)度的追求消除重復(fù)代碼。盲目的追求減少重復(fù)代碼，自然會(huì)導(dǎo)致代碼被過(guò)度拆分，原本一個(gè)完整的業(yè)務(wù)處理清清楚楚，硬生生被拆分到多個(gè)function里去。

復(fù)用當(dāng)然是好的，但應(yīng)該有個(gè)前提條件：不增加系統(tǒng)復(fù)雜度的情況下的復(fù)用。如果不這樣做，損害了穩(wěn)定性，增加了復(fù)雜性，還會(huì)造成代碼可讀性降低。

04 業(yè)務(wù)邏輯和程序處理邏輯糾纏

Z哥認(rèn)為，代碼的作用其實(shí)就分為兩種，業(yè)務(wù)邏輯和程序處理邏輯。前者體現(xiàn)的是這個(gè)軟件的現(xiàn)實(shí)價(jià)值，后者則是讓軟件能在計(jì)算機(jī)上run起來(lái)必不可少的部分。

程序處理邏輯主要就是各種數(shù)據(jù)的存取、dao操作、序列化/反序列化、緩存操作，以及異常處理、參數(shù)和返回值準(zhǔn)備等等。

如果程序的處理邏輯與業(yè)務(wù)邏輯混在一起，就好比芝士拌飯，都黏在一起，隨便改一小點(diǎn)功能就扯出一大段代碼要看。

更加可怕的是，如果里面還充斥著大量Magic Number，比如if (errCode == 50001) 。那你得忍住不要罵人。

05 又長(zhǎng)又寬的if else

這點(diǎn)其實(shí)長(zhǎng)期以來(lái)就是一直被人詬病的陋習(xí)。但是這又幾乎是每一門(mén)編程語(yǔ)言都有的語(yǔ)法，那么問(wèn)題到底在哪里?

因?yàn)椴还苁莍f else也好，還是switch case也好，其實(shí)是一種硬編碼的方式。這就會(huì)導(dǎo)致它不容易被修改。

想象一個(gè)場(chǎng)景：某個(gè)枚舉增加了一個(gè)新的值，這個(gè)時(shí)候你需要將原先判斷這個(gè)枚舉的所有if else都檢查一遍，以確保新增的業(yè)務(wù)能正確執(zhí)行。真正做過(guò)這件事的人相信有過(guò)深刻地感受，如果這個(gè)枚舉被用到幾十上百的地方，檢查一遍外加弄懂上下文，估計(jì)至少半天時(shí)間就沒(méi)了，而且很有可能最終還是漏改或者改錯(cuò)什么。

以上就是一些常見(jiàn)的垃圾代碼的樣子。那么，在你的工作中如果遇到充滿垃圾代碼的垃圾項(xiàng)目該怎么辦呢?從流派上說(shuō)，主要有三大流派，激進(jìn)派、保守派、重頭再來(lái)派。

保守派的做法，主要是從局部修改問(wèn)題代碼入手。比如前面提到的這些“垃圾”代碼，常見(jiàn)的處理思路是以下這些。

01 業(yè)務(wù)層禁止層內(nèi)依賴

你可以留意觀察一下，業(yè)務(wù)層內(nèi)的內(nèi)部相互依賴，是導(dǎo)致代碼高耦合低內(nèi)聚的主要推手。因?yàn)檫@會(huì)導(dǎo)致一個(gè)業(yè)務(wù)方法體內(nèi)部經(jīng)常容易囊括一些不在當(dāng)前業(yè)務(wù)邏輯內(nèi)的分支邏輯，使得每個(gè)方法的耦合逐漸提高。

所以，禁止層內(nèi)依賴對(duì)降低耦合有立竿見(jiàn)影的效果，這也是領(lǐng)域驅(qū)動(dòng)設(shè)計(jì)提倡專(zhuān)門(mén)拉出一個(gè)Application Layer來(lái)協(xié)調(diào)各個(gè)Domain之間的交互的目的。

02 將大函數(shù)拆小

讓代碼恢復(fù)健康，最難啃的骨頭就是那些動(dòng)輒幾百上千行的函數(shù)。保守派雖然避免了大量應(yīng)用新框架進(jìn)行替換所帶來(lái)的工作量。但是這個(gè)最難啃的骨頭是避不開(kāi)的坎，否則所謂的代碼重構(gòu)只是隔靴搔癢而已，并沒(méi)有多大效果。

03 減少代碼

減少代碼最高效的方式是調(diào)用新的系統(tǒng)api或者使用新的框架或者工具。他們可以大批量的代替原先冗余的「程序處理邏輯」。只是對(duì)保守派來(lái)說(shuō)，他們會(huì)更謹(jǐn)慎地使用新的框架。畢竟，運(yùn)用一個(gè)新框架可是一個(gè)不小的手術(shù)。

激進(jìn)派與保守派最大的區(qū)別在于，他們更傾向于使用新的框架、工具甚至是新的技術(shù)棧、編程語(yǔ)言來(lái)解決問(wèn)題。不過(guò)在我看來(lái)，這些新東西，可能在短期的確能解決眼前的問(wèn)題，但是這些問(wèn)題到底是新技術(shù)解決的?還是因?yàn)槭褂眯录夹g(shù)而大量重寫(xiě)“新鮮”的代碼解決的?值得打上一個(gè)問(wèn)號(hào)。

最后的重頭再來(lái)派很有意思。他們認(rèn)為老項(xiàng)目已經(jīng)沒(méi)救了，必須重做才行，這是比激進(jìn)派更激進(jìn)的一個(gè)流派。

可是我見(jiàn)過(guò)好多重頭再來(lái)派的人員，重頭再來(lái)做出的項(xiàng)目，在其他人眼里可能并沒(méi)有比之前好多少，甚至在過(guò)了一段時(shí)間之后，發(fā)現(xiàn)重新陷入了之前的困境之中。

因?yàn)槊つ繕?lè)觀是我們?nèi)诵缘娜觞c(diǎn)。這就像創(chuàng)業(yè)者總覺(jué)得自己是九死一生中唯一生的那個(gè)，買(mǎi)彩票的人總覺(jué)得自己是那個(gè)千萬(wàn)分之一的幸運(yùn)兒一樣。

這三個(gè)流派，并沒(méi)有絕對(duì)的好壞之分，不同的流派都有不同的適用場(chǎng)景，區(qū)別就在于「時(shí)間、成本、質(zhì)量」這三個(gè)要素上的取舍不同。所以，我們?cè)谶x擇方案的時(shí)候可以根據(jù)這三個(gè)要素的具體情況來(lái)判斷。

因?yàn)閆哥認(rèn)為一個(gè)項(xiàng)目的核心要素就是這三者，并且這三者無(wú)法兼得，最多只能取其二，類(lèi)似于分布式系統(tǒng)領(lǐng)域的CAP定理。

Z哥有幸分別參與和主導(dǎo)過(guò)這三個(gè)流派的工作，以我的經(jīng)驗(yàn)來(lái)看，我認(rèn)為這三個(gè)流派分別適用的項(xiàng)目情況如下：

• 保守派。時(shí)間快，成本低，對(duì)質(zhì)量?jī)H有最基本的要求。
• 激進(jìn)派。有較高的質(zhì)量要求，滿足時(shí)間較寬裕或者接受成本大幅增加其中的一點(diǎn)。
• 推倒重來(lái)派。時(shí)間和成本完全給質(zhì)量讓步，追求可見(jiàn)范圍內(nèi)的最好。

其實(shí)這么一分析你也能發(fā)現(xiàn)，總是推倒重來(lái)是不現(xiàn)實(shí)的，時(shí)間和成本這種屬于資源，資源總是有限的。所以，大多數(shù)情況下，保守派的選擇才是最常見(jiàn)的。因此我們更應(yīng)該思考的是如何通過(guò)保守改造最大化提高項(xiàng)目的質(zhì)量，讓他擺脫“垃圾”的標(biāo)簽。這需要我們沉下心來(lái)才能完成，不要老想著推翻重做。

好了，總結(jié)一下。

這篇呢，Z哥和你分享了我對(duì)如何應(yīng)對(duì)“垃圾項(xiàng)目”的看法。

首先和你分析了5個(gè)常見(jiàn)的使得項(xiàng)目逐漸變得垃圾的陋習(xí)。

1. 組件顆粒度過(guò)大
2. API數(shù)量泛濫
3. 低內(nèi)聚高耦合
4. 業(yè)務(wù)邏輯和程序處理邏輯糾纏
5. 又長(zhǎng)又寬的if else

然后分享了三個(gè)常見(jiàn)的保守派做法：

1. 業(yè)務(wù)層禁止層內(nèi)依賴
2. 將大函數(shù)拆小
3. 減少代碼

最后分享了應(yīng)對(duì)“垃圾項(xiàng)目”時(shí)的三大流派，分別是：

1. 保守派
2. 激進(jìn)派
3. 推倒重來(lái)派

從時(shí)間、成本、質(zhì)量三個(gè)維度的權(quán)衡來(lái)看。保守派才是主流，所以不要?jiǎng)硬粍?dòng)就想著推倒重來(lái)，收起浮躁的心，沉下心來(lái)。

好了，希望對(duì)你有所啟發(fā)。