你好，我是猿java。

作為一名 Java程序員，如果把代碼比作孩子，代碼質(zhì)量就如同孩子的健康，因此，作為技術(shù)人員，日常工作勢(shì)必堅(jiān)守兩條紅線：

• 保證代碼交付質(zhì)量
• 保證代碼交付時(shí)間

對(duì)于這兩條紅線，其實(shí)不難理解，總結(jié)成一句話：在規(guī)定的時(shí)間內(nèi)交付高質(zhì)量的代碼。

那么，什么是高質(zhì)量的代碼？如何才能寫出高質(zhì)量的代碼？為什么有的程序員工作 5年，寫出來(lái)的代碼質(zhì)量還不如 3年的程序員？今天我們就來(lái)聊一聊。

一、什么是高質(zhì)量代碼

代碼的“好”與“壞”是一個(gè)相對(duì)的描述，因此，高質(zhì)量代碼也是一個(gè)很寬泛的概念，很難給它下一個(gè)精準(zhǔn)的定義，但是，我們可以結(jié)合日常的開(kāi)發(fā)工作經(jīng)驗(yàn)，給出幾個(gè)常見(jiàn)的衡量維度：

1. 可讀性

高質(zhì)量的代碼首先需要具備可讀性，我們編寫的代碼除了需要讓機(jī)器能編譯運(yùn)行之外，更需要讓程序員讀懂，因?yàn)橹挥谐绦騿T讀懂了它，才能更好地修 bug，添加新功能，做后期維護(hù)等等。

可能有小伙伴會(huì)說(shuō)，Spring的源碼很難讀懂，因此它不具備可讀性，這種理解是錯(cuò)誤的，Spring框架是 Java生態(tài)中比較優(yōu)秀的開(kāi)源代碼，讀不懂是因?yàn)椤皟?nèi)功”不夠，本文的可讀性是指代碼命名是否規(guī)范，注釋是否合理，分層是否清晰以及是否具備高內(nèi)聚低耦合等特性。

2. 可維護(hù)性

現(xiàn)實(shí)工作中，很難遇見(jiàn)一次性代碼（開(kāi)發(fā)部署完之后再也不需要迭代），大部分情況都需要在一個(gè)模塊上不斷地迭代新功能和新代碼，因此，高質(zhì)量的代碼必須具備可維護(hù)性。

可維護(hù)性反饋到代碼上，可以通俗地表達(dá)成：bug能修改，老代碼改得動(dòng)，新功能可添加。而這些更改花費(fèi)的代價(jià)就體現(xiàn)了可維護(hù)的難和易，比如：改動(dòng)是否會(huì)增加大量的新 bug，改動(dòng)對(duì)現(xiàn)有的邏輯的破壞性有多大，或者說(shuō)改動(dòng)的時(shí)間是否會(huì)很長(zhǎng)。

3. 可擴(kuò)展性

在代碼設(shè)計(jì) SOLID 中有一個(gè)很重要的原則就是開(kāi)閉原則，要求代碼需要 “對(duì)修改關(guān)閉，對(duì)擴(kuò)展開(kāi)放”，因此，高質(zhì)量的代碼需要具備可擴(kuò)展性。在應(yīng)對(duì)業(yè)務(wù)迭代時(shí)，開(kāi)發(fā)者需要多關(guān)注代碼能否用最小的改動(dòng)來(lái)適配新的功能。

4. 可復(fù)用性

在日常開(kāi)發(fā)中，盡量不重復(fù)造輪子，具體到代碼上，不應(yīng)該出現(xiàn)大量重復(fù)的代碼，代碼應(yīng)該保持簡(jiǎn)潔，重復(fù)的代碼可以抽離出來(lái)，實(shí)現(xiàn)代碼復(fù)用。因此，可復(fù)用性也是衡量高質(zhì)量代碼的一個(gè)重要標(biāo)準(zhǔn)。

5. 可測(cè)試性

單測(cè)是開(kāi)發(fā)人員保證代碼質(zhì)量的一個(gè)重要方法，因此，編寫的代碼是否具備可測(cè)試性，也是衡量代碼高質(zhì)量的一個(gè)標(biāo)準(zhǔn)。如果編寫的代碼很難寫單元測(cè)試，那是否意味著代碼設(shè)計(jì)存在很大的問(wèn)題？

在分析了高質(zhì)量代碼的幾個(gè)常用衡量維度之后，我們可以總結(jié)：所謂高質(zhì)量的代碼，其實(shí)就是衡量能否寫出可讀性好，易維護(hù)，易擴(kuò)展，復(fù)用性高，可測(cè)試的代碼。

接下來(lái)提供十種高效提升代碼質(zhì)量的方法。

二、提升代碼質(zhì)量方法

1. 規(guī)范命名

眾所周知，一個(gè)好的名字可以使人受用一生，對(duì)于代碼也是如此，好的命名可以幫助讀者更好地理解代碼的功能。

對(duì)于計(jì)算機(jī)科班出身的小伙伴，或許在大學(xué)的第一節(jié)編程課就被強(qiáng)調(diào)：代碼命名要簡(jiǎn)明扼要并且見(jiàn)名知意，不要使用拼音，不要使用非公認(rèn)的縮寫等等，下面為代碼命名的幾點(diǎn)建議：

(1) 使用常見(jiàn)的英文單詞，不使用拼音

代碼的命名，應(yīng)該盡量使用常見(jiàn)的英文單詞，這樣對(duì)于大部分人來(lái)說(shuō)能夠知道其意圖。不要使用拼音命名，在軟件開(kāi)發(fā)領(lǐng)域，英文是主要的編程語(yǔ)言和命名規(guī)范。使用拼音給代碼命名違反了行業(yè)的慣例和標(biāo)準(zhǔn)而且可讀性差。

(2) 使用公認(rèn)的縮寫，否則使用全稱

有時(shí)候，為了簡(jiǎn)化命名，會(huì)使用縮寫，但是這些縮寫一定要是業(yè)內(nèi)大家公認(rèn)的，比如：Impl 指代 Implement， str 指代 String，num 指代 number，del 指代 delete。

(3) 使用和團(tuán)隊(duì)一致的命名風(fēng)格

現(xiàn)在的開(kāi)發(fā)大部分是團(tuán)隊(duì)合作，因此，代碼命名應(yīng)該在團(tuán)隊(duì)內(nèi)部保持一致，比如：和數(shù)據(jù)庫(kù)交互的 Reporitory層，一般都是 CRUD方法的封裝，如果團(tuán)隊(duì)使用 selectXXX 代表查詢，我們就不要使用getXXX 或者 queryXXX，這樣檢索查詢的方法時(shí)，可以根據(jù)select定位，同理，對(duì)于添加數(shù)據(jù)是使用 addXXX 還是 saveXXX 或者 insertXXX，也需要保持一種方式。

(4) 命名不要太長(zhǎng)

命名要盡量的簡(jiǎn)短，而且能準(zhǔn)確的傳達(dá)意思，如果需要使用長(zhǎng)命名，建議不要超過(guò)5個(gè)單詞。

溫馨建議：如果你在日常工作中對(duì)于命名拿不準(zhǔn)時(shí)，可以給身邊的同事參考，看看他們對(duì)該命名是否和你的本意是一致，這樣也能幫助你更好的去命名。

2. 巧用注釋

命名可以幫助讀者從字面上了解代碼的功能，但無(wú)法傳達(dá)代碼更多細(xì)節(jié)，因此，需要借助注釋來(lái)完成這部分功能。喜歡查看源碼的小伙伴應(yīng)該可以發(fā)現(xiàn)，在 JDK，Spring等這些優(yōu)秀的開(kāi)源框架的源碼中，類，方法甚至變量，幾乎都有相應(yīng)的注釋，而我們?cè)谑褂媚硞€(gè)功能時(shí)，最直接的方式往往是通過(guò)官方提供的注釋來(lái)了解其功能，因此，注釋的重要性可想而知。

因此，注釋是命名的補(bǔ)充和增強(qiáng)。

注釋需要寫什么內(nèi)容呢？這里以 java.util.Collections 為例， 如下圖：

通過(guò) JDK 的 Collections源碼注釋可以看出：注釋的內(nèi)容大概包含 5部分信息：what, why, how, time, authors 即是什么？為什么？怎樣做？時(shí)間 和 作者。我們可以根據(jù)需要靈活的搭配來(lái)添加注釋。需要注意的，注釋也需要簡(jiǎn)明扼要，盡量使用一些提煉，解釋和總結(jié)性的語(yǔ)句，切勿長(zhǎng)篇大論。

3. 代碼風(fēng)格

一個(gè)好的代碼風(fēng)格可以讓代碼看起來(lái)很清爽，降低代碼閱讀的復(fù)雜度。代碼風(fēng)格主要體現(xiàn)在以下幾點(diǎn)：左括號(hào)風(fēng)格，代碼縮進(jìn)，空行，超長(zhǎng)行，魔數(shù)，方法代碼過(guò)多，方法參數(shù)過(guò)多

• 左括號(hào)風(fēng)格在代碼行尾還是換行使用左括號(hào)，這個(gè)根據(jù)個(gè)人習(xí)慣，不過(guò)團(tuán)隊(duì)合作要求保持一種風(fēng)格。
• 代碼縮進(jìn)代碼編寫時(shí)，為了美觀，一般都不會(huì)頂格，需要縮進(jìn)，因此常見(jiàn)的縮進(jìn)有 兩格縮進(jìn)和四格縮進(jìn)，選擇哪一種也是根據(jù)個(gè)人習(xí)慣，不過(guò)團(tuán)隊(duì)合作要求保持一種風(fēng)格。
• 空行在方法內(nèi)部，我們可以使用空行，將邏輯獨(dú)立的代碼塊區(qū)分，這樣，一方面可以更方便的閱讀方法實(shí)現(xiàn)，另一方面，當(dāng)獨(dú)立的代碼塊代碼量增多時(shí)，可以考慮將代碼塊抽離成新的方法。
• 超長(zhǎng)行每行的代碼量不要太長(zhǎng)，通常建議電腦一屏的寬度為準(zhǔn)，如果超過(guò)一屏，建議換行。
• 魔數(shù)在代碼編寫時(shí)，不要出現(xiàn)魔數(shù)，我們要善于使用常量去定義這些魔數(shù)，增加代碼的可讀性。
• 方法代碼過(guò)多每個(gè)方法中的代碼量不要太多，因?yàn)榇a太多會(huì)增加方法閱讀的復(fù)雜度，通常建議電腦一屏的高度為準(zhǔn)，超過(guò)了就要考慮能否再抽離出新方法。
• 方法參數(shù)過(guò)多編寫方法的時(shí)候，通常都會(huì)定義入?yún)ⅲ话憬ㄗh入?yún)⒌膫€(gè)數(shù)不要超過(guò)5個(gè)，如果再多就需要考慮封裝對(duì)象來(lái)傳遞參數(shù)。

以上代碼風(fēng)格如果是團(tuán)隊(duì)合作，最好是保持一致。更多代碼規(guī)范 推薦《代碼整潔之道》和《阿里巴巴開(kāi)發(fā)手冊(cè)》

4. 快速短路

如下的偽代碼，當(dāng) user == null時(shí)，可以通過(guò) return快速短路返回，去除多余的 esle 語(yǔ)句。因此，在日常業(yè)務(wù)開(kāi)發(fā)中，遇到類似的情況，一定要做到快速短路，切莫使用大量嵌套。比如 if-esle 語(yǔ)句可以使用 return 快速短路；對(duì)于 for 循環(huán)可以使用 break，continue，return等提前跳出，減少不必要的遍歷；

public User getUser(String id) {
 // get by id
 User user = getById(id);

 if(user == null){
  return null;
 } else {
   // else 邏輯
 }
 
 // 優(yōu)化成
 if(user == null){
   return null;
 }
 // else 邏輯

5. SOLID原則

在類或者方法的設(shè)計(jì)上要盡量遵守 SOLID原則，SOLID原則是業(yè)內(nèi)一個(gè)比較的原則，關(guān)于 SOLID原則可以參考小編以往的文章：優(yōu)雅代碼，從 SOLID 開(kāi)始

6. 設(shè)計(jì)模式

設(shè)計(jì)模式在代碼中的使用是一個(gè)比較高階的能力體現(xiàn)，巧用設(shè)計(jì)模式，可以大大提高代碼的可維護(hù)性、可擴(kuò)展性和可重用性等功能，在很多開(kāi)源的框架上都有設(shè)計(jì)模式的體現(xiàn)，比如：Spring 中的單例模式（Single Pattern）工廠模式（Factory Pattern），代理模式（Proxy Pattern），適配器模式（Adapter Pattern），模板模式（Template Pattern），觀察者模式（Observer Pattern）等等。

如果你對(duì)設(shè)計(jì)模式不是很熟悉，推薦書籍 Erich Gamma 的《設(shè)計(jì)模式》，另外，JDK 和 Spring框架也是一個(gè)很好的學(xué)習(xí)資料，可以對(duì)照著源碼中設(shè)計(jì)模式的代碼，加強(qiáng)對(duì)設(shè)計(jì)模式的理解，然后可以嘗試著在日常開(kāi)發(fā)中去使用某些設(shè)計(jì)模式。

7. 單元測(cè)試

單元測(cè)試是開(kāi)發(fā)人員保證代碼質(zhì)量最直接的方式，但現(xiàn)實(shí)工作中卻被很多人忽略，有的借故業(yè)務(wù)開(kāi)發(fā)忙，沒(méi)有把時(shí)間寫單測(cè)，因此把測(cè)試功能全部丟給測(cè)試人員，有的是不如何寫單測(cè)，關(guān)于單元測(cè)試，可以參閱小編以往文章：TDD，什么是 測(cè)試驅(qū)動(dòng)開(kāi)發(fā)？

8. 數(shù)據(jù)結(jié)構(gòu)

有人說(shuō) 程序 = 數(shù)據(jù)結(jié)構(gòu) + 算法，足以看出數(shù)據(jù)結(jié)構(gòu)和算法的重要性，作為 Java程序員，我們經(jīng)常使用的 HashMap, List, Set, String 等都是 Java 語(yǔ)言對(duì)數(shù)據(jù)結(jié)構(gòu)的一種友好封裝，關(guān)于數(shù)據(jù)結(jié)構(gòu)，可以參閱小編以往文章：數(shù)據(jù)庫(kù)，你必須掌握的8種數(shù)據(jù)結(jié)構(gòu)！ 數(shù)據(jù)結(jié)構(gòu)之美：為什么 MySQL 選擇 B+樹(shù)做索引？

在實(shí)際工作中，很多人面對(duì)的工作絕大多數(shù)是業(yè)務(wù)開(kāi)發(fā)，所以處理數(shù)據(jù)肯定離不開(kāi)數(shù)據(jù)結(jié)構(gòu)，建議平時(shí)多研究 JDK 的源碼，比如：Map，List 等常用的數(shù)據(jù)結(jié)構(gòu)的底層實(shí)現(xiàn)原理，這樣在使用時(shí)才能得心應(yīng)手應(yīng)手。

9. 算法

近些年，算法在技術(shù)面試中的比重越來(lái)越大，特別是在一些知名的互聯(lián)網(wǎng)公司面試，如果代碼中能夠合理地使用算法，將事半功倍。需要說(shuō)明的是，在日常的業(yè)務(wù)開(kāi)發(fā)中，手寫算法的概率比較低，一般會(huì)使用三方框架，比如：Google Guava中的限流算法。

對(duì)于算法，似乎沒(méi)有很好的捷徑，小編的建議是：經(jīng)常去算法網(wǎng)站上刷題，一方面讓算法能力處于隨時(shí)可以面試的狀態(tài)，一方面通過(guò)大量的算法實(shí)現(xiàn)量變到質(zhì)變，掌握算法的精髓。

10. 重構(gòu)

重構(gòu)是代碼迭代中一直會(huì)存在的行為，當(dāng)發(fā)現(xiàn)代碼有 Bad Smell “壞味道”時(shí)，得考慮代碼是否需要重構(gòu)。重構(gòu)，一般分為小重構(gòu)和大重構(gòu)，小重構(gòu)通常是指工作量小，時(shí)間可控（比如時(shí)間不超過(guò) 2個(gè)工作日），甚至不需要測(cè)試參與。大重構(gòu)是指時(shí)間周期比較大，對(duì)代碼的改造比較大，一般需要整體設(shè)計(jì)，然后分階段進(jìn)行。關(guān)于代碼重構(gòu)，可以參考微服務(wù)作者 Martinfowler 的博客：https://martinfowler.com/books/refactoring.html 或者 Martinfowler 的書籍：《重構(gòu)，改善既有代碼的設(shè)計(jì)》第二版，《重構(gòu)與模式》《修改代碼的藝術(shù)》

三、總結(jié)

本文分析了高質(zhì)量代碼的幾個(gè)衡量維度：

• 可讀性
• 可維護(hù)性
• 可擴(kuò)展性
• 可復(fù)用性
• 可測(cè)試性

在編寫代碼時(shí)，應(yīng)該多關(guān)注上面幾個(gè)因素，一開(kāi)始可以刻意練習(xí)，然后慢慢變成一種習(xí)慣，這樣編寫的代碼質(zhì)量應(yīng)該不會(huì)太差。

接著我們介紹了提升代碼質(zhì)量的 10種常用方法：

• 規(guī)范命名
• 巧用注釋
• 代碼風(fēng)格
• 快速短路
• 單元測(cè)試
• SOLID原則
• 設(shè)計(jì)模式
• 數(shù)據(jù)結(jié)構(gòu)
• 算法
• 重構(gòu)

前 4種方法更多體現(xiàn)在代碼的“形”上，體現(xiàn)了程序員對(duì)代碼細(xì)節(jié)的把握，而后 6種方法則更多體現(xiàn)了代碼的“神”，體現(xiàn)了程序員基本功和能力。

根據(jù)小編多年的工作經(jīng)驗(yàn)，前 4種方法是最簡(jiǎn)單，提升代碼質(zhì)量最見(jiàn)效的方法，它們幾乎和能力和工作年限無(wú)關(guān)，完全在于程序員能否扣住細(xì)節(jié)，如果能夠在這 4個(gè)方法上多花點(diǎn)功夫，編寫的代碼已經(jīng)可以甩很多人一條街了。

對(duì)于后 6種方法，是開(kāi)發(fā)人員內(nèi)功的體現(xiàn)，它要求的是一個(gè)長(zhǎng)期的積累和修煉過(guò)程，是開(kāi)發(fā)人員能力差距的最好體現(xiàn)，所以，通過(guò)這 6點(diǎn)可以很好地定位某個(gè)程序員的編程段位。建議平時(shí)多閱讀一些業(yè)內(nèi)大牛的經(jīng)典書籍。

四、個(gè)人心得

工作中，經(jīng)常會(huì)遇見(jiàn)一些工作 5年的程序員，寫的代碼質(zhì)量卻遠(yuǎn)不如 3年的程序員，為什么？小編覺(jué)得有以下幾個(gè)原因：

1. 職業(yè)規(guī)劃不清晰

對(duì)于他們來(lái)說(shuō)，大部分都沒(méi)有清晰職業(yè)規(guī)劃，沒(méi)有方向自然就沒(méi)有努力的目標(biāo)，沒(méi)有目標(biāo)就很容進(jìn)入日復(fù)一日循環(huán)重復(fù)工作的僵局。

2. 代碼能用就行

工作中小編也和一些人討論過(guò)，他們對(duì)代碼的態(tài)度是：沒(méi)有必要這么苛刻，能用就行。如果是剛進(jìn)入社會(huì)工作，或許還能理解，如果已經(jīng)工作 3年以上，還是這種想法，競(jìng)爭(zhēng)力在哪里？作為程序員，代碼質(zhì)量不就是最好的武器嗎？

3. 編程不是興趣

對(duì)于很多人來(lái)說(shuō)，選擇編程并不是因?yàn)橄矚g而是覺(jué)得它的工資相對(duì)其他行業(yè)來(lái)說(shuō)會(huì)高一些。眾所周知，興趣是最好的老師，如果長(zhǎng)年累月的干一件沒(méi)有興趣的事，能干好嗎？

4. 外部誘惑太多

游戲，短視頻等外部誘惑太多，一玩停不下來(lái)，工作之余的大部分時(shí)間都被這些“精神鴉片”消耗殆盡。

因?yàn)槠邢蓿豢赡馨衙總€(gè)細(xì)節(jié)點(diǎn)都講清楚，分享一個(gè)小編多年來(lái)一直在踐行的學(xué)習(xí)方法：持續(xù)學(xué)習(xí)，多聽(tīng)，多看，catch 他人優(yōu)秀的 idea，然后不斷地豐富和領(lǐng)會(huì)該 idea，最終形成自己的方法論。豐富和領(lǐng)會(huì)的過(guò)程就在不斷地強(qiáng)大自己，相信長(zhǎng)年累月的積累，終有一天你也可以寫出讓人賞心悅目的高質(zhì)量代碼。