入門(1-2 個月)
創(chuàng)新互聯(lián)建站-專業(yè)網(wǎng)站定制、快速模板網(wǎng)站建設(shè)、高性價比深圳網(wǎng)站開發(fā)、企業(yè)建站全套包干低至880元,成熟完善的模板庫,直接使用。一站式深圳網(wǎng)站制作公司更省心,省錢,快速模板網(wǎng)站建設(shè)找我們,業(yè)務(wù)覆蓋深圳地區(qū)。費用合理售后完善,10余年實體公司更值得信賴。
目標(biāo):參與簡單的項目開發(fā)。
技能:
熟練使用一種 IDE。Intellij IDEA或者 Eclipse 都可以,推薦使用前者。至少熟悉常用的快捷鍵,會 debug(包括遠(yuǎn)程 debug)項目。
熟悉一種編輯器。比如 Vim/Emacs/Sublime Text,至少學(xué)會搜索/替換/代碼補全。
掌握 Java。經(jīng)典的《Java 核心技術(shù):卷1 基礎(chǔ)知識》(或者《Java基礎(chǔ)教程301集》《Java 編程思想》)必看,跳過其中的圖形和 applet 章節(jié)。習(xí)慣查閱 Java API Doc。為了保證代碼的質(zhì)量,《Effective Java》、《Clean Code》和《重構(gòu)》也需要至少通讀一遍。
熟悉 Linux 開發(fā)環(huán)境和 bash shell。Linux 是我們的開發(fā)和部署環(huán)境,你最好盡快熟練它。Linux 的基本使用可以通過《鳥哥的Linux私房菜:基礎(chǔ)學(xué)習(xí)篇(第三版)》學(xué)習(xí),開發(fā) bash shell 腳本可以參考《Linux Shell腳本攻略》。
掌握開發(fā)工具
掌握 JDK 以外的常用類庫和工具包。JDK 原生 API 在很多場景下使用并不方便。你需要掌握社區(qū)貢獻(xiàn)的優(yōu)秀類庫和工具包,比如 apache commons、google guava 等,具體可以翻閱 服務(wù)端技術(shù)選型 的Utility 篇。
掌握 Web 開發(fā)框架。我們使用 Spring(或Rose) + Ibatis(或Jade) 開發(fā) web 服務(wù),你需要熟練掌握它們。
學(xué)習(xí)代碼規(guī)范。我們大致上遵循 oracle 的 Java 語言編碼規(guī)范,你可以先閱讀并熟悉它。Code Formatting 文件在 git@xxx/coding-standard.git,在編寫代碼之前,請把它導(dǎo)入到 IDE 中。另外,確認(rèn) IDE 已經(jīng)安裝 Findbugs 和 CheckStyle 插件。
熟悉開發(fā)流程。我們的開發(fā)流程大致如下:功能開發(fā)-單元測試-功能測試-Code Review-集成測試-發(fā)布。確保你熟悉其中的每個環(huán)節(jié)。
其他。需要熟練使用版本控制工具 Git(閱讀:《Git 權(quán)威指南》),以及項目構(gòu)建工具 Maven(閱讀:《Maven 實戰(zhàn)》)。另外,在這個階段可以嘗試 TDD 開發(fā)。
1_代碼重構(gòu)漫畫.jpeg
項目在不斷演進(jìn)過程中,代碼不停地在堆砌。如果沒有人為代碼的質(zhì)量負(fù)責(zé),代碼總是會往越來越混亂的方向演進(jìn)。當(dāng)混亂到一定程度之后,量變引起質(zhì)變,項目的維護(hù)成本已經(jīng)高過重新開發(fā)一套新代碼的成本,想要再去重構(gòu),已經(jīng)沒有人能做到了。
造成這樣的原因往往有以下幾點:
對于此類問題,業(yè)界已有有很好的解決思路:通過持續(xù)不斷的重構(gòu)將代碼中的“壞味道”清除掉。
重構(gòu)一書的作者M(jìn)artin Fowler對重構(gòu)的定義:
根據(jù)重構(gòu)的規(guī)??梢源笾路譃榇笮椭貥?gòu)和小型重構(gòu):
大型重構(gòu) :對頂層代碼設(shè)計的重構(gòu),包括:系統(tǒng)、模塊、代碼結(jié)構(gòu)、類與類之間的關(guān)系等的重構(gòu),重構(gòu)的手段有:分層、模塊化、解耦、抽象可復(fù)用組件等等。這類重構(gòu)的工具就是我們學(xué)習(xí)過的那些設(shè)計思想、原則和模式。這類重構(gòu)涉及的代碼改動會比較多,影響面會比較大,所以難度也較大,耗時會比較長,引入bug的風(fēng)險也會相對比較大。
小型重構(gòu) :對代碼細(xì)節(jié)的重構(gòu),主要是針對類、函數(shù)、變量等代碼級別的重構(gòu),比如規(guī)范命名和注釋、消除超大類或函數(shù)、提取重復(fù)代碼等等。小型重構(gòu)更多的是使用統(tǒng)一的編碼規(guī)范。這類重構(gòu)要修改的地方比較集中,比較簡單,可操作性較強,耗時會比較短,引入bug的風(fēng)險相對來說也會比較小。什么時候重構(gòu) 新功能開發(fā)、修bug或者代碼review中出現(xiàn)“代碼壞味道”,我們就應(yīng)該及時進(jìn)行重構(gòu)。持續(xù)在日常開發(fā)中進(jìn)行小重構(gòu),能夠降低重構(gòu)和測試的成本。
2_代碼常見問題.png
代碼重復(fù)
方法過長
過大的類
邏輯分散
嚴(yán)重的情結(jié)依戀
數(shù)據(jù)泥團(tuán)/基本類型偏執(zhí)
不合理的繼承體系
過多的條件判斷
過長的參數(shù)列
臨時變量過多
令人迷惑的暫時字段
純數(shù)據(jù)類
不恰當(dāng)?shù)拿?/p>
過多的注釋
3_代碼質(zhì)量如何衡量.jpg
代碼質(zhì)量的評價有很強的主觀性,描述代碼質(zhì)量的詞匯也有很多,比如可讀性、可維護(hù)性、靈活、優(yōu)雅、簡潔。這些詞匯是從不同的維度去評價代碼質(zhì)量的。其中,可維護(hù)性、可讀性、可擴展性又是提到最多的、最重要的三個評價標(biāo)準(zhǔn)。
要寫出高質(zhì)量代碼,我們就需要掌握一些更加細(xì)化、更加能落地的編程方法論,這就包含面向?qū)ο笤O(shè)計思想、設(shè)計原則、設(shè)計模式、編碼規(guī)范、重構(gòu)技巧等。
4_SOLID原則.png
一個類只負(fù)責(zé)完成一個職責(zé)或者功能,不要存在多于一種導(dǎo)致類變更的原因。
單一職責(zé)原則通過避免設(shè)計大而全的類,避免將不相關(guān)的功能耦合在一起,來提高類的內(nèi)聚性。同時,類職責(zé)單一,類依賴的和被依賴的其他類也會變少,減少了代碼的耦合性,以此來實現(xiàn)代碼的高內(nèi)聚、松耦合。但是,如果拆分得過細(xì),實際上會適得其反,反倒會降低內(nèi)聚性,也會影響代碼的可維護(hù)性。
添加一個新的功能,應(yīng)該是通過在已有代碼基礎(chǔ)上擴展代碼(新增模塊、類、方法、屬性等),而非修改已有代碼(修改模塊、類、方法、屬性等)的方式來完成。
開閉原則并不是說完全杜絕修改,而是以最小的修改代碼的代價來完成新功能的開發(fā)。
很多設(shè)計原則、設(shè)計思想、設(shè)計模式,都是以提高代碼的擴展性為最終目的的。特別是 23 種經(jīng)典設(shè)計模式,大部分都是為了解決代碼的擴展性問題而總結(jié)出來的,都是以開閉原則為指導(dǎo)原則的。最常用來提高代碼擴展性的方法有:多態(tài)、依賴注入、基于接口而非實現(xiàn)編程,以及大部分的設(shè)計模式(比如,裝飾、策略、模板、職責(zé)鏈、狀態(tài))。
子類對象(object of subtype/derived class)能夠替換程序(program)中父類對象(object of base/parent class)出現(xiàn)的任何地方,并且保證原來程序的邏輯行為(behavior)不變及正確性不被破壞。
子類可以擴展父類的功能,但不能改變父類原有的功能
調(diào)用方不應(yīng)該依賴它不需要的接口;一個類對另一個類的依賴應(yīng)該建立在最小的接口上。接口隔離原則提供了一種判斷接口的職責(zé)是否單一的標(biāo)準(zhǔn):通過調(diào)用者如何使用接口來間接地判定。如果調(diào)用者只使用部分接口或接口的部分功能,那接口的設(shè)計就不夠職責(zé)單一。
高層模塊不應(yīng)該依賴低層模塊,二者都應(yīng)該依賴其抽象;抽象不應(yīng)該依賴細(xì)節(jié),細(xì)節(jié)應(yīng)該依賴抽象。
一個對象應(yīng)該對其他對象保持最少的了解
盡量使用合成/聚合的方式,而不是使用繼承。
單一職責(zé)原則告訴我們實現(xiàn)類要職責(zé)單一;里氏替換原則告訴我們不要破壞繼承體系;依賴倒置原則告訴我們要面向接口編程;接口隔離原則告訴我們在設(shè)計接口的時候要精簡單一;迪米特法則告訴我們要降低耦合。而開閉原則是總綱,告訴我們要對擴展開放,對修改關(guān)閉。
image.png
模塊結(jié)構(gòu)說明
代碼開發(fā)要遵守各層的規(guī)范,并注意層級之間的依賴關(guān)系。
多個方法代碼重復(fù)、方法中代碼過長或者方法中的語句不在一個抽象層級。
方法是代碼復(fù)用的最小粒度,方法過長不利于復(fù)用,可讀性低,提煉方法往往是重構(gòu)工作的第一步。
意圖導(dǎo)向編程 :把處理某件事的流程和具體做事的實現(xiàn)方式分開。
將函數(shù)放進(jìn)一個單獨對象中,如此一來局部變量就變成了對象內(nèi)的字段。然后你可以在同一個對象中將這個大型函數(shù)分解為多個小型函數(shù)。
方法參數(shù)比較多時,將參數(shù)封裝為參數(shù)對象
任何有返回值的方法,都不應(yīng)該有副作用
臨時變量僅使用一次或者取值邏輯成本很低的情況下
將復(fù)雜表達(dá)式(或其中一部分)的結(jié)果放進(jìn)一個臨時變量,以此變量名稱來解釋表達(dá)式用途
把復(fù)雜的條件表達(dá)式拆分成多個條件表達(dá)式,減少嵌套。嵌套了好幾層的if - then-else語句,轉(zhuǎn)換為多個if語句
當(dāng)出現(xiàn)大量類型檢查和判斷時,if else(或switch)語句的體積會比較臃腫,這無疑降低了代碼的可讀性。 另外,if else(或switch)本身就是一個“變化點”,當(dāng)需要擴展新的類型時,我們不得不追加if else(或switch)語句塊,以及相應(yīng)的邏輯,這無疑降低了程序的可擴展性,也違反了面向?qū)ο蟮拈_閉原則。
非正常業(yè)務(wù)狀態(tài)的處理,使用拋出異常的方式代替返回錯誤碼
某一段代碼需要對程序狀態(tài)做出某種假設(shè),以斷言明確表現(xiàn)這種假設(shè)。
當(dāng)使用一個方法返回的對象時,而這個對象可能為空,這個時候需要對這個對象進(jìn)行操作前,需要進(jìn)行判空,否則就會報空指針。當(dāng)這種判斷頻繁的出現(xiàn)在各處代碼之中,就會影響代碼的美觀程度和可讀性,甚至增加Bug的幾率。
空引用的問題在Java中無法避免,但可以通過代碼編程技巧(引入空對象)來改善這一問題。
根據(jù)單一職責(zé)原則,一個類應(yīng)該有明確的責(zé)任邊界。但在實際工作中,類會不斷的擴展。當(dāng)給某個類添加一項新責(zé)任時,你會覺得不值得分離出一個單獨的類。于是,隨著責(zé)任不斷增加,這個類包含了大量的數(shù)據(jù)和函數(shù),邏輯復(fù)雜不易理解。
此時你需要考慮將哪些部分分離到一個單獨的類中,可以依據(jù)高內(nèi)聚低耦合的原則。如果某些數(shù)據(jù)和方法總是一起出現(xiàn),或者某些數(shù)據(jù)經(jīng)常同時變化,這就表明它們應(yīng)該放到一個類中。另一種信號是類的子類化方式:如果你發(fā)現(xiàn)子類化只影響類的部分特性,或者類的特性需要以不同方式來子類化,這就意味著你需要分解原來的類。
繼承使實現(xiàn)代碼重用的有力手段,但這并非總是完成這項工作的最佳工具,使用不當(dāng)會導(dǎo)致軟件變得很脆弱。與方法調(diào)用不同的是,繼承打破了封裝性。子類依賴于其父類中特定功能的實現(xiàn)細(xì)節(jié),如果父類的實現(xiàn)隨著發(fā)行版本的不同而變化,子類可能會遭到破壞,即使他的代碼完全沒有改變。
舉例說明,假設(shè)有一個程序使用HashSet,為了調(diào)優(yōu)該程序的性能,需要統(tǒng)計HashSet自從它創(chuàng)建以來添加了多少個元素。為了提供該功能,我們編寫一個HashSet的變體。
通過在新的類中增加一個私有域,它引用現(xiàn)有類的一個實例,這種設(shè)計被稱為組合,因為現(xiàn)有的類變成了新類的一個組件。這樣得到的類將會非常穩(wěn)固,它不依賴現(xiàn)有類的實現(xiàn)細(xì)節(jié)。即使現(xiàn)有的類添加了新的方法,也不會影響新的類。許多設(shè)計模式使用就是這種套路,比如代理模式、裝飾者模式
繼承與組合如何取舍
Java提供了兩種機制,可以用來定義允許多個實現(xiàn)的類型:接口和抽象類。自從Java8為接口增加缺省方法(default method),這兩種機制都允許為實例方法提供實現(xiàn)。主要區(qū)別在于,為了實現(xiàn)由抽象類定義的類型,類必須稱為抽象類的一個子類。因為Java只允許單繼承,所以用抽象類作為類型定義受到了限制。
接口相比于抽象類的優(yōu)勢:
接口雖然提供了缺省方法,但接口仍有有以下局限性:
接口缺省方法的設(shè)計目的和優(yōu)勢在于:
為了接口的演化
可以減少第三方工具類的創(chuàng)建
可以避免創(chuàng)建基類
由于接口的局限性和設(shè)計目的的不同,接口并不能完全替換抽象類。但是通過對接口提供一個抽象的骨架實現(xiàn)類,可以把接口和抽象類的優(yōu)點結(jié)合起來。 接口負(fù)責(zé)定義類型,或許還提供一些缺省方法,而骨架實現(xiàn)類則負(fù)責(zé)實現(xiàn)除基本類型接口方法之外,剩下的非基本類型接口方法。擴展骨架實現(xiàn)占了實現(xiàn)接口之外的大部分工作。這就是模板方法(Template Method)設(shè)計模式。
Image [5].png
接口Protocol:定義了RPC協(xié)議層兩個主要的方法,export暴露服務(wù)和refer引用服務(wù)
抽象類AbstractProtocol:封裝了暴露服務(wù)之后的Exporter和引用服務(wù)之后的Invoker實例,并實現(xiàn)了服務(wù)銷毀的邏輯
具體實現(xiàn)類XxxProtocol:實現(xiàn)export暴露服務(wù)和refer引用服務(wù)具體邏輯
由于為了保持Java代碼的兼容性,支持和原生態(tài)類型轉(zhuǎn)換,并使用擦除機制實現(xiàn)的泛型。但是使用原生態(tài)類型就會失去泛型的優(yōu)勢,會受到編譯器警告。
每一條警告都表示可能在運行時拋出ClassCastException異常。要盡最大的努力去消除這些警告。如果無法消除但是可以證明引起警告的代碼是安全的,就可以在盡可能小的范圍中,使用@SuppressWarnings("unchecked")注解來禁止警告,但是要把禁止的原因記錄下來。
參數(shù)化類型不支持協(xié)變的,即對于任何兩個不同的類型Type1和Type2而言,List既不是List的子類型,也不是它的超類。為了解決這個問題,提高靈活性,Java提供了一種特殊的參數(shù)化類型,稱作有限制的通配符類型,即List? extends E和List? super E。使用原則是producer-extends,consumer-super(PECS)。如果即是生產(chǎn)者,又是消費者,就沒有必要使用通配符了。
還有一種特殊的無限制通配符List?,表示某種類型但不確定。常用作泛型的引用,不可向其添加除Null以外的任何對象。
嵌套類(nested class)是指定義在另一個類的內(nèi)部的類。 嵌套類存在的目的只是為了它的外部類提供服務(wù),如果其他的環(huán)境也會用到的話,應(yīng)該成為一個頂層類(top-level class)。 嵌套類有四種:靜態(tài)成員類(static member class)、非靜態(tài)成員類(nonstatic member class)、匿名類(anonymous class)和 局部類(local class)。除了第一種之外,其他三種都稱為內(nèi)部類(inner class)。
總而言之,這四種嵌套類都有自己的用途。假設(shè)這個嵌套類屬于一個方法的內(nèi)部,如果只需要在一個地方創(chuàng)建實例,并且已經(jīng)有了一個預(yù)置的類型可以說明這個類的特征,就要把它做成匿名類。如果一個嵌套類需要在單個方法之外仍然可見,或者它太長了,不適合放在方法內(nèi)部,就應(yīng)該使用成員類。如果成員類的每個實例都需要一個指向其外圍實例的引用,就要把成員類做成非靜態(tài)的,否則就做成靜態(tài)的。
通過對常見場景的代碼邏輯進(jìn)行抽象封裝,形成相應(yīng)的模板工具類,可以大大減少重復(fù)代碼,專注于業(yè)務(wù)邏輯,提高代碼質(zhì)量。
面向?qū)ο缶幊滔鄬τ诿嫦蜻^程,多了實例化這一步,而對象的創(chuàng)建必須要指定具體類型。我們常見的做法是“哪里用到,就在哪里創(chuàng)建”,使用實例和創(chuàng)建實例的是同一段代碼。這似乎使代碼更具有可讀性,但是某些情況下造成了不必要的耦合。
對于頂層的(非嵌套的)類和接口,只有兩種的訪問級別:包級私有的(沒有public修飾)和公有的(public修飾)。
對于成員(實例/域、方法、嵌套類和嵌套接口)由四種的訪問級別,可訪問性如下遞增:
正確地使用這些修飾符對于實現(xiàn)信息隱藏是非常關(guān)鍵的,原則就是:盡可能地使每個類和成員不被外界訪問(私有或包級私有)。這樣好處就是在以后的發(fā)行版本中,可以對它進(jìn)行修改、替換或者刪除,而無須擔(dān)心會影響現(xiàn)有的客戶端程序。
不可變類是指其實例不能被修改的類。每個實例中包含的所有信息都必須在創(chuàng)建該實例時提供,并在對象的整個生命周期內(nèi)固定不變。不可變類好處就是簡單易用、線程安全、可自由共享而不容易出錯。Java平臺類庫中包含許多不可變的類,比如String、基本類型包裝類、BigDecimal等。
為了使類成為不可變,要遵循下面五條規(guī)則:
可變性最小化的一些建議:
TDD的最終目標(biāo)是整潔可用的代碼(clean code that works)。大多數(shù)的開發(fā)者大部分時間無法得到整潔可用的代碼。辦法是分而治之。首先解決目標(biāo)中的“可用”問題,然后再解決“代碼的整潔”問題。這與體系結(jié)構(gòu)驅(qū)動(architecture-driven)的開發(fā)相反。
采用TDD另一個好處就是讓我們擁有一套伴隨代碼產(chǎn)生的詳盡的自動化測試集。將來無論出于任何原因(需求、重構(gòu)、性能改進(jìn))需要對代碼進(jìn)行維護(hù)時,在這套測試集的驅(qū)動下工作,我們代碼將會一直是健壯的。
Image [6].png
添加一個測試 - 運行所有測試并檢查測試結(jié)果 - 編寫代碼以通過測試 - 運行所有測試且全部通過 - 重構(gòu)代碼,以消除重復(fù)設(shè)計,優(yōu)化設(shè)計結(jié)構(gòu)
作者:VectorJin
代碼重構(gòu)(英語:Code refactoring)重構(gòu)就是在不改變軟件系統(tǒng)外部行為的前提下,改善它的內(nèi)部結(jié)構(gòu)。
軟件重構(gòu)需要借助工具完成,重構(gòu)工具能夠修改代碼同時修改所有引用該代碼的地方。在極限編程的方法學(xué)中,重構(gòu)需要單元測試來支持。
java重構(gòu):指程序員對已有程序在盡量不改變接口的前提下,進(jìn)行重新編寫代碼的工作,一般有以下幾方面:
1、去除已知bug。
2、提高程序運行效率。
3、增加新的功能。
重構(gòu)舉例:(簡化代碼、提升效率)
重構(gòu)前:
if(list != null list.size() 0){
for(int i = 0; i list.size(); i++){
//skip...
}
}
重構(gòu)后
if(list != null){
for(int i = 0, len = list.size(); i len; i++){
//skip...
}
}
何時著手重構(gòu)(Refactoring)
新官上任三把火,開始一個全新??、腳不停蹄、加班加點,一支聲勢浩大的千軍萬"碼"夾裹著程序員激情和扣擊鍵盤的鳴金奮力前行,勢如破竹,攻城掠地,直指"黃龍府"。
開發(fā)經(jīng)理是這支浩浩湯湯代碼隊伍的統(tǒng)帥,他負(fù)責(zé)這支隊伍的命運,當(dāng)齊桓公站在山頂上看到管仲訓(xùn)練的隊伍整齊劃一地前進(jìn)時,他感嘆說"我有這樣一支軍隊哪里還怕沒有勝利呢?"。但很遺憾,你手中的這支隊伍原本只是散兵游勇,在前進(jìn)中招兵買馬,不斷壯大,所以隊伍變形在所難免。當(dāng)開發(fā)經(jīng)理發(fā)覺隊伍變形時,也許就是克制住攻克前方山頭的誘惑,停下腳步整頓隊伍的時候了。
Kent Beck提出了"代碼壞味道"的說法,和我們所提出的"隊伍變形"是同樣的意思,隊伍變形的信號是什么呢?以下列述的代碼癥狀就是"隊伍變形"的強烈信號:
·代碼中存在重復(fù)的代碼
中國有118 家整車生產(chǎn)企業(yè),數(shù)量幾乎等于美、日、歐所有汽車廠家數(shù)之和,但是全國的年產(chǎn)量卻不及一個外國大汽車公司的產(chǎn)量。重復(fù)建設(shè)只會導(dǎo)致效率的低效和資源的浪費。
程序代碼更是不能搞重復(fù)建設(shè),如果同一個類中有相同的代碼塊,請把它提煉成類的一個獨立方法,如果不同類中具有相同的代碼,請把它提煉成一個新類,永遠(yuǎn)不要重復(fù)代碼。
·過大的類和過長的方法
過大的類往往是類抽象不合理的結(jié)果,類抽象不合理將降低了代碼的復(fù)用率。方法是類王國中的諸侯國,諸侯國太大勢必動搖中央集權(quán)。過長的方法由于包含的邏輯過于復(fù)雜,錯誤機率將直線上升,而可讀性則直線下降,類的健壯性很容易被打破。當(dāng)看到一個過長的方法時,需要想辦法將其劃分為多個小方法,以便于分而治之。
·牽一毛而需要動全身的修改
當(dāng)你發(fā)現(xiàn)修改一個小功能,或增加一個小功能時,就引發(fā)一次代碼地震,也許是你的設(shè)計抽象度不夠理想,功能代碼太過分散所引起的。
·類之間需要過多的通訊
A類需要調(diào)用B類的過多方法訪問B的內(nèi)部數(shù)據(jù),在關(guān)系上這兩個類顯得有點狎昵,可能這兩個類本應(yīng)該在一起,而不應(yīng)該分家。
·過度耦合的信息鏈
"計算機是這樣一門科學(xué),它相信可以通過添加一個中間層解決任何問題",所以往往中間層會被過多地追加到程序中。如果你在代碼中看到需要獲取一個信息,需要一個類的方法調(diào)用另一個類的方法,層層掛接,就象輸油管一樣節(jié)節(jié)相連。這往往是因為銜接層太多造成的,需要查看就否有可移除的中間層,或是否可以提供更直接的調(diào)用方法。
·各立山頭干革命
如果你發(fā)現(xiàn)有兩個類或兩個方法雖然命名不同但卻擁有相似或相同的功能,你會發(fā)現(xiàn)往往是因為開發(fā)團(tuán)隊協(xié)調(diào)不夠造成的。筆者曾經(jīng)寫了一個頗好用的字符串處理類,但因為沒有及時通告團(tuán)隊其他人員,后來發(fā)現(xiàn)項目中居然有三個字符串處理類。革命資源是珍貴的,我們不應(yīng)各立山頭干革命。
·不完美的設(shè)計
在筆者剛完成的一個比對報警項目中,曾安排阿朱開發(fā)報警模塊,即通過Socket向指定的短信平臺、語音平臺及客戶端報警器插件發(fā)送報警報文信息,阿朱出色地完成了這項任務(wù)。后來用戶又提出了實時比對的需求,即要求第三方系統(tǒng)以報文形式向比對報警系統(tǒng)發(fā)送請求,比對報警系統(tǒng)接收并響應(yīng)這個請求。這又需要用到Socket報文通訊,由于原來的設(shè)計沒有將報文通訊模塊獨立出來,所以無法復(fù)用阿朱開發(fā)的代碼。后來我及時調(diào)整了這個設(shè)計,新增了一個報文收發(fā)模塊,使系統(tǒng)所有的對外通訊都復(fù)用這個模塊,系統(tǒng)的整體設(shè)計也顯得更加合理。
每個系統(tǒng)都或多或少存在不完美的設(shè)計,剛開始可能注意不到,到后來才會慢慢凸顯出來,此時唯有勇于更改才是最好的出路。
·缺少必要的注釋
雖然許多軟件工程的書籍常提醒程序員需要防止過多注釋,但這個擔(dān)心好象并沒有什么必要。往往程序員更感興趣的是功能實現(xiàn)而非代碼注釋,因為前者更能帶來成就感,所以代碼注釋往往不是過多而是過少,過于簡單。人的記憶曲線下降的坡度是陡得嚇人的,當(dāng)過了一段時間后再回頭補注釋時,很容易發(fā)生"提筆忘字,愈言且止"的情形。
曾在網(wǎng)上看到過微軟的代碼注釋,其詳盡程度讓人嘆為觀止,也從中體悟到了微軟成功的一個經(jīng)驗。