一、業(yè)務(wù)邏輯與代碼

• 代碼是需求邏輯的一種展現(xiàn)形式：需求文檔是業(yè)務(wù)邏輯的一種展現(xiàn)形式，而代碼不過是業(yè)務(wù)邏輯的另一種表現(xiàn)形式；如果邏輯本身有問題，那么它的各種展示形式自然也是錯(cuò)的，所以寫代碼前應(yīng)該先思考清楚業(yè)務(wù)邏輯。
• Review代碼很多時(shí)候是邏輯問題：在Review代碼經(jīng)驗(yàn)中發(fā)現(xiàn)：混亂的代碼并不僅僅是代碼編寫技藝問題，很多時(shí)候是因?yàn)檫壿嫑]有梳理清楚。邏輯混亂，自然代碼也混亂。梳理清楚業(yè)務(wù)邏輯，就為代碼打下了良好的基礎(chǔ)。當(dāng)然業(yè)務(wù)邏輯梳理清楚后，業(yè)務(wù)邏輯到代碼的映射依然有可能出問題，這是編程技藝要解決的問題。下面通過一個(gè)簡單的例子來演示這個(gè)過程：

二、業(yè)務(wù)需求示例

我們要做一件事情doSomething：

• 第一步先做 A，A 過程要先執(zhí)行 a1, 然后執(zhí)行 a2, 然后執(zhí)行 a3 這三個(gè)子過程。
• 第二步再做 B，B 過程需要執(zhí)行 b1，然后 b2 這兩個(gè)子過程。

這個(gè)示例邏輯的圖形表述如下：是一個(gè)樹，包含樹的根，枝干，和葉子。

例子是有通用性的，現(xiàn)實(shí)世界的任何事情或業(yè)務(wù)都可以用類似的樹形結(jié)構(gòu)來表述。

三、正確的代碼實(shí)現(xiàn)

1. 和邏輯樹映射的代碼樹

正確的代碼結(jié)構(gòu)應(yīng)該是和邏輯映射的，代碼結(jié)構(gòu)如下：

我們真實(shí)寫代碼的時(shí)候，一般并不會直接寫出如上結(jié)構(gòu)，而是會先寫出「3.2 代碼塊 + 注釋」的結(jié)構(gòu)來。

2. 代碼塊 + 合理注釋

如下代碼通過代碼塊來映射邏輯，上面圖中的子方法對應(yīng)代碼中的注釋。

void doSomething(){
    //A
    a1邏輯偽代碼.....;//a1
    a2邏輯偽代碼.....;//a2
    a3邏輯偽代碼.....;//a3

    //B
    b1邏輯偽代碼;//b1
    b2邏輯偽代碼;//b2
}

3. 抽取小方法

可以再上面的基礎(chǔ)上更優(yōu)秀些，對代碼塊進(jìn)行抽取小方法，更符合業(yè)務(wù)描述（更符合業(yè)務(wù)的樹形結(jié)構(gòu)）。推薦閱讀：看看人家 SpringBoot + vue后臺管理系統(tǒng)，多么優(yōu)雅...

void doSomething(){
    doA();
    doB();
}

void doA(){
    a1邏輯偽代碼.....;
    a2邏輯偽代碼.....;
    a3邏輯偽代碼.....;
}
void doB(){
    b1邏輯偽代碼;
    b2邏輯偽代碼;
}

當(dāng)然你也可以繼續(xù)對 a1,a2,a3,b1,b2 等小邏輯映射為小方法，以上提到幾種寫法都是正確的，關(guān)于小方法是否抽取，后續(xù)單獨(dú)在《代碼長度與母語的關(guān)系》中討論。下面我們來看看不正確的寫法。

四、不正確的代碼實(shí)現(xiàn) ===========

當(dāng)你看到下面的不正確的寫法的時(shí)候，你也許會覺得不可思議，真的會寫出這樣的代碼？現(xiàn)實(shí)是：項(xiàng)目中我見到很多更糟糕的代碼，會把下面提到的問題，以及其他編程技藝的問題排列組合出現(xiàn)。

1. 第一種問題：不對等

第一種常見的問題不太嚴(yán)重，只對部分邏輯進(jìn)行了抽取，造成方法中執(zhí)行不對等；比如只對 b() 邏輯進(jìn)行了抽取，但對等的 a（）邏輯并未抽??；

void doSomething(){
   a1邏輯偽代碼.....;
   a2邏輯偽代碼.....;
   a3邏輯偽代碼.....;
   doB();
}

void doB(){
   b1邏輯偽代碼;
   b2邏輯偽代碼;
}

改進(jìn)辦法參考上面第 3 部分正確的寫法，至少可以在doB();之前加空行，并對 a1,a2,a3 加個(gè)注釋，也會易讀很多（當(dāng)然這是一種妥協(xié)寫法）。

void doSomething(){
		//a邏輯
    a1邏輯偽代碼.....;
    a2邏輯偽代碼.....;
    a3邏輯偽代碼.....;
    
    //b邏輯
    doB();
}

void doB(){
    b1邏輯偽代碼;
    b2邏輯偽代碼;
}

2. 第二種問題：部分抽取

第二種是對整體的部分邏輯進(jìn)行了抽取，這種方法很難命名，會給個(gè)詞不達(dá)意的名字，或使用整體的名字，這個(gè)就相對嚴(yán)重了，已經(jīng)影響到了代碼閱讀和理解。

比如電腦是一個(gè)整體，可以命名是電腦；如果只給你一部分（CPU，主板，顯卡）怎么命名讓人能明白？電腦部分零件？但電腦部分零件并不能讓人明白，因?yàn)樗皇且粋€(gè)邏輯主體。CPU 是一個(gè)邏輯主體，封裝了運(yùn)算。

如下圖，只對 a1,a2 進(jìn)行了抽取，然后名字依然稱為 a，看到代碼會很疑惑，a3 明顯也屬于 a。

void doSomething(){
    doA();
    a3邏輯偽代碼.....;
    doB();
}
void doA(){
    a1邏輯偽代碼.....;
    a2邏輯偽代碼.....;
}

void doB(){
    b1邏輯偽代碼;
    b2邏輯偽代碼;
}

3. 第三種問題：抽取錯(cuò)誤

第三種是最嚴(yán)重的問題，抽取錯(cuò)誤，和邏輯不匹配。

如下：把 A 的部分邏輯和 B 的部分邏輯一起抽取。

如果在這個(gè)基礎(chǔ)上再對抽取的部分起個(gè)晦澀的名字（其實(shí)這種抽取也起不到好名字），然后應(yīng)用一些設(shè)計(jì)模式來把代碼更分散（缺點(diǎn)隱藏起來），就成功的完成了只有自己可以看懂的代碼（可能表面看起來還很高大上）。

由此得出結(jié)論，先別想著抽取小方法或應(yīng)用設(shè)計(jì)模式。先能平鋪直敘的寫出符合邏輯的代碼吧。

小方法抽取和設(shè)計(jì)模式不一定能解決問題，也能隱藏問題。

很多難以讀懂的代碼都是受《重構(gòu)》和《設(shè)計(jì)模式》的包裝，質(zhì)量差的代碼不可怕，如果再抽取和包裝，可以想想是多恐怖。

五、補(bǔ)丁和模式思考

(1) 補(bǔ)丁代碼思考，代碼的腐爛

很多人看到這里，會覺得自己絕對不會寫出這么爛的代碼；確實(shí)一開始也許不會，但伴隨新需求，不同人不斷打補(bǔ)?。榱瞬挥绊懢€上，老代碼不讓動），最后就會演進(jìn)未這幾個(gè)問題綜合展現(xiàn)的代碼。閱讀這樣的代碼不看到最底層代碼，根本不知道代碼在做什么，因?yàn)榉椒呀?jīng)不可信。

(2) 不要急于使用設(shè)計(jì)模式，寫好基礎(chǔ)代碼

寫出一個(gè)好的基礎(chǔ)代碼的過程：先梳理清楚邏輯樹（樹形結(jié)構(gòu)，同層對等），然后做到代碼符合邏輯樹（代碼樹自然也符合樹形結(jié)構(gòu)，同層的方法對等）。

打好基礎(chǔ)后，可以再針對基礎(chǔ)代碼的痛點(diǎn)，應(yīng)用復(fù)雜手段（比如設(shè)計(jì)模式）來解決，關(guān)于方法抽取和方法長度，后續(xù)單獨(dú)文章討論。