① 如何提升程序員的代碼編寫能力
一、先列三個常見的開發場景:
1、拿到一個模塊詳細設計文檔,大部分程序員的通常做法就是開始搭建界面代碼,然後從第一個按鈕點擊事件或頁面Load事件開始寫第一行業務代碼。寫的差不多了,就運行一下,發現哪裡不是自己想的那樣,就改改,直到改到是自己預想的那樣。
2、做完了一個功能模塊或幾塊相關聯的功能模塊,輸入111asd,發現新建正常、保存正常,就提交給測試人員。測試員用測試用數據、測試場景用例來測試,發現有問題,就登記bug。對於嚴重的影響下一步測試的BUG,測試員就用內部IM通知這個開發人員。對於不影響繼續往下測試的BUG,測試員就登記下來,等程序員有空時處理。
3、程序員一般工作不希望大家打擾,所以開發起來就是開發。等手頭開發告一段落,就看看BUG庫。發現有與自己有關的BUG,就從第一個BUG開始看起。就開始通過IM和測試員掰扯起來(這不是個BUG啊、業務邏輯不是你想的那樣啊、我這里不能重現啊、你給的信息描述不清晰啊),於是IM幾來幾往,甚至跑過去當面交流一番,甚至會拉扯上產品經理一起討論,更甚者需要項目經理或產品經理發起一個會議來集體討論一下
這是不是很熟悉呢?這就是大部分程序員開發的三個步驟:寫代碼、自測、修復BUG。
二、說好的代碼設計、代碼測試呢?
代碼設計?那不是都有開發平台么,已經固化了啊。那不是維護舊功能做完善修改呢么,又不是寫新代碼,只能在現有代碼基礎上修改啊,你又不能大幅重構。
代碼測試?你丫需求討論期、產品設計期、設計評審期那麼長,都把研發項目時間佔光了,就留下2個星期讓我們寫代碼,我們哪裡有時間搞那麼深的測試。還想讓我們搞結對編程?還想讓我們搞測試驅動開發?
而且你看測試,什麼功能測試、集成測試、性能測試、安全測試、安裝部署測試、升級測試、遷移測試、UAT測試,一大堆測試,測試也需要很多時間。
一個項目,需求討論、產品范圍規劃與評審、產品設計與設計評審佔了一個半月,開發+自測就一個月,測試佔了一個半月,這就4個月了啊。
三、為啥程序員寫代碼總是寫寫測測?
剛才大家也都看到了,大部分程序員都是從界面代碼開始寫起,而且寫一寫,就運行一下看看。為什麼會是這種開發方式?
那是因為大部分程序員缺乏在腦子中的整體建模能力。只能做出來一點,真實的感覺一下,然後再往下。
有些是產品經理的上游就有問題,沒給出業務流程圖(因為產品經理也沒做過業務),也沒畫清楚產品功能操作流程圖。
為啥沒給出業務流程圖?因為產品經理不熟悉業務,另外,產品經理也沒有流程建模能力啊。為啥沒畫清楚產品功能操作流程圖啊?因為不會清晰表達流程啊。
很多產品經理、程序員,都缺乏分類、分層、相關、先後能力,更別說總結、洞察能力。
這是基本訓練,是一個做事頭腦清醒的人必備的技能,這不是一個程序員或產品經理或測試員的特定技能要求。
我經常看書就梳理書的脈絡,每看一本就寫一篇總結。我過去閑扯淡還梳理過水滸傳、紅樓夢的人物關系圖呢,其實就在事事上訓練自己的關聯性、層次性、洞察性。
我經常面試一個人時,我會問這樣的問題:「你把我剛才說的話復述一遍,另外你再回答一下我為什麼會這樣?」,其實,我就在看一個人的細心記憶、完整梳理、重現能力,我也在看一個人的梳理、總結、洞察能力。
我個人寫代碼就喜歡先理解業務流,然後理解數據表關系,然後理解產品功能操作流,大致對功能為何這樣設計、功能這樣操作會取什麼表、插入或更新哪些表,哪些表的狀態欄位是關鍵。
然後我寫代碼的時候,就根據我所理解的業務流、功能操作流、數據輸入輸出流,定義函數,定義函數的輸入與輸出。
然後,我會給函數的輸入值,賦上一些固定值,跑下來看看能否跑通這幾個關聯函數,看看還需要怎樣的新增函數,或者看看函數的輸入輸出參數是否滿足跑通。
剩下的事,就是我填肉寫詳細邏輯代碼了。
當然,大部分人沒我這樣的邏輯建模能力。怎麼閱讀理解也想像不出來,也沒法定義函數。畢竟有邏輯建模能力的程序員都很少,100個人里有10個,已經是求爺爺告奶奶好幸運了。
那怎麼辦呢?
我建議是分離分工配合,這就是現實中沒辦法的辦法。讓有邏輯建模能力的人來設計函數框架、來設計工具來設計代碼模板,然後讓沒有邏輯建模能力的人來填肉寫詳細邏輯代碼。
我們可以先從最緊要的模塊開始這么做。不緊要的模塊,還讓它放任自流,讓熟練手程序員繼續塗抹。
我曾經還讓有頭腦的程序員做榜樣,給大家分享他是怎麼規劃函數的,怎麼做維護性代碼的代碼結構改善的。但是發現效果並不佳,其他人並沒有因此能做代碼設計。可能邏輯建模能力是個人的基本素質,是從小到大訓練成型的,不是你一個大學已經幾年的人能夠短時間內可以訓練的。
所以啊,還是讓能走的人先走,讓從最緊要的模塊開始這么做。
不必擔心這樣做後,因為過去一件事被分工(一個做代碼框架一個填肉)成兩個人做了會降低工作效率。我們很多的工作效率低就是因為半瓶子醋搞出來的,來回反復修改。
真是應了劉德華在電影里說的那句話:說你又不聽,聽又聽不懂,聽懂了又不做,做又做不好,做不好還不服氣。
四、為什麼大部分程序員不做代碼測試或白盒測試或單元測試呢?
還是因為沒有代碼設計。因為沒有函數啊。所以,一個按鈕功能有多復雜,代碼就有多長。我見過2000行的函數,我也見過1000多行的存儲過程和視圖SQL。怎麼做白盒測試啊,這些代碼都粘在一起呢,要測,就得從頭到尾都得測。
所以啊,先學會設計函數,先寫好函數,這就求爺爺告奶奶了。很多開發了5年的熟練手程序員,可能都未必會寫函數。
函數的輸入輸出值就很有講究。很多人都寫死了,隨著版本迭代,發現過去定義的函數參數不夠用了,於是就新增了一個參數。然後,相關性異常就爆發了,其他關聯的地方忘改了,到底哪些有關聯,怎麼查啊,本系統沒有,沒准其他系統就調用你了,你根本不知道哪個神經人曾經COPY過你的代碼修吧修吧就改成了他的功能呢,而且裡面的很多代碼他看不懂也不敢刪,只要他實現的功能正常了他也不管了。於是,你改了你這個函數,他的系統就莫名出錯了。
所以,我一般會定義幾個對象來做參數。另外,我也很注重函數的日誌、函數的異常保護、異常拋出、異常返回。另外,我也很注重參數輸入值的合法性校驗。
所以啊,應該開發Leader們先制定函數編寫規范最佳實踐,輸入輸出參數怎麼定義比較好,函數的返回值如何定義比較好,函數的日誌記錄應該怎麼寫比較好,函數的異常保護、異常拋出、異常返回如何寫比較好。先教會一般程序員,先從會寫函數開始啊。
當然,你光有一份規范,程序員們還是不理解、不實際應用啊。所以,還得Leader們做好典型的代碼模板,裡面是符合函數規范的代碼框架,只有這樣,一般程序員們才會照貓畫虎適應了函數設計的編程習慣。
所以啊,我專門重新定義了leader的明確職責,其中第一個重要職責就是:負責工具/框架/模板/規范的制定,並且負責推廣且普及應用落地。
你不明確定義Leader的這個重要職責,你不對這個職責做明確的KPI考核,誰尿你啊。你以為好的工具/框架/模板/規范是靠人們的熱情、自發產生的么?我們還沒有那麼自覺高尚啊。
五、為什麼大部分程序員不寫注釋啊?
我經常說一句話,千萬別多寫注釋。為啥?
因為我們經常遇到的問題不是沒有注釋,而是更糟的是,注釋和事實代碼邏輯是不相符的。這就出現常見問題了:殘存下來的設計文檔是一個邏輯、注釋是一個邏輯說明、真實代碼邏輯又是一個,鍾表多了,你也不知道正確時間了。
所以啊,產品文檔、注釋、真實代碼,三者總是很難一致同步。我為了幾百人研發團隊能做到這個同步花了大量心血和辦法,但我最終也沒解決了這個問題,還把Leader們、總監們、我都搞的精疲力盡。
索性回歸到一切一切的本源,代碼,就是程序員的唯一產出,是最有效的產出。那麼,讓代碼寫的不用注釋也能看懂,咱得奔著這個目的走啊。
為啥看不懂,不就是義大利面條式代碼么,又長又互相交雜。
OK,我就規定了,每個函數不能超過50行。用這一個簡單規定和靜態代碼檢查插件,來逼迫大家嘗試著寫函數。有的函數屬於流程函數,是串起其他函數的,有的函數就是詳細實現函數,實現一個且唯一一個明確作用的。
有了流程函數和功能函數,而且每個函數不超過50行,這就比過去容易看懂了。
六、為什麼大部分程序員不抽象公共函數啊?
我經常說一句話:千萬別抽象公共函數啊。為啥?
因為大部分程序員缺乏抽象洞察能力。特別是有些積極熱情有餘、愛學習愛看書、半瓶子醋晃悠的二桿子,看了幾本UML、重構、設計模式、整潔代碼之道,就躍躍欲試了,還真敢給你抽象公共函數了。
一開始,他覺得80%相似,20%不相似,於是在公共函數裡面簡單寫幾個if..else做個區隔就可以。沒想到,越隨著版本迭代,這些功能漸漸越變越不一樣了,但是這個代碼已經幾經人手了,而且這是一個公共函數,誰也不知道牽扯多少,所以誰也不敢大改,發現問題了就加一個if..else判斷。
沒想到啊沒想到,這個本來當初公共的函數,現在變成了系統最大的毒瘤,最復雜的地方,誰也不敢動,除非實在萬不得已,手起刀落。
所以,我平時告誡程序員,純技術的、純通用的,你們可以嘗試搞搞抽象公共函數,對於業務的,你們還是簡單粗暴的根據Leader們做的代碼模板代碼框架,乖乖的復制、修改、填肉吧。
你們啊,先從做模板做代碼片段開始吧,咱們放到咱們內部代碼片段開源庫里,看誰的代碼片段被別人復制的多,說明你的代碼抽象設計能力越好了。那時候,我就大膽放心讓你撒丫子跑了。在沒有學會跑之前,給老子乖乖的復制、修改、填肉吧。
② 什麼是代碼,代碼怎麼寫,怎樣寫入電腦
代碼指的是程序員用開發工具所支持的語言寫出來的源文件,是一組由字元、符號或信號碼元以離散形式表示信息的明確的規則體系。簡單理解代碼就是代表某些意思的符號,用來實現一定功能的號碼。
計算機代碼(也稱源程序),是指一系列人類可讀的計算機語言指令。
源代碼是相對目標代碼和可執行代碼而言的。 源代碼就是用匯編語言和高級語言寫出來的地代碼。目標代碼是指源代碼經過編譯程序產生的能被 CPU 直接識別的二進制代碼。可執行代碼就是將目標代碼連接後形成的可執行文件,當然也是二進制的。
要想寫代碼就是將要處理的事件,按處理步驟順序,用一種計算機能懂的語言串連起來,按步就班的執行。對程序員來說要做的工作就是:
1、學習。需要學習編程軟體,比如C++、VC等。
2、編程。編寫是程序的中文簡稱,就是讓計算機為解決某個問題而使用某種程序設計語言編寫程序代碼,並最終得到相應結果的過程。
3、交流。為了使計算機能夠理解人的意圖,人類就必須要將需解決的問題的思路、方法、和手段通過計算機能夠理解的形式告訴計算機,使得計算機能夠根據人的指令一步一步去工作,完成某種特定的任務。這種人和計算機之間交流的過程就是編程的過程。
(2)程序員如何寫代碼實現某些功能擴展閱讀
源代碼(也稱源程序),是指一系列人類可讀的計算機語言指令。
源代碼是相對目標代碼和可執行代碼而言的。 源代碼就是用匯編語言和高級語言寫出來的地代碼。目標代碼是指源代碼經過編譯程序產生的能被cpu直接識別二進制代碼。可執行代碼就是將目標代碼連接後形成的可執行文件,當然也是二進制的。
在現代程序語言中,源代碼可以是以書籍或者磁帶的形式出現,但最為常用的格式是文本文件,這種典型格式的目的是為了編譯出計算機程序。計算機源代碼的最終目的是將人類可讀的文本翻譯成為計算機可以執行的二進制指令,這種過程叫做編譯,通過編譯器完成。
源代碼主要作用:
1、生成目標代碼,即計算機可以識別的代碼。
2、對軟體進行說明,即對軟體的編寫進行說明。為數不少的初學者,甚至少數有經驗的程序員都忽視軟體說明的編寫,因為這部分雖然不會在生成的程序中直接顯示,也不參與編譯。但是說明對軟體的學習、分享、維護和軟體復用都有巨大的好處。
3、因此,書寫軟體說明在業界被認為是能創造優秀程序的良好習慣,一些公司也硬性規定必須書寫。
4、需要指出的是,源代碼的修改不能改變已經生成的目標代碼。如果需要目標代碼做出相應的修改,必須重新編譯。
③ 如何寫出好的Java代碼
如何寫出好的Java代碼
1. 優雅需要付出代價。
從短期利益來看,對某個問題提出優雅的解決方法,似乎可能花你更多的時間。但當它終於能夠正確執行並可輕易套用於新案例中,不需要花上數以時計,甚至以天計或以月計的辛苦代價時,你會看得到先前所花功夫的回報(即使沒有人可以衡量這一點)。這不僅給你一個可更容易開發和調試的程序,也更易於理解和維護。這正是它在金錢上的價值所在。這一點有賴某種人生經驗才能夠了解,因為當你努力讓某一段程序代碼變得比較優雅時,你並不是處於一種具生產力的狀態下。但是,請抗拒那些催促你趕工的人們,因為那麼做只會減緩你的速度罷了。
2. 先求能動,再求快。
即使你已確定某段程序代碼極為重要,而且是系統的重要瓶頸,這個准則依然成立。盡可能簡化設計,讓系統能夠先正確動作。如果程序的執行不夠快,再量測其效能。幾乎你總是會發現,你所認為的」瓶頸」其實都不是問題所在。把你的時間花在刀口上吧。
3. 記住」各個擊破」的原理。
如果你所探討的問題過於混雜,試著想像該問題的基本動作會是什麼,並假設這一小塊東西能夠神奇地處理掉最難的部分。這」一小塊」東西其實就是對象–請撰寫運用該對象的程序代碼,然後檢視對象,並將其中困難的部分再包裝成其他對象,依此類推。
4. 區分class開發者和class使用者(使用端程序員)。
Class 使用者扮演著」客戶」角色,不需要(也不知道)class的底層運作方式。Class開發者必須是class設計專家,並撰寫class,使它能夠盡可能被大多數新手程序員所用,而且在程序中能夠穩當執行。一套程序庫只有在具備通透性的情況下,使用起來才會容易。
5.當你撰寫class時,試著給予明了易懂的名稱,減少不必要的註解。
你給客戶端程序員的介面,應該保持概念上的單純性。不了這個目的,當函數的重載(overloading)適合製作出直覺、易用的介面時,請善加使用。
6. 也必你的分析和設計必須讓系統中的classes保持最少,須讓其Public interfaces保持最少,以及讓這些classes和其他classes之間的關聯性( 尤其是base classes)保持最少。
如果你的設計所得結果更甚於此,請問問自己,是否其中每一樣東西在整個程序生命期中都饒富價值?如果並非如此,那麼,維護它們會使你付出代價。開發團隊的成員都有不維護」無益於生產力提升」的任何東西的傾向;這是許多設計方法無法解釋的現象。
7. 讓所有東西盡量自動化。先撰寫測試用的程序代碼(在你撰寫class之前),並讓它和class結合在一起。請使用makefile或類似工具,自動進行測試動作。
通過這種方式,只要執行測試程序,所有的程序變動就可以自動獲得驗證,而且可以立即發現錯誤。由於你知道的測試架構所具備的安全性,所以當你發現新的需求時,你會更勇於進行全面修改。請記住,程序語言最大的改進,是來自型別檢查、異常處理等機制所賦予的內置測試動作。但這些功能只能協助你到達某種程度。開發一個穩固系統時,你得自己驗證自己的classes或程序的性質。
8. 在你撰寫class之前先寫測試碼,以便驗證你的class 是否設計完備。如果你無法撰寫測試碼,你便無法知道你的class 的可能長相。撰寫測試碼通常能夠顯現出額外的特性(features)或限制 ( constraints)__它們並不一定總是能夠在分析和設計過程中出現。測試碼也可做為展示class 用法的示常式序。
9. 所有軟體設計上的問題,都可以通過」引入額外的概念性間接層(conceptual indirection)」加以簡化。這個軟體工程上的基礎法則是抽象化概念的根據,而抽象化概念正是面向對象程序設計的主要性質。
10. 間接層(indirection)應該要有意義(和准則-9致)。
這里所指的意義可以像」將共用程序代碼置於惟一函數」這么簡單。如果你加入的間接層(或抽象化、或封裝等等)不具意義,它可能就和沒有適當的間接層一樣糟糕。
11. 讓class盡可能微小而無法切割(atomic)。
賦予每個class單一而清楚的用途。如果你的classes或你的系統成長得過於復雜,請將復雜的classes切割成比較簡單的幾個classes。最明顯的一個判斷指針就是class的大小:如果它很大,那麼它工作量過多的機會就可能很高,那就應該被切割。重新設計class的建議線索是:
1) 復雜的switch語句:請考慮運用多態(Polymorphism)。
2) 許多函數各自處理類型極為不同的動作:請考慮切割為多個不同的(classes)。
12. 小心冗長的引數列(argument lists)。
冗長的引數列會使函數的調用動作不易撰寫、閱讀、維護。你應該試著將函數搬移到更適當的class中,並盡量以對象為引數。
13. 不要一再重復。
如果某段程序代碼不斷出現於許多derived class函數中,請將該段程序代碼置於某個base class 函數內,然後在derived class函數中調用。這么做不僅可以省下程序代碼空間,也可以讓修改該段程序代碼動作更易於進行。有時候找出此種共通程序代碼還可以為介面增加實用功能。
14. 小心switch語句或成串的if-else 子句。
通常這種情況代表所謂的」type-check coding」。也就是說究竟會執行哪一段程序代碼,乃是依據某種型別信息來做抉擇(最初,確切型別可能不十分明顯)。你通常可以使用繼承和多態來取代此類程序代碼;Polymorphical method (多態函數)的調用會自動執行此類型別檢驗,並提供更可靠更容易的擴充性。
15. 從設計觀點來看,請找出變動的事物,並使它和不變的事物分離。
也就是說,找出系統中可能被你改變的元素,將它們封裝於classes中。你可以在《Thinking in Patterns with Java》(可免費下載於 www. BruceEckel. Com)大量學習到這種觀念。
16. 不要利用subclassing來擴充基礎功能。
如果某個介面元素對class而言極重要,它應該被放在base class 里頭,而不是直到衍生(derivation)時才被加入。如果你在繼承過程中加入了函數,或許你應該重新思考整個設計。
17. 少就是多。
從class 的最小介面開始妨展,盡可能在解決問題的前提下讓它保持既小又單純。不要預先考量你的class被使用的所有可能方式。一旦class被實際運用,你自然會知道你得如何擴充介面。不過,一旦class被使用後,你就無法在不影響客戶程序代碼的情況下縮減其介面。如果你要加入更多函數倒是沒有問題–不會影響既有的客戶程序代碼,它們只需重新編譯即可。但即使新函數取代了舊函數的功能,也請你保留既有介面。如果你得通過」加入更多引數」的方式來擴充既有函數的介面,請你以新引數寫出一個重載化的函數;通過 這種方式就不會影響既有函數的任何客戶了。
18. 大聲念出你的classes,確認它們符合邏輯。
請base class和derived class 之間的關系是」is-a」(是一種),讓class和成員對象之間的關系是」has-a」(有一個)。
19. 當你猶豫不決於繼承(inheritance)或合成(組合,composition)時,請你問問自己,是否需要向上轉型(upcast)為基礎型別。
如果不需要,請優先選擇合成(也就是是使用成員對象)。這種作法可以消除」過多基礎型別」。如果你採用繼承,使用者會認為他們應該可以向上轉型。
20. 運用數據成員來表示數值的變化,運用經過覆寫的函數(overrided method)來代錶行為的變化 。
也就是說,如果你找到了某個 class, 帶有一些狀態變數,而其函數會依據這些變數值切換不同的行為,那麼你或許就應該重新設計,在subclasses 和覆寫後的函數(overrided methods)中展現行為止的差異。
21. 小心重載(overloading)。
函數不應該依據引數值條件式地選擇執行某一段程序代碼。這種情況下你應該撰寫兩個或更多個重載函數(overloaded methods)
22. 使用異常體系(exception hierarchies)
最好是從Java標准異常體系中衍生特定的classes, 那麼,捕捉異常的人便可以捕捉特定異常,之後才捕捉基本異常。如果你加入新的衍生異常,原有的客戶端程序仍能通過其基礎型別來捕捉它。
23. 有時候簡單的聚合(aggregation)就夠了。
飛機上的」旅客舒適系統」包括數個分離的元素:座椅、空調、視訊設備等等,你會需要在飛機上產生許多這樣的東西。你會將它們聲明為Private成員並開發出一個全新的介面嗎?不會的,在這個例子中,元素也是Public介面的一部分,所以仍然是安全的。當然啦,簡單聚合並不是一個常被運用的解法,但有時候的確是。
24. 試著從客戶程序員和程序維護的角度思考。
你的class應該設計得盡可能容易使用。你應該預先考量可能性有的變動,並針對這些 可能的變動進行設計,使這些變動日後可輕易完成。
25. 小心」巨大對象並發症」。
這往往是剛踏OOP領域的過程式(proceral)程序員的一個苦惱,因為他們往往最終還是寫出一個過程式程序,並將它們擺放到一個或兩個巨大對象中。注意,除了application framework (應用程序框架,譯註:一種很特殊的、大型OO程序庫,幫你架構程序本體)之外,對象代表的是程序中的觀念,而不是程序本身。
26. 如果你得用某種醜陋的方式來達成某個動作,請將醜陋的部分局限在某個class里頭。
27. 如果你得用某種不可移植方式來達成某個動作,請將它抽象化並局限於某個class里頭。這樣一個」額外間接層」能夠防止不可移植的部分擴散到整個程序。這種作法的具體呈現便是Bridge設計模式(design pattern)。
28. 對象不應僅僅只用來持有數據。
對象也應該具有定義明確界限清楚的行為。有時候使用」數據對象」是適當的,但只有在通用形容器不適用時,才適合刻意以數據對象來包裝、傳輸一群數據項。
29. 欲從既有的classes身上產生新的classes時,請以組合(composition)為優先考量。
你應該只在必要時才使用繼承。如果在組合適用之處你卻選擇了繼承,你的設計就滲雜了非必要的復雜性。
30. 運用繼承和函數覆寫機制來展現行為上的差異,運用fields(數據成員)來展現狀態上的差異。
這句話的極端例子,就是繼承出不同的classes表現各種不同的顏色,而不使用」color」field.
31. 當心變異性(variance)。
語意相異的兩個對象擁有相同的動作(或說責任)是可能的。OO世界中存在著一種天生的引誘,讓人想要從某個class繼承出另一個subclass,為的是獲得繼承帶來的福利。這便是所謂」變異性」。但是,沒有任何正當理由足以讓我們強迫製造出某個其實並不存在的superclass/subclass關系。比較好的解決方式是寫出一個共用的base class,它為兩個derived classes製作出共用介面–這種方式會耗用更多空間,但你可以如你所盼望地從繼承機制獲得好處,而且或許能夠在設計上獲得重大發現。
32. 注意繼承上的限制。
最清晰易懂的設計是將功能加到繼承得來的class里頭;繼承過程中拿掉舊功能(而非增加新功能)則是一種可疑的設計。不過,規則可以打破。如果你所處理的是舊有的class程序庫,那麼在某個class的subclass限制功能,可能會比重新制定整個結構(俾使新class得以良好地相稱於舊 class)有效率得多。
33. 使用設計模式(design patterns)來減少」赤裸裸無加掩飾的機能(naked functionality)」。
舉個例子,如果你的class只應該產出惟一一個對象,那麼請不要以加思索毫無設計的手法來完成它,然後撰寫」只該產生一份對象」這樣的註解就拍拍屁股走人。請將它包裝成singleton(譯註:一個有名的設計模式,可譯為」單件」)。如果主程序中有多而混亂的」用以產生對象」的程序代碼,請找出類似 factory method這樣的生成模式(creational patterns),使價錢可用以封裝生成動作減少」赤裸裸無加掩飾的機能」(naked functionality)不僅可以讓你的程序更易理解和維護,也可以阻止出於好意卻帶來意外的維護者。
34. 當心」因分析而導致的癱瘓(analysis paralysis)」。
請記住,你往往必須在獲得所有信息之前讓項目繼續前進。而且理解未知部分的最好也最快的方式,通常就是實際前進一步而不只是紙上談兵。除非找到解決辦法,否則無法知道解決辦法。Java擁有內置的防火牆,請讓它們發揮作用。你在單一class或一組classes中所犯的錯誤,並不會傷害整個系統的完整性。
35. 當你認為你已經獲得一份優秀的分析、設計或實現時,請試著加以演練。
將團隊以外的某些人帶進來-他不必非得是個顧問不可,他可以是公司其他團隊的成員。請那個人以新鮮的姿態審視你們的成果,這樣可以在尚可輕易修改的階段找出問題,其收獲會比因演練而付出的時間和金錢代價來得高。實現 (Implementation)
36. 一般來說,請遵守Sun的程序編寫習慣。
價錢可以在以下網址找到相關文檔:java.sun.com/docs/codeconv/idex.html。本書盡可能遵守這些習慣。眾多Java程序員看到的程序代碼,都有是由這些習慣構成的。如果你固執地停留在過去的編寫風格中,你的(程序代碼)讀者會比較辛苦。不論你決定採用什麼編寫習慣,請在整個程序中保持一致。你可以在home.wtal.de/software-solutions/jindent上找到一個用來重排Java程序的免費工具。
37. 無論使用何種編寫風格,如果你的團隊(或整個公司,那就更好了)能夠加以標准化,那麼的確會帶來顯著效果。這代表每個人都可以在其他人不遵守編寫風格修改其作品,這是個公平的游戲。標准化的價值在於,分析程序代碼時所花的腦力較小,因而可以專心於程序代碼的實質意義。
38. 遵守標準的大小寫規范。
將 class名稱的第一個字母應為大寫。數據成員、函數、對象(references)的第一個字母應為小寫。所有識別名稱的每個字都應該連在一塊兒,所有非首字的第一個字母都應該大寫。例如: ThisIsAClassName thisIsAMethodOrFieldName 如果你在static final 基本型別的定義處指定了常量初始式(constant initializers),那麼該識別名稱應該全為大寫,代表一個編譯期常量。 Packages是個特例,其名稱皆為小寫,即使非首字的字母亦是如此。域名(org, net, e 等等)皆應為小寫。(這是Java 1.1遷移至Java 2時的一項改變) 。
39、不要自己發明」裝飾用的」Private數據成員名稱。
通常這種的形式是在最前端加上底線和其他字元,匈牙利命名法(Hungarian notation)是其中最差的示範。在這種命名法中,你得加入額外字元來表示數據的型別、用途、位置等等。彷彿你用的是匯編語言(assembly language)而編譯器沒有提供任何協肋似的。這樣的命名方式容易讓人混淆又難以閱讀,也不易推行和維護。就讓classes和packages來進行」名稱上的范
圍制定(name scoping)」吧。
40、當你擬定通用性的class時,請遵守正規形式(canonical form)。
包括equals( )、hashCode( )、clone( ) ( 實現出Cloneable),並實現出Comparable和Serialiable等等。
41、對於那些」取得或改變Private數據值」的函數,請使用Java Beans 的」get」、」set」、」is」等命名習慣,即使你當時不認為自己正在撰寫Java Bean。這么做不僅可以輕易以Bean的運用方式來運用你的class,也是對此類函數的一種標准命名方式,使讀者更易於理解。
42、對於你所擬定的每一個class,請考慮為它加入static public test( ),其中含有class功能測試碼。
你不需要移除該測試就可將程序納入項目。而且如果有所變動,你可以輕易重新執行測試。這段程序代碼也可以做為class的使用示例。
43、有時候你需要通過繼承,才得以訪問base class的protected成員。
這可能會引發對多重基類(multiple base types)的認識需求。如果你不需要向上轉型,你可以先衍生新的class發便執行protected訪問動作,然後在」需要用到上述 protected成員」的所有classes中,將新class聲明為成員對象,而非直接繼承。
44、避免純粹為了效率考量而使用final函數。
只有在程序能動但執行不夠快時,而且效能量測工具(profiler)顯示某個函數的調用動作成為瓶頸時,才使用final函數。
45、如果兩個classes因某種功能性原因而產生了關聯(例如容器containers和迭代器iterators),那麼請試著讓其中某個class成為另一個class 的內隱類(inner class)。
這不僅強調二者間的關聯,也是通過」將class名稱嵌套置於另一個class 內」而使同一個class 名稱在單一Package中可被重復使用。Java 容器庫在每個容器類中都定義了一個內隱的(inner)Iterator class,因而能夠提供容器一份共通介面。運用內隱類的另一個原因是讓它成為private實現物的一部分。在這里,內隱類會為信息隱藏帶來好處,而不是對上述的class關聯性提供肋益,也不是為了防止命名空間污染問題(namespace pollution)。
46、任何時候你都要注意那些高度耦合(coupling)的 classes.請考慮內隱類(inner classes)為程序擬定和維護帶來的好處。內隱類的使用並不是要去除classes間的耦合,而是要讓耦合關系更明顯也更便利。
47、不要成為」過早最佳化」的犧牲品。
那會讓人神經錯亂。尤其在系統建構初期,先別煩惱究竟要不要撰寫(或避免)原生函數(native methods)、要不要將某些數聲明為final、要不要調校程序代碼效率等等。你的主要問題應該是先證明設計的正確性,除非設計本身需要某種程度的效率。
48、讓范圍(作用域,scope)盡可能愈小愈好,這么一來對象的可視范圍和壽命都將盡可能地小。
這種作法可降低」對象被用於錯誤場所,因而隱藏難以察覺的臭蟲」的機會。假設你有個容器,以及一段走訪該容器的程序片段。如果你復制該段程序代碼,將它用於新的容器身上,你可能會不小心以舊容器的大小做為新容器的走訪上限值。如果舊容器已不在訪問范圍內,那麼編譯期便可找出這樣的錯誤。
49、使用Java 標准程序庫提供的容器。
請熟悉他們的用法。你將因此大幅提升你的生產力。請優先選擇ArrayList來處理序列(sequences),選擇HashSet來處理集合(sets)、選擇HashMap來處理關聯式數組(associative arrays),選擇Linkedlist (而不是Stack) 來處理 shacks和queues。
50、對一個強固的(robust)程序而言,每一個組成都必須強固。
請在你所撰寫的每個class中運用Java 提供的所有強固提升工具:訪問許可權、異常、型別檢驗等等。通過這種方式,你可以在建構系統時安全地移往抽象化的下一個層次。
51、寧可在編譯期發生錯誤,也不要在執行期發生錯誤。
試著在最靠近問題發生點的地方處理問題。請優先在」擲出異常之處」處理問題,並在擁有足夠信息以處理異常的最接近處理函數(handler)中捕捉異常。請進行現階段你能夠對該異常所做的處理;如果你無法解決問題,應該再次擲出異常。
52、當心冗長的函數定義。
函數應該是一種簡短的、」描述並實現class介面中某個可分離部分」的功能單元。過長且復雜的函數不僅難以維護,維護代價也高。或許它嘗試做太多事情了。如果你發現這一類函數,代表它應該被切割成多相函數。這種函數也提醒你或許得撰寫新的class。小型函數同樣能夠在你的class中被重復運用。(有時候函數必須很大才行,但它們應該只做一件事情。)
53、盡可能保持」Private」。
一旦你對外公開了程序庫的概況(method、Class 或field)。你便再也無法移除它們。因為如果移除它們,便會破壞某個現有的程序代碼,使得它們必須重新被編寫或重新設計。如果你只公開必要部分,那麼你便可以改變其他東西而不造成傷害。設計總是會演化,所以這是個十分重要的自由度。通過這種方式,實現碼的更動對derived class 造成的沖擊會降最低。在多線程環境下,私密性格外重要-只有private數據可受保護而不被un-synchronized(未受同步控制)的運用所破壞。
54、大量運用註解,並使用javadoc的」註解文檔語法」來產生程序的說明文檔。
不過註解應該賦予程序代碼真正的意義;如果只是重申程序代碼已經明確表示的內容,那是很煩人的。請注意,通常Java class和其函數的名稱都很長,為的便是降低註解量。
55、避免使用」魔術數字」,也就是那種寫死在程序代碼里頭的數字–如果你想改變它們,它們就會成為你的惡夢,因為你永遠都沒有辦法知道」100″究竟代表」 數組大小」或其他東西。你應該產生具描述性的常量度名稱,並在程序中使用該常量名稱。這使程序更易於理解也更易於維護。
56、撰寫構造函數時,請考慮異常狀態。最好情境下,構造函數不執行任何會擲出異常的動作。
次佳情境下,class 只繼承自(或合成自)強固的(robust)classes,所以如有任何異常被擲出,並不需要清理。其他情況下,你就得在finally子句清理合成後的classes。如果某個構造函數一定會失敗,適當的動作就是擲出異常,使調用者不至於盲目認為對象已被正確產生而繼續執行。
57、如果你的class需要在」客戶程序員用完對象」後進行清理動作,請將清理動作,放到單一而定義明確的函數中。最好令其名稱為cleanup() 以便能夠將用途告訴他人。此外請將boolean旗標放到class中,用以代表對象是否已被清理,使finalize()得以檢驗其死亡條件(請參考第 4章)。
58、finalize() 只可用於對象死亡條件的檢驗(請參考4章),俾有益於調試。
特殊情況下可能需要釋放一些不會被垃圾回收的內存。因為垃圾回收器可能不會被喚起處理你的對象,所以你無法使用finalize()執行必要的清理動作。基於這個原因,你得擬定自己的」清理用」函數。在class finalize()中,請檢查確認對象的確已被清理,並在對象尚未被清理時,擲出衍生自Runtime Exception 的異常。使用這種架構前,請先確認finalize()在你的系統上可正常動作(這可能需要調用System.gc()來確認)。
59、如果某個對象在某個特定范圍(scope)內必須被清理(cleaned up),而不是被垃圾回收機制收回,請使用以下方法;將對象初始化,成功後立刻進入擁有finally子句的一個try區段內。Finally子句會引發清理動作。
60、當你在繼承過程中覆寫了finalize(),請記得調用super. Finalize()。
但如果你的」直接上一層superclass」是Object,,就不需要這個動作。你應該讓super.finalize() 成為被覆寫(overridden)之finalize()的最後一個動作而不是第一個動作,用以確保base class的組件在你需要它們的時候仍然可用。
61、當你撰寫固定大小的對象容器,請將它們轉換為數組–尤其是從某個函數返回此一容器時。
通過這種方式,你可以獲得數組的」編譯期型別檢驗」的好處,而且數組接收者可能不需要」先將數組中的對象加以轉型」便能加以使用。請注意,容器庫的base class (Java. Util. Collection) 具有兩個toArray(),能夠達到這個目的。
62、在interface(介面)和abstract class(抽象類)之間,優先選擇前者。
如果你知道某些東西即將被設計為一個base class,你的第一選擇應該是讓它成為interface;只有在一定得放進函數或數據成員時,才應該將它改為abstract class. Interface只和」客戶端想進行什麼動作」有關,class則比較把重心放在實現細節上。
63、在構造函數中只做惟一必要動作:將對象設定至適當狀態。
避免調用其他函數(除了final函數),因為這些函數可能會被其他人覆寫因而使你在建構過程中得不可預期的結果(請參考第7章以取得更詳細的信息)。小型而簡單的構造函數比較不可能擲出異常或引發問題。
64、為了避免一個十分令人泄氣的經驗,請確認你的classpath中的每個名稱,都只有一個未被放到packages里頭class。否則編譯器會先找到另一個名稱相同的class,並回報錯誤消息。如果你懷疑你的classpath出了問題,試著從classpath中的每個起點查找同名的.class文件。最好還是將所有classes都放到packages里頭。
65、留意一不小心犯下的重載(overloading)錯誤。
如果你覆寫base class 函數時沒有正確拼寫其名稱,那麼便會增加一個新的函數,而不是覆寫原有的函數。但是情況完全合法,所以你不會從編譯器或執行期系統得到任何錯誤消息–你的程序代碼只是無法正確作用,如此而已。
66、當心過早最佳化。
先讓程序動起來,再讓它快–但只有在你必須(也就是說只有在程序被證明在某段程序代碼上遭遇效能瓶頸)時才這么做。除非你已經使用效能量測工具(profiler)找出瓶頸所在,否則你可能性只是在浪費你的時間。效能調校的」隱藏成本」便是讓你的程序代碼變得更不可讀、更難維持。
67、記住,程序代碼被閱讀的時間多於它被撰寫的時間。
清晰的設計能夠製作出去易懂的程序。註解、細節說明、示例都是無價的。這些東西能夠幫助你和你的後繼者。如果沒有其他信息,那麼Java 線上文檔找出一些有用的信息時,你所遭遇的挫敗應該足以讓你相信這一點。