如何寫出好的Java代碼
公司主營業(yè)務(wù):網(wǎng)站設(shè)計制作、成都網(wǎng)站建設(shè)、移動網(wǎng)站開發(fā)等業(yè)務(wù)。幫助企業(yè)客戶真正實現(xiàn)互聯(lián)網(wǎng)宣傳,提高企業(yè)的競爭能力。創(chuàng)新互聯(lián)公司是一支青春激揚(yáng)、勤奮敬業(yè)、活力青春激揚(yáng)、勤奮敬業(yè)、活力澎湃、和諧高效的團(tuán)隊。公司秉承以“開放、自由、嚴(yán)謹(jǐn)、自律”為核心的企業(yè)文化,感謝他們對我們的高要求,感謝他們從不同領(lǐng)域給我們帶來的挑戰(zhàn),讓我們激情的團(tuán)隊有機(jī)會用頭腦與智慧不斷的給客戶帶來驚喜。創(chuàng)新互聯(lián)公司推出韶山免費(fèi)做網(wǎng)站回饋大家。
1.
優(yōu)雅需要付出代價。從短期利益來看,對某個問題提出優(yōu)雅的解決方法,似乎可能花你更多的時間。但當(dāng)它終于能夠正確執(zhí)行并可輕易套用于新案例中,不需要花上數(shù)以時計,甚至以天計或以月計的辛苦代價時,你會看得到先前所花功夫的回報(即使沒有人可以衡量這一點)。這不僅給你一個可更容易開發(fā)和調(diào)試的程序,也更易于理解和維護(hù)。這正是它在金錢上的價值所在。這一點有賴某種人生經(jīng)驗才能夠了解,因為當(dāng)你努力讓某一段程序代碼變得比較優(yōu)雅時,你并不是處于一種具生產(chǎn)力的狀態(tài)下。但是,請抗拒那些催促你趕工的人們,因為那么做只會減緩你的速度罷了。
2.
先求能動,再求快。即使你已確定某段程序代碼極為重要,而且是系統(tǒng)的重要瓶頸,這個準(zhǔn)則依然成立。盡可能簡化設(shè)計,讓系統(tǒng)能夠先正確動作。如果程序的執(zhí)行不夠快,再量測其效能。幾乎你總是會發(fā)現(xiàn),你所認(rèn)為的”瓶頸”其實都不是問題所在。把你的時間花在刀口上吧。3.
記住”各個擊破”的原理。如果你所探討的問題過于混雜,試著想像該問題的基本動作會是什么,并假設(shè)這一小塊東西能夠神奇地處理掉最難的部分。這”一小塊”東西其實就是對象–請撰寫運(yùn)用該對象的程序代碼,然后檢視對象,并將其中困難的部分再包裝成其他對象,依此類推。
4. 區(qū)分class開發(fā)者和class使用者(使用端程序員)。Class
使用者扮演著”客戶”角色,不需要(也不知道)class的底層運(yùn)作方式。Class開發(fā)者必須是class設(shè)計專家,并撰寫class,使它能夠盡可能被大多數(shù)新手程序員所用,而且在程序中能夠穩(wěn)當(dāng)執(zhí)行。一套程序庫只有在具備通透性的情況下,使用起來才會容易。
5.當(dāng)你撰寫class時,試著給予明了易懂的名稱,減少不必要的注解。你給客戶端程序員的接口,應(yīng)該保持概念上的單純性。不了這個目的,當(dāng)函數(shù)的重載(overloading)適合制作出直覺、易用的接口時,請善加使用。
6. 也必你的分析和設(shè)計必須讓系統(tǒng)中的classes保持最少,須讓其Public
interfaces保持最少,以及讓這些classes和其他classes之間的關(guān)聯(lián)性( 尤其是base
classes)保持最少。如果你的設(shè)計所得結(jié)果更甚于此,請問問自己,是否其中每一樣?xùn)|西在整個程序生命期中都饒富價值?如果并非如此,那么,維護(hù)它們會使你付出代價。開發(fā)團(tuán)隊的成員都有不維護(hù)”無益于生產(chǎn)力提升”的任何東西的傾向;這是許多設(shè)計方法無法解釋的現(xiàn)象。
7.
讓所有東西盡量自動化。先撰寫測試用的程序代碼(在你撰寫class之前),并讓它和class結(jié)合在一起。請使用makefile或類似工具,自動進(jìn)行測試動作。通過這種方式,只要執(zhí)行測試程序,所有的程序變動就可以自動獲得驗證,而且可以立即發(fā)現(xiàn)錯誤。由于你知道的測試架構(gòu)所具備的安全性,所以當(dāng)你發(fā)現(xiàn)新的需求時,你會更勇于進(jìn)行全面修改。請記住,程序語言最大的改進(jìn),是來自型別檢查、異常處理等機(jī)制所賦予的內(nèi)置測試動作。但這些功能只能協(xié)助你到達(dá)某種程度。開發(fā)一個穩(wěn)固系統(tǒng)時,你得自己驗證自己的classes或程序的性質(zhì)。
8. 在你撰寫class之前先寫測試碼,以便驗證你的class 是否設(shè)計完備。如果你無法撰寫測試碼,你便無法知道你的class
的可能長相。撰寫測試碼通常能夠顯現(xiàn)出額外的特性(features)或限制 (
constraints)__它們并不一定總是能夠在分析和設(shè)計過程中出現(xiàn)。測試碼也可做為展示class 用法的示例程序。
9. 所有軟件設(shè)計上的問題,都可以通過”引入額外的概念性間接層(conceptual
indirection)”加以簡化。這個軟件工程上的基礎(chǔ)法則是抽象化概念的根據(jù),而抽象化概念正是面向?qū)ο蟪绦蛟O(shè)計的主要性質(zhì)。10.
間接層(indirection)應(yīng)該要有意義(和準(zhǔn)則-9致)。這里所指的意義可以像”將共用程序代碼置于惟一函數(shù)”這么簡單。如果你加入的間接層(或抽象化、或封裝等等)不具意義,它可能就和沒有適當(dāng)?shù)拈g接層一樣糟糕。
11.
讓class盡可能微小而無法切割(atomic)。賦予每個class單一而清楚的用途。如果你的classes或你的系統(tǒng)成長得過于復(fù)雜,請將復(fù)雜的classes切割成比較簡單的幾個classes。最明顯的一個判斷指針就是class的大?。喝绻艽?,那么它工作量過多的機(jī)會就可能很高,那就應(yīng)該被切割。重新設(shè)計class的建議線索是:
1) 復(fù)雜的switch語句:請考慮運(yùn)用多態(tài)(Polymorphism)。 2)
許多函數(shù)各自處理類型極為不同的動作:請考慮切割為多個不同的(classes)。
12. 小心冗長的引數(shù)列(argument
lists)。冗長的引數(shù)列會使函數(shù)的調(diào)用動作不易撰寫、閱讀、維護(hù)。你應(yīng)該試著將函數(shù)搬移到更適當(dāng)?shù)腸lass中,并盡量以對象為引數(shù)。
13. 不要一再重復(fù)。如果某段程序代碼不斷出現(xiàn)于許多derived class函數(shù)中,請將該段程序代碼置于某個base class
函數(shù)內(nèi),然后在derived
class函數(shù)中調(diào)用。這么做不僅可以省下程序代碼空間,也可以讓修改該段程序代碼動作更易于進(jìn)行。有時候找出此種共通程序代碼還可以為接口增加實用功能。
14. 小心switch語句或成串的if-else 子句。通常這種情況代表所謂的”type-check
coding”。也就是說究竟會執(zhí)行哪一段程序代碼,乃是依據(jù)某種型別信息來做抉擇(最初,確切型別可能不十分明顯)。你通??梢允褂美^承和多態(tài)來取代此類程序代碼;Polymorphical
method (多態(tài)函數(shù))的調(diào)用會自動執(zhí)行此類型別檢驗,并提供更可靠更容易的擴(kuò)充性。
15. 從設(shè)計觀點來看,請找出變動的事物,并使它和不變的事物分離。也就是說,找出系統(tǒng)中可能被你改變的元素,將它們封裝于classes中。
16. 不要利用subclassing來擴(kuò)充基礎(chǔ)功能。如果某個接口元素對class而言極重要,它應(yīng)該被放在base class
里頭,而不是直到衍生(derivation)時才被加入。如果你在繼承過程中加入了函數(shù),或許你應(yīng)該重新思考整個設(shè)計。
17. 少就是多。從class
的最小接口開始妨展,盡可能在解決問題的前提下讓它保持既小又單純。不要預(yù)先考量你的class被使用的所有可能方式。一旦class被實際運(yùn)用,你自然會知道你得如何擴(kuò)充接口。不過,一旦class被使用后,你就無法在不影響客戶程序代碼的情況下縮減其接口。如果你要加入更多函數(shù)倒是沒有問題–不會影響既有的客戶程序代碼,它們只需重新編譯即可。但即使新函數(shù)取代了舊函數(shù)的功能,也請你保留既有接口。如果你得通過”加入更多引數(shù)”的方式來擴(kuò)充既有函數(shù)的接口,請你以新引數(shù)寫出一個重載化的函數(shù);通過
這種方式就不會影響既有函數(shù)的任何客戶了。
18. 大聲念出你的classes,確認(rèn)它們符合邏輯。請base class和derived class
之間的關(guān)系是”is-a”(是一種),讓class和成員對象之間的關(guān)系是”has-a”(有一個)。
19.
當(dāng)你猶豫不決于繼承(inheritance)或合成(組合,composition)時,請你問問自己,是否需要向上轉(zhuǎn)型(upcast)為基礎(chǔ)型別。如果不需要,請優(yōu)先選擇合成(也就是是使用成員對象)。這種作法可以消除”過多基礎(chǔ)型別”。如果你采用繼承,使用者會認(rèn)為他們應(yīng)該可以向上轉(zhuǎn)型。
20. 運(yùn)用數(shù)據(jù)成員來表示數(shù)值的變化,運(yùn)用經(jīng)過覆寫的函數(shù)(overrided method)來代表行為的變化 。也就是說,如果你找到了某個
class, 帶有一些狀態(tài)變量,而其函數(shù)會依據(jù)這些變量值切換不同的行為,那么你或許就應(yīng)該重新設(shè)計,在subclasses 和覆寫后的函數(shù)(overrided
methods)中展現(xiàn)行為止的差異。
21.
小心重載(overloading)。函數(shù)不應(yīng)該依據(jù)引數(shù)值條件式地選擇執(zhí)行某一段程序代碼。這種情況下你應(yīng)該撰寫兩個或更多個重載函數(shù)(overloaded
methods)22. 使用異常體系(exception hierarchies)最好是從Java標(biāo)準(zhǔn)異常體系中衍生特定的classes,
那么,捕捉異常的人便可以捕捉特定異常,之后才捕捉基本異常。如果你加入新的衍生異常,原有的客戶端程序仍能通過其基礎(chǔ)型別來捕捉它。
23.
有時候簡單的聚合(aggregation)就夠了。飛機(jī)上的”旅客舒適系統(tǒng)”包括數(shù)個分離的元素:座椅、空調(diào)、視訊設(shè)備等等,你會需要在飛機(jī)上產(chǎn)生許多這樣的東西。你會將它們聲明為Private成員并開發(fā)出一個全新的接口嗎?不會的,在這個例子中,元素也是Public接口的一部分,所以仍然是安全的。當(dāng)然啦,簡單聚合并不是一個常被運(yùn)用的解法,但有時候的確是。
24. 試著從客戶程序員和程序維護(hù)的角度思考。你的class應(yīng)該設(shè)計得盡可能容易使用。你應(yīng)該預(yù)先考量可能性有的變動,并針對這些
可能的變動進(jìn)行設(shè)計,使這些變動日后可輕易完成。
25.
小心”巨大對象并發(fā)癥”。這往往是剛踏OOP領(lǐng)域的過程式(procedural)程序員的一個苦惱,因為他們往往最終還是寫出一個過程式程序,并將它們擺放到一個或兩個巨大對象中。注意,除了application
framework (應(yīng)用程序框架,譯注:一種很特殊的、大型OO程序庫,幫你架構(gòu)程序本體)之外,對象代表的是程序中的觀念,而不是程序本身。
26. 如果你得用某種丑陋的方式來達(dá)成某個動作,請將丑陋的部分局限在某個class里頭。
27.
如果你得用某種不可移植方式來達(dá)成某個動作,請將它抽象化并局限于某個class里頭。這樣一個”額外間接層”能夠防止不可移植的部分?jǐn)U散到整個程序。這種作法的具體呈現(xiàn)便是Bridge設(shè)計模式(design
pattern)。28.
對象不應(yīng)僅僅只用來持有數(shù)據(jù)。對象也應(yīng)該具有定義明確界限清楚的行為。有時候使用”數(shù)據(jù)對象”是適當(dāng)?shù)?,但只有在通用形容器不適用時,才適合刻意以數(shù)據(jù)對象來包裝、傳輸一群數(shù)據(jù)項。
29.
欲從既有的classes身上產(chǎn)生新的classes時,請以組合(composition)為優(yōu)先考量。你應(yīng)該只在必要時才使用繼承。如果在組合適用之處你卻選擇了繼承,你的設(shè)計就滲雜了非必要的復(fù)雜性。
30.
運(yùn)用繼承和函數(shù)覆寫機(jī)制來展現(xiàn)行為上的差異,運(yùn)用fields(數(shù)據(jù)成員)來展現(xiàn)狀態(tài)上的差異。這句話的極端例子,就是繼承出不同的classes表現(xiàn)各種不同的顏色,而不使用”color”field.31.
當(dāng)心變異性(variance)。語意相異的兩個對象擁有相同的動作(或說責(zé)任)是可能的。OO世界中存在著一種天生的引誘,讓人想要從某個class繼承出另一個subclass,為的是獲得繼承帶來的福利。這便是所謂”變異性”。但是,沒有任何正當(dāng)理由足以讓我們強(qiáng)迫制造出某個其實并不存在的superclass/subclass關(guān)系。比較好的解決方式是寫出一個共用的base
class,它為兩個derived
classes制作出共用接口–這種方式會耗用更多空間,但你可以如你所盼望地從繼承機(jī)制獲得好處,而且或許能夠在設(shè)計上獲得重大發(fā)現(xiàn)。
32.
注意繼承上的限制。最清晰易懂的設(shè)計是將功能加到繼承得來的class里頭;繼承過程中拿掉舊功能(而非增加新功能)則是一種可疑的設(shè)計。不過,規(guī)則可以打破。如果你所處理的是舊有的class程序庫,那么在某個class的subclass限制功能,可能會比重新制定整個結(jié)構(gòu)(俾使新class得以良好地相稱于舊
class)有效率得多。
33. 使用設(shè)計模式(design patterns)來減少”赤裸裸無加掩飾的機(jī)能(naked
functionality)”。舉個例子,如果你的class只應(yīng)該產(chǎn)出惟一一個對象,那么請不要以加思索毫無設(shè)計的手法來完成它,然后撰寫”只該產(chǎn)生一份對象”這樣的注解就拍拍屁股走人。請將它包裝成singleton(譯注:一個有名的設(shè)計模式,可譯為”單件”)。如果主程序中有多而混亂的”用以產(chǎn)生對象”的程序代碼,請找出類似
factory method這樣的生成模式(creational patterns),使價錢可用以封裝生成動作減少”赤裸裸無加掩飾的機(jī)能”(naked
functionality)不僅可以讓你的程序更易理解和維護(hù),也可以阻止出于好意卻帶來意外的維護(hù)者。
34. 當(dāng)心”因分析而導(dǎo)致的癱瘓(analysis
paralysis)”。請記住,你往往必須在獲得所有信息之前讓項目繼續(xù)前進(jìn)。而且理解未知部分的最好也最快的方式,通常就是實際前進(jìn)一步而不只是紙上談兵。除非找到解決辦法,否則無法知道解決辦法。Java擁有內(nèi)置的防火墻,請讓它們發(fā)揮作用。你在單一class或一組classes中所犯的錯誤,并不會傷害整個系統(tǒng)的完整性。
35.
當(dāng)你認(rèn)為你已經(jīng)獲得一份優(yōu)秀的分析、設(shè)計或?qū)崿F(xiàn)時,請試著加以演練。將團(tuán)隊以外的某些人帶進(jìn)來-他不必非得是個顧問不可,他可以是公司其他團(tuán)隊的成員。請那個人以新鮮的姿態(tài)審視你們的成果,這樣可以在尚可輕易修改的階段找出問題,其收獲會比因演練而付出的時間和金錢代價來得高。實現(xiàn)
(Implementation)
36. 一般來說,請遵守Sun的程序編寫習(xí)慣。
37.
無論使用何種編寫風(fēng)格,如果你的團(tuán)隊(或整個公司,那就更好了)能夠加以標(biāo)準(zhǔn)化,那么的確會帶來顯著效果。這代表每個人都可以在其他人不遵守編寫風(fēng)格修改其作品,這是個公平的游戲。標(biāo)準(zhǔn)化的價值在于,分析程序代碼時所花的腦力較小,因而可以專心于程序代碼的實質(zhì)意義。
38. 遵守標(biāo)準(zhǔn)的大小寫規(guī)范。將
class名稱的第一個字母應(yīng)為大寫。數(shù)據(jù)成員、函數(shù)、對象(references)的第一個字母應(yīng)為小寫。所有識別名稱的每個字都應(yīng)該連在一塊兒,所有非首字的第一個字母都應(yīng)該大寫。例如:
ThisIsAClassName thisIsAMethodOrFieldName 如果你在static final
基本型別的定義處指定了常量初始式(constant initializers),那么該識別名稱應(yīng)該全為大寫,代表一個編譯期常量。
Packages是個特例,其名稱皆為小寫,即使非首字的字母亦是如此。域名(org, net, edu 等等)皆應(yīng)為小寫。(這是Java 1.1遷移至Java
2時的一項改變) 。
39、不要自己發(fā)明”裝飾用的”Private數(shù)據(jù)成員名稱。通常這種的形式是在最前端加上底線和其他字符,匈牙利命名法(Hungarian
notation)是其中最差的示范。在這種命名法中,你得加入額外字符來表示數(shù)據(jù)的型別、用途、位置等等。仿佛你用的是匯編語言(assembly
language)而編譯器沒有提供任何協(xié)肋似的。這樣的命名方式容易讓人混淆又難以閱讀,也不易推行和維護(hù)。就讓classes和packages來進(jìn)行”名稱上的范圍制定(name
scoping)”吧。
40、當(dāng)你擬定通用性的class時,請遵守正規(guī)形式(canonical form)。包括equals( )、hashCode( )、clone( )
( 實現(xiàn)出Cloneable),并實現(xiàn)出Comparable和Serialiable等等。
41、對于那些”取得或改變Private數(shù)據(jù)值”的函數(shù),請使用Java Beans
的”get”、”set”、”is”等命名習(xí)慣,即使你當(dāng)時不認(rèn)為自己正在撰寫Java
Bean。這么做不僅可以輕易以Bean的運(yùn)用方式來運(yùn)用你的class,也是對此類函數(shù)的一種標(biāo)準(zhǔn)命名方式,使讀者更易于理解。
42、對于你所擬定的每一個class,請考慮為它加入static public test(
),其中含有class功能測試碼。你不需要移除該測試就可將程序納入項目。而且如果有所變動,你可以輕易重新執(zhí)行測試。這段程序代碼也可以做為class的使用示例。
43、有時候你需要通過繼承,才得以訪問base class的protected成員。這可能會引發(fā)對多重基類(multiple base
types)的認(rèn)識需求。如果你不需要向上轉(zhuǎn)型,你可以先衍生新的class發(fā)便執(zhí)行protected訪問動作,然后在”需要用到上述
protected成員”的所有classes中,將新class聲明為成員對象,而非直接繼承。
44、避免純粹為了效率考量而使用final函數(shù)。只有在程序能動但執(zhí)行不夠快時,而且效能量測工具(profiler)顯示某個函數(shù)的調(diào)用動作成為瓶頸時,才使用final函數(shù)。
45、如果兩個classes因某種功能性原因而產(chǎn)生了關(guān)聯(lián)(例如容器containers和迭代器iterators),那么請試著讓其中某個class成為另一個class
的內(nèi)隱類(inner class)。這不僅強(qiáng)調(diào)二者間的關(guān)聯(lián),也是通過”將class名稱嵌套置于另一個class 內(nèi)”而使同一個class
名稱在單一Package中可被重復(fù)使用。Java 容器庫在每個容器類中都定義了一個內(nèi)隱的(inner)Iterator
class,因而能夠提供容器一份共通接口。運(yùn)用內(nèi)隱類的另一個原因是讓它成為private實現(xiàn)物的一部分。在這里,內(nèi)隱類會為信息隱藏帶來好處,而不是對上述的class關(guān)聯(lián)性提供肋益,也不是為了防止命名空間污染問題(namespace
pollution)。
46、任何時候你都要注意那些高度耦合(coupling)的 classes.請考慮內(nèi)隱類(inner
classes)為程序擬定和維護(hù)帶來的好處。內(nèi)隱類的使用并不是要去除classes間的耦合,而是要讓耦合關(guān)系更明顯也更便利。
47、不要成為”過早最佳化”的犧牲品。那會讓人神經(jīng)錯亂。尤其在系統(tǒng)建構(gòu)初期,先別煩惱究竟要不要撰寫(或避免)原生函數(shù)(native
methods)、要不要將某些數(shù)聲明為final、要不要調(diào)校程序代碼效率等等。你的主要問題應(yīng)該是先證明設(shè)計的正確性,除非設(shè)計本身需要某種程度的效率。
怎么判斷代碼是否是優(yōu)質(zhì)量的代碼呢?下面重慶電腦培訓(xùn)來簡單對代碼質(zhì)量的問題進(jìn)行一個介紹。
代碼質(zhì)量所涉及的5個方面,編碼標(biāo)準(zhǔn)、代碼重復(fù)、代碼覆蓋率、依賴項分析、復(fù)雜度分析。
我們分別來看一下這5方面:編碼標(biāo)準(zhǔn):一般來說,公司都會有一份編碼規(guī)范,類命名、包命名、代碼風(fēng)格之類的都會有所要求。
代碼重復(fù):顧名思義就是重復(fù)的代碼,如果代碼中有大量的重復(fù)代碼,就要考慮是否將重復(fù)的代碼提取出來,封裝成一個公共的方法或者組件。
代碼覆蓋率:測試代碼能運(yùn)行到的代碼比率,代碼經(jīng)過了單元測試了嗎?是不是每個方法都進(jìn)行了測試,代碼覆蓋率是多少?這關(guān)系到代碼的功能性和穩(wěn)定性。
依賴項分析:代碼依賴關(guān)系怎么樣?耦合關(guān)系怎么樣?是否有循環(huán)依賴?是否符合高內(nèi)聚低耦合的原則?復(fù)雜度分析:如果代碼中嵌套了很多層的ifelse,就會讓人很難閱讀。
要相信越優(yōu)秀的代碼,越容易讀懂。
1、組織與風(fēng)格
(1).關(guān)鍵詞和操作符之間加適當(dāng)?shù)目崭瘛?/p>
(2).相對獨(dú)立的程序塊與塊之間加空行
(3).較長的語句、表達(dá)式等要分成多行書寫。
(4).劃分出的新行要進(jìn)行適應(yīng)的縮進(jìn),使排版整齊,語句可讀。
(5).長表達(dá)式要在低優(yōu)先級操作符處劃分新行,操作符放在新行之首。
(6).循環(huán)、判斷等語句中若有較長的表達(dá)式或語句,則要進(jìn)行適應(yīng)的劃分。
(7).若函數(shù)或過程中的參數(shù)較長,則要進(jìn)行適當(dāng)?shù)膭澐帧?/p>
(8).不允許把多個短語句寫在一行中,即一行只寫一條語句。
(9).函數(shù)或過程的開始、結(jié)構(gòu)的定義及循環(huán)、判斷等語句中的代碼都要采用縮進(jìn)風(fēng)格。
注:如果大家有興趣可以到安安DIY創(chuàng)作室博客,有相關(guān)說明性的文章和解釋。
2、注解
Java 的語法與 C++ 及為相似,那么,你知道 Java 的注釋有幾種嗎?是兩種?
// 注釋一行
/* ...... */ 注釋若干行
不完全對,除了以上兩種之外,還有第三種,文檔注釋:
/** ...... */ 注釋若干行,并寫入 javadoc 文檔
注釋要簡單明了。
String userName = null; //用戶名
邊寫代碼邊注釋,修改代碼同時修改相應(yīng)的注釋,以保證注釋與代碼的一致性。
在必要的地方注釋,注釋量要適中。注釋的內(nèi)容要清楚、明了,含義準(zhǔn)確,防止注釋二義性。
保持注釋與其描述的代碼相鄰,即注釋的就近原則。
對代碼的注釋應(yīng)放在其上方相鄰位置,不可放在下面。對數(shù)據(jù)結(jié)構(gòu)的注釋應(yīng)放在其上方相鄰位置,不可放在下面;對結(jié)構(gòu)中的每個域的注釋應(yīng)放在此域的右方;
同一結(jié)構(gòu)中不同域的注釋要對齊。
變量、常量的注釋應(yīng)放在其上方相鄰位置或右方。
全局變量要有較詳細(xì)的注釋,包括對其功能、取值范圍、哪些函數(shù)或過程存取它以及存取時注意事項等的說明。
在每個源文件的頭部要有必要的注釋信息,包括:文件名;版本號;作者;生成日期;模塊功能描述(如功能、主要算法、內(nèi)部各部分之間的關(guān)系、該文件與其它文件關(guān)系等);主要函數(shù)或過程清單及本文件歷史修改記錄等。
/**
* Copy Right Information : Neusoft IIT
* Project : eTrain
* JDK version used : jdk1.3.1
* Comments : config path
* Version : 1.01
* Modification history :2003.5.1
* Sr Date Modified By Why What is modified
* 1. 2003.5.2 Kevin Gao new
**/
在每個函數(shù)或過程的前面要有必要的注釋信息,包括:函數(shù)或過程名稱;功能描述;輸入、輸出及返回值說明;調(diào)用關(guān)系及被調(diào)用關(guān)系說明等
/**
* Description :checkout 提款
* @param Hashtable cart info
* @param OrderBean order info
* @return String
*/
public String checkout(Hashtable htCart,
OrderBean orderBean)
throws Exception{
}
javadoc注釋標(biāo)簽語法
@author 對類的說明 標(biāo)明開發(fā)該類模塊的作者
@version 對類的說明 標(biāo)明該類模塊的版本
@see 對類、屬性、方法的說明 參考轉(zhuǎn)向,也就是相關(guān)主題
@param 對方法的說明 對方法中某參數(shù)的說明
@return 對方法的說明 對方法返回值的說明
@exception 對方法的說明 對方法可能拋出的異常進(jìn)行說明
3、命名規(guī)范
定義這個規(guī)范的目的是讓項目中所有的文檔都看起來像一個人寫的,增加可讀性,減少項目組中因為換人而帶來的損失。(這些規(guī)范并不是一定要絕對遵守,但是一定要讓程序有良好的可讀性)較短的單詞可通過去掉元音形成縮寫;要不然最后自己寫的代碼自己都看不懂了,那可不行。
較長的單詞可取單詞的頭幾發(fā)符的優(yōu)先級,并用括號明確表達(dá)式的操作順序,避免使用默認(rèn)優(yōu)先級。
使用匈牙利表示法
Package 的命名
Package 的名字應(yīng)該都是由一個小寫單詞組成。
package com.neu.util
Class 的命名
Class 的名字必須由大寫字母開頭而其他字母都小寫的單詞組成,對于所有標(biāo)識符,其中包含的所有單詞都應(yīng)緊靠在一起,而且大寫中間單詞的首字母。
public class ThisAClassName{}
Class 變量的命名
變量的名字必須用一個小寫字母開頭。后面的單詞用大寫字母開頭
userName , thisAClassMethod
Static Final 變量的命名
static Final 變量的名字應(yīng)該都大寫,并且指出完整含義。
/**
*DBConfig PATH
**/
public static final String
DB_CONFIG_FILE_PATH =com.neu.etrain.dbconfig;
參數(shù)的命名
參數(shù)的名字必須和變量的命名規(guī)范一致。
數(shù)組的命名
數(shù)組應(yīng)該總是用下面的方式來命名:
byte[] buffer;
而不是:
byte buffer[];
方法的參數(shù)
使用有意義的參數(shù)命名,如果可能的話,使用和要賦值的字段一樣的名字:
SetCounter(int size){
this.size = size;
}
4、文件樣式
所有的 Java(*.java) 文件都必須遵守如下的樣式規(guī)則:
版權(quán)信息
版權(quán)信息必須在 java 文件的開頭,比如:
/*
* Copyright ? 2000 Shanghai XXX Co. Ltd.
* All right reserved.
*/
其他不需要出現(xiàn)在 javadoc 的信息也可以包含在這里。
Package/Imports
package 行要在 import 行之前,import 中標(biāo)準(zhǔn)的包名要在本地的包名之前,而且按照字母
順序排列。如果 import 行中包含了同一個包中的不同子目錄,則應(yīng)該用 * 來處理。
package hotlava.net.stats;
import java io.*;
import java.util.Observable;
import hotlava.util.Application;
這里 java。io.* 使用來代替InputStream and OutputStream 的。
Class
接下來的是類的注釋,一般是用來解釋類的。
/**
* A class representing a set of packet and byte counters
* It is observable to allow it to be watched, but only
* reports changes when the current set is complete
*/
接下來是類定義,包含了在不同的行的 extends 和 implements
public class CounterSet
extends Observable
implements Cloneable
Class Fields
接下來是類的成員變量:
/**
* Packet counters
*/
protected int[] packets;
public 的成員變量必須生成文檔(JavaDoc)。proceted、private和 package 定義的成
員變量如果名字含義明確的話,可以沒有注釋。
存取方法
接下來是類變量的存取的方法。它只是簡單的用來將類的變量賦值獲取值的話,可以簡單的
寫在一行上。
/**
* Get the counters
* @return an array containing the statistical data. This array has been
* freshly allocated and can be modified by the caller.
*/
public int[] getPackets() { return copyArray(packets, offset); }
public int[] getBytes() { return copyArray(bytes, offset); }
public int[] getPackets() { return packets; }
public void setPackets(int[] packets) { this.packets = packets; }
其它的方法不要寫在一行上
構(gòu)造函數(shù)
接下來是構(gòu)造函數(shù),它應(yīng)該用遞增的方式寫(比如:參數(shù)多的寫在后面)。
訪問類型 (public, private 等.) 和 任何 static, final 或 synchronized 應(yīng)該在一行
中,并且方法和參數(shù)另寫一行,這樣可以使方法和參數(shù)更易讀。
public
CounterSet(int size){
this.size = size;
}
克隆方法
如果這個類是可以被克隆的,那么下一步就是 clone 方法:
public
Object clone() {
try {
CounterSet obj = (CounterSet)super.clone();
obj.packets = (int[])packets.clone();
obj.size = size;
return obj;
}catch(CloneNotSupportedException e) {
throw new InternalError(Unexpected CloneNotSUpportedException: +
e.getMessage());
}
}
類方法
下面開始寫類的方法:
/**
* Set the packet counters
* (such as when restoring from a database)
*/
protected final
void setArray(int[] r1, int[] r2, int[] r3, int[] r4)
throws IllegalArgumentException
{
//
// Ensure the arrays are of equal size
//
if (r1.length != r2.length || r1.length != r3.length || r1.length != r4.length)
throw new IllegalArgumentException(Arrays must be of the same size);
System.arraycopy(r1, 0, r3, 0, r1.length);
System.arraycopy(r2, 0, r4, 0, r1.length);
}
toString 方法
無論如何,每一個類都應(yīng)該定義 toString 方法:
public
String toString() {
String retval = CounterSet: ;
for (int i = 0; i data.length(); i++) {
retval += data.bytes.toString();
retval += data.packets.toString();
}
return retval;
}
}
main 方法
如果main(String[]) 方法已經(jīng)定義了, 那么它應(yīng)該寫在類的底部.
5、代碼可讀性
避免使用不易理解的數(shù)字,用有意義的標(biāo)識來替代。
不要使用難懂的技巧性很高的語句。
源程序中關(guān)系較為緊密的代碼應(yīng)盡可能相鄰。
6、代碼性能
在寫代碼的時候,從頭至尾都應(yīng)該考慮性能問題。這不是說時間都應(yīng)該浪費(fèi)在優(yōu)化代碼上,而是我們時刻應(yīng)該提醒自己要注意代碼的效率。比如:如果沒有時間來實現(xiàn)一個高效的算法,那么我們應(yīng)該在文檔中記錄下來,以便在以后有空的時候再來實現(xiàn)她。
不是所有的人都同意在寫代碼的時候應(yīng)該優(yōu)化性能這個觀點的,他們認(rèn)為性能優(yōu)化的問題應(yīng)該在項目的后期再去考慮,也就是在程序的輪廓已經(jīng)實現(xiàn)了以后。
不必要的對象構(gòu)造
不要在循環(huán)中構(gòu)造和釋放對象
使用 StringBuffer 對象
在處理 String 的時候要盡量使用 StringBuffer 類,StringBuffer 類是構(gòu)成 String 類的基礎(chǔ)。
String 類將 StringBuffer 類封裝了起來,(以花費(fèi)更多時間為代價)為開發(fā)人員提供了一個安全的接口。當(dāng)我們在構(gòu)造字符串的時候,我們應(yīng)該用 StringBuffer 來實現(xiàn)大部分的工作,當(dāng)工作完成后將 StringBuffer 對象再轉(zhuǎn)換為需要的 String 對象。比如:如果有一個字符串必須不斷地在其后添加許多字符來完成構(gòu)造,那么我們應(yīng)該使用StringBuffer 對象和她的 append() 方法。如果我們用 String 對象代替StringBuffer 對象的話,會花費(fèi)許多不必要的創(chuàng)建和釋放對象的 CPU 時間。大家可以來安安DIY創(chuàng)作室一起討論。
避免太多的使用 synchronized 關(guān)鍵字避免不必要的使用關(guān)鍵字 synchronized,應(yīng)該在必要的時候再使用她,這是一個避免死鎖的好方法。
7、編程技巧
byte 數(shù)組轉(zhuǎn)換到 characters
為了將 byte 數(shù)組轉(zhuǎn)換到 characters,你可以這么做:
Hello world!.getBytes();
Utility 類
Utility 類(僅僅提供方法的類)應(yīng)該被申明為抽象的來防止被繼承或被初始化。
初始化
下面的代碼是一種很好的初始化數(shù)組的方法:
objectArguments = new Object[] { arguments };
枚舉類型
JAVA 對枚舉的支持不好,但是下面的代碼是一種很有用的模板:
class Colour {
public static final Colour BLACK = new Colour(0, 0, 0);
public static final Colour RED = new Colour(0xFF, 0, 0);
public static final Colour GREEN = new Colour(0, 0xFF, 0);
public static final Colour BLUE = new Colour(0, 0, 0xFF);
public static final Colour WHITE = new Colour(0xFF, 0xFF, 0xFF);
}
這種技術(shù)實現(xiàn)了RED, GREEN, BLUE 等可以象其他語言的枚舉類型一樣使用的常量。
他們可以用 '==' 操作符來比較。
但是這樣使用有一個缺陷:如果一個用戶用這樣的方法來創(chuàng)建顏色 BLACK new Colour(0,0,0)
那么這就是另外一個對象,'=='操作符就會產(chǎn)生錯誤。她的 equal() 方法仍然有效。由于這個原因,這個技術(shù)的缺陷最好注明在文檔中,或者只在自己的包中使用。
8、編寫格式
代碼樣式
代碼應(yīng)該用 unix 的格式,而不是 windows 的(比如:回車變成回車+換行)
文檔化
必須用 javadoc 來為類生成文檔。不僅因為它是標(biāo)準(zhǔn),這也是被各種 java 編譯器都認(rèn)可的方法。使用 @author 標(biāo)記是不被推薦的,因為代碼不應(yīng)該是被個人擁有的。
縮進(jìn)
縮進(jìn)應(yīng)該是每行2個空格. 不要在源文件中保存Tab字符. 在使用不同的源代碼管理工具時Tab字符將因為用戶設(shè)置的不同而擴(kuò)展為不同的寬度.如果你使用 UltrEdit 作為你的 Java 源代碼編輯器的話,你可以通過如下操作來禁止保存Tab字符, 方法是通過 UltrEdit中先設(shè)定 Tab 使用的長度室2個空格,然后用 Format|Tabs to Spaces 菜單將 Tab 轉(zhuǎn)換為空格。
頁寬
頁寬應(yīng)該設(shè)置為80字符. 源代碼一般不會超過這個寬度, 并導(dǎo)致無法完整顯示, 但這一設(shè)置也可以靈活調(diào)整. 在任何情況下, 超長的語句應(yīng)該在一個逗號或者一個操作符后折行. 一條語句折行后, 應(yīng)該比原來的語句再縮進(jìn)2個字符.
{} 對
{} 中的語句應(yīng)該單獨(dú)作為一行. 例如, 下面的第1行是錯誤的, 第2行是正確的:
if (i0) { i ++ }; // 錯誤, { 和 } 在同一行
if (i0) {
i ++
}; // 正確, { 單獨(dú)作為一行
} 語句永遠(yuǎn)單獨(dú)作為一行.如果 } 語句應(yīng)該縮進(jìn)到與其相對應(yīng)的 { 那一行相對齊的位置。
括號
左括號和后一個字符之間不應(yīng)該出現(xiàn)空格, 同樣, 右括號和前一個字符之間也不應(yīng)該出現(xiàn)空格. 下面的例子說明括號和空格的錯誤及正確使用:
CallProc( AParameter ); // 錯誤
CallProc(AParameter); // 正確
不要在語句中使用無意義的括號. 括號只應(yīng)該為達(dá)到某種目的而出現(xiàn)在源代碼中。下面的例子說明錯誤和正確的用法:
if ((I) = 42) { // 錯誤 - 括號毫無意義
if (I == 42) or (J == 42) then // 正確 - 的確需要括號
9、代碼編譯
1.編寫代碼時要注意隨時保存,并定期備份,防止由于斷電、硬盤損壞等原因造成代碼丟失。
2.同一項目組內(nèi),最好使用相同的編輯器,并使用相同的設(shè)置選項。
3.合理地設(shè)計軟件系統(tǒng)目錄,方便開發(fā)人員使用。
4.打開編譯器的所有告警開關(guān)對程序進(jìn)行編譯。
5.在同一項目組或產(chǎn)品組中,要統(tǒng)一編譯開關(guān)選項。
6.使用工具軟件(如Visual SourceSafe)對代碼版本進(jìn)行維護(hù)。如果大家有不明白的可以到安安DIY創(chuàng)作室留言。
10、可移植性
Borland Jbulider 不喜歡 synchronized 這個關(guān)鍵字,如果你的斷點設(shè)在這些關(guān)鍵字的作用域內(nèi)的話,調(diào)試的時候你會發(fā)現(xiàn)的斷點會到處亂跳,讓你不知所措。除非必須,盡量不要使用。
換行
如果需要換行的話,盡量用 println 來代替在字符串中使用\n。
你不要這樣:
System.out.print(Hello,world!\n);
要這樣:
System.out.println(Hello,world!);
或者你構(gòu)造一個帶換行符的字符串,至少要象這樣:
String newline = System.getProperty(line.separator);
System.out.println(Hello world + newline);
PrintStream
PrintStream 已經(jīng)被不贊成(deprecated)使用,用 PrintWrite 來代替它。
1. 優(yōu)雅需要付出代價。
從短期利益來看,對某個問題提出優(yōu)雅的解決方法,似乎可能花你更多的時間。但當(dāng)它終于能夠正確執(zhí)行并可輕易套用于新案例中,不需要花上數(shù)以時計,甚至以天計或以月計的辛苦代價時,你會看得到先前所花功夫的回報(即使沒有人可以衡量這一點)。這不僅給你一個可更容易開發(fā)和調(diào)試的程序,也更易于理解和維護(hù)。這正是它在金錢上的價值所在。這一點有賴某種人生經(jīng)驗才能夠了解,因為當(dāng)你努力讓某一段程序代碼變得比較優(yōu)雅時,你并不是處于一種具生產(chǎn)力的狀態(tài)下。但是,請抗拒那些催促你趕工的人們,因為那么做只會減緩你的速度罷了。
2. 先求能動,再求快。
即使你已確定某段程序代碼極為重要,而且是系統(tǒng)的重要瓶頸,這個準(zhǔn)則依然成立。盡可能簡化設(shè)計,讓系統(tǒng)能夠先正確動作。如果程序的執(zhí)行不夠快,再量測其效能。幾乎你總是會發(fā)現(xiàn),你所認(rèn)為的”瓶頸”其實都不是問題所在。把你的時間花在刀口上吧。
3. 記住”各個擊破”的原理。
如果你所探討的問題過于混雜,試著想像該問題的基本動作會是什么,并假設(shè)這一小塊東西能夠神奇地處理掉最難的部分。這”一小塊”東西其實就是對象–請撰寫運(yùn)用該對象的程序代碼,然后檢視對象,并將其中困難的部分再包裝成其他對象,依此類推。
4. 區(qū)分class開發(fā)者和class使用者(使用端程序員)。
Class 使用者扮演著”客戶”角色,不需要(也不知道)class的底層運(yùn)作方式。Class開發(fā)者必須是class設(shè)計專家,并撰寫class,使它能夠盡可能被大多數(shù)新手程序員所用,而且在程序中能夠穩(wěn)當(dāng)執(zhí)行。一套程序庫只有在具備通透性的情況下,使用起來才會容易。
5.當(dāng)你撰寫class時,試著給予明了易懂的名稱,減少不必要的注解。
你給客戶端程序員的接口,應(yīng)該保持概念上的單純性。不了這個目的,當(dāng)函數(shù)的重載(overloading)適合制作出直覺、易用的接口時,請善加使用。
6. 也必你的分析和設(shè)計必須讓系統(tǒng)中的classes保持最少,須讓其Public interfaces保持最少,以及讓這些classes和其他classes之間的關(guān)聯(lián)性( 尤其是base classes)保持最少。
如果你的設(shè)計所得結(jié)果更甚于此,請問問自己,是否其中每一樣?xùn)|西在整個程序生命期中都饒富價值?如果并非如此,那么,維護(hù)它們會使你付出代價。開發(fā)團(tuán)隊的成員都有不維護(hù)”無益于生產(chǎn)力提升”的任何東西的傾向;這是許多設(shè)計方法無法解釋的現(xiàn)象。
7. 讓所有東西盡量自動化。先撰寫測試用的程序代碼(在你撰寫class之前),并讓它和class結(jié)合在一起。請使用makefile或類似工具,自動進(jìn)行測試動作。
通過這種方式,只要執(zhí)行測試程序,所有的程序變動就可以自動獲得驗證,而且可以立即發(fā)現(xiàn)錯誤。由于你知道的測試架構(gòu)所具備的安全性,所以當(dāng)你發(fā)現(xiàn)新的需求時,你會更勇于進(jìn)行全面修改。請記住,程序語言最大的改進(jìn),是來自型別檢查、異常處理等機(jī)制所賦予的內(nèi)置測試動作。但這些功能只能協(xié)助你到達(dá)某種程度。開發(fā)一個穩(wěn)固系統(tǒng)時,你得自己驗證自己的classes或程序的性質(zhì)。
8. 在你撰寫class之前先寫測試碼,以便驗證你的class 是否設(shè)計完備。如果你無法撰寫測試碼,你便無法知道你的class 的可能長相。撰寫測試碼通常能夠顯現(xiàn)出額外的特性(features)或限制 ( constraints)__它們并不一定總是能夠在分析和設(shè)計過程中出現(xiàn)。測試碼也可做為展示class 用法的示例程序。
9. 所有軟件設(shè)計上的問題,都可以通過”引入額外的概念性間接層(conceptual indirection)”加以簡化。這個軟件工程上的基礎(chǔ)法則是抽象化概念的根據(jù),而抽象化概念正是面向?qū)ο蟪绦蛟O(shè)計的主要性質(zhì)。
10. 間接層(indirection)應(yīng)該要有意義(和準(zhǔn)則-9致)。
這里所指的意義可以像”將共用程序代碼置于惟一函數(shù)”這么簡單。如果你加入的間接層(或抽象化、或封裝等等)不具意義,它可能就和沒有適當(dāng)?shù)拈g接層一樣糟糕。
11. 讓class盡可能微小而無法切割(atomic)。
賦予每個class單一而清楚的用途。如果你的classes或你的系統(tǒng)成長得過于復(fù)雜,請將復(fù)雜的classes切割成比較簡單的幾個classes。最明顯的一個判斷指針就是class的大?。喝绻艽?,那么它工作量過多的機(jī)會就可能很高,那就應(yīng)該被切割。重新設(shè)計class的建議線索是:
1) 復(fù)雜的switch語句:請考慮運(yùn)用多態(tài)(Polymorphism)。
2) 許多函數(shù)各自處理類型極為不同的動作:請考慮切割為多個不同的(classes)。
12. 小心冗長的引數(shù)列(argument lists)。
冗長的引數(shù)列會使函數(shù)的調(diào)用動作不易撰寫、閱讀、維護(hù)。你應(yīng)該試著將函數(shù)搬移到更適當(dāng)?shù)腸lass中,并盡量以對象為引數(shù)。
13. 不要一再重復(fù)。
如果某段程序代碼不斷出現(xiàn)于許多derived class函數(shù)中,請將該段程序代碼置于某個base class 函數(shù)內(nèi),然后在derived class函數(shù)中調(diào)用。這么做不僅可以省下程序代碼空間,也可以讓修改該段程序代碼動作更易于進(jìn)行。有時候找出此種共通程序代碼還可以為接口增加實用功能。
14. 小心switch語句或成串的if-else 子句。
通常這種情況代表所謂的”type-check coding”。也就是說究竟會執(zhí)行哪一段程序代碼,乃是依據(jù)某種型別信息來做抉擇(最初,確切型別可能不十分明顯)。你通??梢允褂美^承和多態(tài)來取代此類程序代碼;Polymorphical method (多態(tài)函數(shù))的調(diào)用會自動執(zhí)行此類型別檢驗,并提供更可靠更容易的擴(kuò)充性。
15. 從設(shè)計觀點來看,請找出變動的事物,并使它和不變的事物分離。
也就是說,找出系統(tǒng)中可能被你改變的元素,將它們封裝于classes中。你可以在《Thinking in Patterns with Java》(可免費(fèi)下載于 www. BruceEckel. Com)大量學(xué)習(xí)到這種觀念。
16. 不要利用subclassing來擴(kuò)充基礎(chǔ)功能。
如果某個接口元素對class而言極重要,它應(yīng)該被放在base class 里頭,而不是直到衍生(derivation)時才被加入。如果你在繼承過程中加入了函數(shù),或許你應(yīng)該重新思考整個設(shè)計。
17. 少就是多。
從class 的最小接口開始妨展,盡可能在解決問題的前提下讓它保持既小又單純。不要預(yù)先考量你的class被使用的所有可能方式。一旦class被實際運(yùn)用,你自然會知道你得如何擴(kuò)充接口。不過,一旦class被使用后,你就無法在不影響客戶程序代碼的情況下縮減其接口。如果你要加入更多函數(shù)倒是沒有問題–不會影響既有的客戶程序代碼,它們只需重新編譯即可。但即使新函數(shù)取代了舊函數(shù)的功能,也請你保留既有接口。如果你得通過”加入更多引數(shù)”的方式來擴(kuò)充既有函數(shù)的接口,請你以新引數(shù)寫出一個重載化的函數(shù);通過 這種方式就不會影響既有函數(shù)的任何客戶了。
18. 大聲念出你的classes,確認(rèn)它們符合邏輯。
請base class和derived class 之間的關(guān)系是”is-a”(是一種),讓class和成員對象之間的關(guān)系是”has-a”(有一個)。
19. 當(dāng)你猶豫不決于繼承(inheritance)或合成(組合,composition)時,請你問問自己,是否需要向上轉(zhuǎn)型(upcast)為基礎(chǔ)型別。
如果不需要,請優(yōu)先選擇合成(也就是是使用成員對象)。這種作法可以消除”過多基礎(chǔ)型別”。如果你采用繼承,使用者會認(rèn)為他們應(yīng)該可以向上轉(zhuǎn)型。
20. 運(yùn)用數(shù)據(jù)成員來表示數(shù)值的變化,運(yùn)用經(jīng)過覆寫的函數(shù)(overrided method)來代表行為的變化 。
也就是說,如果你找到了某個 class, 帶有一些狀態(tài)變量,而其函數(shù)會依據(jù)這些變量值切換不同的行為,那么你或許就應(yīng)該重新設(shè)計,在subclasses 和覆寫后的函數(shù)(overrided methods)中展現(xiàn)行為止的差異。
21. 小心重載(overloading)。
函數(shù)不應(yīng)該依據(jù)引數(shù)值條件式地選擇執(zhí)行某一段程序代碼。這種情況下你應(yīng)該撰寫兩個或更多個重載函數(shù)(overloaded methods)
22. 使用異常體系(exception hierarchies)
最好是從Java標(biāo)準(zhǔn)異常體系中衍生特定的classes, 那么,捕捉異常的人便可以捕捉特定異常,之后才捕捉基本異常。如果你加入新的衍生異常,原有的客戶端程序仍能通過其基礎(chǔ)型別來捕捉它。
23. 有時候簡單的聚合(aggregation)就夠了。
飛機(jī)上的”旅客舒適系統(tǒng)”包括數(shù)個分離的元素:座椅、空調(diào)、視訊設(shè)備等等,你會需要在飛機(jī)上產(chǎn)生許多這樣的東西。你會將它們聲明為Private成員并開發(fā)出一個全新的接口嗎?不會的,在這個例子中,元素也是Public接口的一部分,所以仍然是安全的。當(dāng)然啦,簡單聚合并不是一個常被運(yùn)用的解法,但有時候的確是。
24. 試著從客戶程序員和程序維護(hù)的角度思考。
你的class應(yīng)該設(shè)計得盡可能容易使用。你應(yīng)該預(yù)先考量可能性有的變動,并針對這些 可能的變動進(jìn)行設(shè)計,使這些變動日后可輕易完成。
25. 小心”巨大對象并發(fā)癥”。
這往往是剛踏OOP領(lǐng)域的過程式(procedural)程序員的一個苦惱,因為他們往往最終還是寫出一個過程式程序,并將它們擺放到一個或兩個巨大對象中。注意,除了application framework (應(yīng)用程序框架,譯注:一種很特殊的、大型OO程序庫,幫你架構(gòu)程序本體)之外,對象代表的是程序中的觀念,而不是程序本身。
26. 如果你得用某種丑陋的方式來達(dá)成某個動作,請將丑陋的部分局限在某個class里頭。
27. 如果你得用某種不可移植方式來達(dá)成某個動作,請將它抽象化并局限于某個class里頭。這樣一個”額外間接層”能夠防止不可移植的部分?jǐn)U散到整個程序。這種作法的具體呈現(xiàn)便是Bridge設(shè)計模式(design pattern)。
28. 對象不應(yīng)僅僅只用來持有數(shù)據(jù)。
對象也應(yīng)該具有定義明確界限清楚的行為。有時候使用”數(shù)據(jù)對象”是適當(dāng)?shù)?,但只有在通用形容器不適用時,才適合刻意以數(shù)據(jù)對象來包裝、傳輸一群數(shù)據(jù)項。
29. 欲從既有的classes身上產(chǎn)生新的classes時,請以組合(composition)為優(yōu)先考量。
你應(yīng)該只在必要時才使用繼承。如果在組合適用之處你卻選擇了繼承,你的設(shè)計就滲雜了非必要的復(fù)雜性。
30. 運(yùn)用繼承和函數(shù)覆寫機(jī)制來展現(xiàn)行為上的差異,運(yùn)用fields(數(shù)據(jù)成員)來展現(xiàn)狀態(tài)上的差異。
這句話的極端例子,就是繼承出不同的classes表現(xiàn)各種不同的顏色,而不使用”color”field.
31. 當(dāng)心變異性(variance)。
語意相異的兩個對象擁有相同的動作(或說責(zé)任)是可能的。OO世界中存在著一種天生的引誘,讓人想要從某個class繼承出另一個subclass,為的是獲得繼承帶來的福利。這便是所謂”變異性”。但是,沒有任何正當(dāng)理由足以讓我們強(qiáng)迫制造出某個其實并不存在的superclass/subclass關(guān)系。比較好的解決方式是寫出一個共用的base class,它為兩個derived classes制作出共用接口–這種方式會耗用更多空間,但你可以如你所盼望地從繼承機(jī)制獲得好處,而且或許能夠在設(shè)計上獲得重大發(fā)現(xiàn)。
32. 注意繼承上的限制。
最清晰易懂的設(shè)計是將功能加到繼承得來的class里頭;繼承過程中拿掉舊功能(而非增加新功能)則是一種可疑的設(shè)計。不過,規(guī)則可以打破。如果你所處理的是舊有的class程序庫,那么在某個class的subclass限制功能,可能會比重新制定整個結(jié)構(gòu)(俾使新class得以良好地相稱于舊 class)有效率得多。
33. 使用設(shè)計模式(design patterns)來減少”赤裸裸無加掩飾的機(jī)能(naked functionality)”。
舉個例子,如果你的class只應(yīng)該產(chǎn)出惟一一個對象,那么請不要以加思索毫無設(shè)計的手法來完成它,然后撰寫”只該產(chǎn)生一份對象”這樣的注解就拍拍屁股走人。請將它包裝成singleton(譯注:一個有名的設(shè)計模式,可譯為”單件”)。如果主程序中有多而混亂的”用以產(chǎn)生對象”的程序代碼,請找出類似 factory method這樣的生成模式(creational patterns),使價錢可用以封裝生成動作減少”赤裸裸無加掩飾的機(jī)能”(naked functionality)不僅可以讓你的程序更易理解和維護(hù),也可以阻止出于好意卻帶來意外的維護(hù)者。
34. 當(dāng)心”因分析而導(dǎo)致的癱瘓(analysis paralysis)”。
請記住,你往往必須在獲得所有信息之前讓項目繼續(xù)前進(jìn)。而且理解未知部分的最好也最快的方式,通常就是實際前進(jìn)一步而不只是紙上談兵。除非找到解決辦法,否則無法知道解決辦法。Java擁有內(nèi)置的防火墻,請讓它們發(fā)揮作用。你在單一class或一組classes中所犯的錯誤,并不會傷害整個系統(tǒng)的完整性。
35. 當(dāng)你認(rèn)為你已經(jīng)獲得一份優(yōu)秀的分析、設(shè)計或?qū)崿F(xiàn)時,請試著加以演練。
將團(tuán)隊以外的某些人帶進(jìn)來-他不必非得是個顧問不可,他可以是公司其他團(tuán)隊的成員。請那個人以新鮮的姿態(tài)審視你們的成果,這樣可以在尚可輕易修改的階段找出問題,其收獲會比因演練而付出的時間和金錢代價來得高。實現(xiàn) (Implementation)
36. 一般來說,請遵守Sun的程序編寫習(xí)慣。
價錢可以在以下網(wǎng)址找到相關(guān)文檔:java.sun.com/docs/codeconv/idex.html。本書盡可能遵守這些習(xí)慣。眾多Java程序員看到的程序代碼,都有是由這些習(xí)慣構(gòu)成的。如果你固執(zhí)地停留在過去的編寫風(fēng)格中,你的(程序代碼)讀者會比較辛苦。不論你決定采用什么編寫習(xí)慣,請在整個程序中保持一致。你可以在home.wtal.de/software-solutions/jindent上找到一個用來重排Java程序的免費(fèi)工具。
37. 無論使用何種編寫風(fēng)格,如果你的團(tuán)隊(或整個公司,那就更好了)能夠加以標(biāo)準(zhǔn)化,那么的確會帶來顯著效果。這代表每個人都可以在其他人不遵守編寫風(fēng)格修改其作品,這是個公平的游戲。標(biāo)準(zhǔn)化的價值在于,分析程序代碼時所花的腦力較小,因而可以專心于程序代碼的實質(zhì)意義。
38. 遵守標(biāo)準(zhǔn)的大小寫規(guī)范。
將 class名稱的第一個字母應(yīng)為大寫。數(shù)據(jù)成員、函數(shù)、對象(references)的第一個字母應(yīng)為小寫。所有識別名稱的每個字都應(yīng)該連在一塊兒,所有非首字的第一個字母都應(yīng)該大寫。例如: ThisIsAClassName thisIsAMethodOrFieldName 如果你在static final 基本型別的定義處指定了常量初始式(constant initializers),那么該識別名稱應(yīng)該全為大寫,代表一個編譯期常量。 Packages是個特例,其名稱皆為小寫,即使非首字的字母亦是如此。域名(org, net, edu 等等)皆應(yīng)為小寫。(這是Java 1.1遷移至Java 2時的一項改變) 。
39、不要自己發(fā)明”裝飾用的”Private數(shù)據(jù)成員名稱。
通常這種的形式是在最前端加上底線和其他字符,匈牙利命名法(Hungarian notation)是其中最差的示范。在這種命名法中,你得加入額外字符來表示數(shù)據(jù)的型別、用途、位置等等。仿佛你用的是匯編語言(assembly language)而編譯器沒有提供任何協(xié)肋似的。這樣的命名方式容易讓人混淆又難以閱讀,也不易推行和維護(hù)。就讓classes和packages來進(jìn)行”名稱上的范
圍制定(name scoping)”吧。
40、當(dāng)你擬定通用性的class時,請遵守正規(guī)形式(canonical form)。
包括equals( )、hashCode( )、clone( ) ( 實現(xiàn)出Cloneable),并實現(xiàn)出Comparable和Serialiable等等。