《代碼整潔之道》--筆記

最初我喜歡這本書(shū)可能是因?yàn)榉羌夹g(shù)方面的原因,這本書(shū)中有很多我喜歡的插圖。這本書(shū)的第一章的第一句話是這樣說(shuō)的:讀這本書(shū)通常有兩個(gè)原因:1. 你是一名程序員。2. 你想成為更好的程序員。我們需要更好的程序員。
引于:http://blog.csdn.net/jackfrued/article/details/44980689

這本書(shū)的每一章都可以總結(jié)出一句話,其實(shí)每章開(kāi)始的插圖就是這句話的濃縮。


本書(shū)的第一章是關(guān)于什么是整潔代碼的討論,引用了Bjarne Stroustrup(C++之父)、Grady Booch(UML的創(chuàng)始人之一)等人當(dāng)然也Bob大叔(本書(shū)的作者Robert Martin)自己對(duì)整潔代碼的理解。順便說(shuō)一下,上面那張圖上的代碼應(yīng)該是保齡球計(jì)分程序(不知道大家看清楚了沒(méi)有,哈哈)。


不管是現(xiàn)實(shí)世界還是軟件項(xiàng)目中,命名都是一件讓人頭疼的事情,給小孩起過(guò)名字的就知道,你希望把你對(duì)孩子的期望包含在這個(gè)名字中,你又希望這個(gè)名字讀起來(lái)要好聽(tīng),至少不至于將來(lái)成為別人的笑柄(比如龐光大、魏升京這樣的名字),可能你還要考慮族譜班輩的排列等等。軟件項(xiàng)目中的命名情況會(huì)更加復(fù)雜,簡(jiǎn)單的說(shuō)命名的原則是"見(jiàn)名知意",當(dāng)然你還需要用各種方式防范命名沖突的問(wèn)題,不同的編程語(yǔ)言也有自己不成文的像契約一樣的命名規(guī)則和方式(例如匈牙利命名法),這些可能都是需要考慮的事情。我個(gè)人并不喜歡匈牙利命名法,加上一個(gè)類(lèi)型前綴的感覺(jué)就是永遠(yuǎn)和這個(gè)東西綁定到一起了,就如同用C語(yǔ)言的malloc函數(shù)分配內(nèi)存創(chuàng)建一個(gè)能放100000個(gè)元素的數(shù)組,你愿意用下面哪種寫(xiě)法呢?記住:好的名字相當(dāng)于為代碼寫(xiě)了一段有用的注釋。

int* myArray = NULL;
/* 寫(xiě)法1 */
myArray =malloc(100000*sizeof(int));
/* 寫(xiě)法2 */
myArray =malloc(100000*sizeof*myArray);

第三章講的是函數(shù),說(shuō)了這么一句話:"Function should do one thing. They should do it well. They should do it only. "(函數(shù)只應(yīng)該做一件事情,把一件事情做好,而且只由它來(lái)做這一件事情),聽(tīng)起來(lái)很簡(jiǎn)單的一句話但是要踐行這條原則卻并不容易,所以我們的代碼中才會(huì)有很多的壞味道(請(qǐng)參考《重構(gòu):改善既有代碼的設(shè)計(jì)》一書(shū)的第三章)。事實(shí)上,上升一個(gè)層次,我們?cè)谠O(shè)計(jì)類(lèi)的時(shí)候也應(yīng)該如此,這是面向?qū)ο笤O(shè)計(jì)原則中說(shuō)的單一職責(zé)原則(SRP),當(dāng)我們的代碼中出現(xiàn)了冗長(zhǎng)的方法或者巨大的類(lèi)的時(shí)候,我們就應(yīng)該依據(jù)職責(zé)來(lái)對(duì)其進(jìn)行拆分,這樣程序的結(jié)構(gòu)才會(huì)趨于合理,最終達(dá)到"高內(nèi)聚"的目標(biāo)。當(dāng)然,這一章里面還提到很多理念,包括:Command Query Separation(一個(gè)方法要么執(zhí)行某種命令,要么返回查詢(xún)數(shù)據(jù))、DRY(不要重復(fù)自己)、Prefer Exceptions to Returning Error Codes(異常優(yōu)于返回錯(cuò)誤碼)等。


第四章講的是注釋?zhuān)幸痪湓捨液芟矚g,說(shuō)的是:"Comments Do Not Make Up for Bad Code."(注釋不是對(duì)劣質(zhì)代碼的補(bǔ)救)。事實(shí)上好的代碼即便沒(méi)有注釋也擁有良好的可讀性,但恰當(dāng)?shù)淖⑨寱?huì)讓代碼變得更可讀、可維護(hù)性更高。


第五章講的是代碼風(fēng)格。現(xiàn)代IDE(集成開(kāi)發(fā)環(huán)境)幾乎都有代碼格式化代碼的功能,你只需要設(shè)置好你使用的代碼風(fēng)格就可以了,其實(shí)不只是IDE,很多高級(jí)的文本編輯工具也能夠按照指定的風(fēng)格格式化你的代碼。用什么樣的代碼風(fēng)格不是關(guān)鍵,關(guān)鍵是整個(gè)項(xiàng)目組的成員應(yīng)當(dāng)使用相同的代碼風(fēng)格,讓多個(gè)人編寫(xiě)的代碼看起來(lái)像一個(gè)人書(shū)寫(xiě)的。我個(gè)在代碼中使用的括號(hào)風(fēng)格是1TBS(One True Bracing Style,也叫做K&R風(fēng)格,這種風(fēng)格是Kernighan和Ritchie兩位老師在"The C Programming Language"一書(shū)中使用的代碼風(fēng)格),當(dāng)然Allman風(fēng)格(FreeBSD系統(tǒng)的作者之一使用的代碼風(fēng)格)也是很好的選擇。


第六章討論的是對(duì)象和數(shù)據(jù)結(jié)構(gòu),讀完之后的感覺(jué)是雖然我們天天都嚷著吼著要面向?qū)ο缶幊蹋呛芏鄷r(shí)候我們都使用了類(lèi)的退化結(jié)構(gòu),包括我們開(kāi)發(fā)時(shí)經(jīng)常使用的失血模型和貧血模型(事務(wù)腳本模式)都和面向?qū)ο蟮脑O(shè)計(jì)理念相違背。我得承認(rèn)在讀這一章的時(shí)候我可能沒(méi)有抓住作者的觀點(diǎn)。


第七章對(duì)錯(cuò)誤處理(異常)的講解非常精彩的,整潔的代碼中對(duì)錯(cuò)誤的處理應(yīng)當(dāng)是被分離的關(guān)注點(diǎn)(不要跟正常的業(yè)務(wù)邏輯混雜在一起),而面向?qū)ο笾械漠惓C(jī)制就是一種在不打亂原有業(yè)務(wù)邏輯的前提下處理掉程序在運(yùn)行時(shí)發(fā)生的不正常狀況的手段。這章有兩個(gè)觀點(diǎn)我特別欣賞,一是"Use Unchecked Exceptions"(非受檢異常允許你在適當(dāng)?shù)牡胤教幚懋惓#m當(dāng)?shù)牡胤骄褪钱惓S绊懘a執(zhí)行邏輯的地方,不管做哪種類(lèi)型的應(yīng)用,都應(yīng)該盡可能向用戶(hù)隱藏異常的發(fā)生,除非發(fā)生了不可挽救的狀況,這才是符合最小驚訝原則的設(shè)計(jì));二是"Don’t Return Null"(如果一個(gè)方法在出狀況的時(shí)候返回null,那么調(diào)用者都要通過(guò)頻繁的檢查返回值來(lái)判定是否出錯(cuò),一旦忘了這件事情就有可能出錯(cuò),既然null是一種異常狀況,那么用拋出異常的方式來(lái)代替返回null明顯是更好的做法)。


第八章的內(nèi)容對(duì)實(shí)際開(kāi)發(fā)有重要的指導(dǎo)意義,因?yàn)槲覀兊捻?xiàng)目中不可避免的要使用第三方工具,因此我們需要將這些東西整潔的納入到我們的系統(tǒng)中,這時(shí)就需要考慮系統(tǒng)邊界的問(wèn)題。有的時(shí)候我們會(huì)千辛萬(wàn)苦的發(fā)現(xiàn)系統(tǒng)中的一些bug是來(lái)源于第三方工具的,當(dāng)然我們基本上沒(méi)有時(shí)間去重頭學(xué)習(xí)和研究第三方工具或者自己寫(xiě)代碼來(lái)實(shí)現(xiàn)第三方工具的功能,但是我們至少應(yīng)該先對(duì)第三方工具進(jìn)行測(cè)試。我在以前的項(xiàng)目中,即使用Apache提供的那些著名的第三方工具,我的做法也是先寫(xiě)測(cè)試代碼對(duì)這些工具的可用性和有效性進(jìn)行證實(shí),當(dāng)然有的時(shí)候可能是過(guò)于謹(jǐn)慎了,但這種習(xí)慣和做法本身是很好的。在這種場(chǎng)景下,適配器模式是非常好的設(shè)計(jì),它不僅能將不兼容的接口改寫(xiě)成兼容的接口,還能夠?qū)νㄟ^(guò)對(duì)第三方工具重新封裝來(lái)避免邊界的變化對(duì)系統(tǒng)的影響。


第九章的內(nèi)容是單元測(cè)試。Bob大叔是TDD(測(cè)試驅(qū)動(dòng)開(kāi)發(fā))的倡導(dǎo)者,這一章講的是如何編寫(xiě)整潔的測(cè)試,Bob大叔的答案是FIRST規(guī)則(Fast、Independent、Repeatable、Self-Validating、Timely)。


第十章介紹類(lèi)的設(shè)計(jì),最重要的還是SRP(單一職責(zé)原則)。

這里寫(xiě)圖片描述
??第十一章是關(guān)于系統(tǒng)設(shè)計(jì)的內(nèi)容,開(kāi)篇引用了微軟首席技術(shù)官Ray Ozzie的一句話:"Complexity kills. It sucks the life out of developers, it makes products difficult to plan, build and test."(復(fù)雜要人命,它消磨開(kāi)發(fā)者的生命,讓產(chǎn)品難于規(guī)劃、構(gòu)建和測(cè)試)。這章對(duì)于希望了解面向切面編程的開(kāi)發(fā)者是極好的,包括了對(duì)依賴(lài)注入、代理模式以及AOP的探討。
這里寫(xiě)圖片描述
??第十二章探討了系統(tǒng)的迭代式演進(jìn)。
這里寫(xiě)圖片描述
??第十三章對(duì)并發(fā)編程的討論非常經(jīng)常,很多開(kāi)發(fā)者都畏懼并發(fā)編程,也有的開(kāi)發(fā)者迷信多線程可以解決所有的并發(fā)問(wèn)題,如果你是這兩類(lèi)人之一,本章會(huì)教給你真正的并發(fā)編程。這一章的內(nèi)容我重新整理了一篇文章,已經(jīng)發(fā)布在CSDN的博客上,名為《關(guān)于Java并發(fā)編程的總結(jié)和思考》
這里寫(xiě)圖片描述
??第十四章是一個(gè)精彩的案例用來(lái)講解對(duì)代碼的持續(xù)改進(jìn),你可以自己好好閱讀一次。第十五章到第十七章說(shuō)的都是重構(gòu),相當(dāng)精彩。如果你還沒(méi)有來(lái)得及讀《重構(gòu):改善既有代碼的設(shè)計(jì)》一書(shū),你可以先讀讀這幾張中探討的代碼的壞味道及其改進(jìn)方案。
??總之,這本書(shū)從引言到附錄都無(wú)比精彩,書(shū)中的代碼是用Java語(yǔ)言書(shū)寫(xiě)的,趕緊去閱讀吧。

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
平臺(tái)聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡(jiǎn)書(shū)系信息發(fā)布平臺(tái),僅提供信息存儲(chǔ)服務(wù)。
  • 序言:七十年代末,一起剝皮案震驚了整個(gè)濱河市,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 228,505評(píng)論 6 533
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場(chǎng)離奇詭異,居然都是意外死亡,警方通過(guò)查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 98,556評(píng)論 3 418
  • 文/潘曉璐 我一進(jìn)店門(mén),熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái),“玉大人,你說(shuō)我怎么就攤上這事。” “怎么了?”我有些...
    開(kāi)封第一講書(shū)人閱讀 176,463評(píng)論 0 376
  • 文/不壞的土叔 我叫張陵,是天一觀的道長(zhǎng)。 經(jīng)常有香客問(wèn)我,道長(zhǎng),這世上最難降的妖魔是什么? 我笑而不...
    開(kāi)封第一講書(shū)人閱讀 63,009評(píng)論 1 312
  • 正文 為了忘掉前任,我火速辦了婚禮,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 71,778評(píng)論 6 410
  • 文/花漫 我一把揭開(kāi)白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上,一...
    開(kāi)封第一講書(shū)人閱讀 55,218評(píng)論 1 324
  • 那天,我揣著相機(jī)與錄音,去河邊找鬼。 笑死,一個(gè)胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,281評(píng)論 3 441
  • 文/蒼蘭香墨 我猛地睜開(kāi)眼,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼!你這毒婦竟也來(lái)了?” 一聲冷哼從身側(cè)響起,我...
    開(kāi)封第一講書(shū)人閱讀 42,436評(píng)論 0 288
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒(méi)想到半個(gè)月后,有當(dāng)?shù)厝嗽跇?shù)林里發(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 48,969評(píng)論 1 335
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 40,795評(píng)論 3 354
  • 正文 我和宋清朗相戀三年,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 42,993評(píng)論 1 369
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,537評(píng)論 5 359
  • 正文 年R本政府宣布,位于F島的核電站,受9級(jí)特大地震影響,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 44,229評(píng)論 3 347
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開(kāi)封第一講書(shū)人閱讀 34,659評(píng)論 0 26
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)。三九已至,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開(kāi)封第一講書(shū)人閱讀 35,917評(píng)論 1 286
  • 我被黑心中介騙來(lái)泰國(guó)打工, 沒(méi)想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個(gè)月前我還...
    沈念sama閱讀 51,687評(píng)論 3 392
  • 正文 我出身青樓,卻偏偏與公主長(zhǎng)得像,于是被迫代替她去往敵國(guó)和親。 傳聞我的和親對(duì)象是個(gè)殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 47,990評(píng)論 2 374

推薦閱讀更多精彩內(nèi)容