java優(yōu)雅的代碼 一段java代碼的詳細(xì)解說

如何優(yōu)雅地在java代碼中做日志記錄

首先,業(yè)務(wù)邏輯中的日志是個性化的,無法統(tǒng)一的,只有在業(yè)務(wù)邏輯中打印才可以。

英山網(wǎng)站建設(shè)公司創(chuàng)新互聯(lián),英山網(wǎng)站設(shè)計制作,有大型網(wǎng)站制作公司豐富經(jīng)驗。已為英山上千余家提供企業(yè)網(wǎng)站建設(shè)服務(wù)。企業(yè)網(wǎng)站搭建\成都外貿(mào)網(wǎng)站制作要多少錢,請找那個售后服務(wù)好的英山做網(wǎng)站的公司定做!

其次,如果有對某個方法調(diào)用前后的,比較通用的日志,可以使用攔截器實現(xiàn)。

如何在C++/Java等代碼和注釋中優(yōu)雅地表達(dá)數(shù)學(xué)公式

注釋中可以使用 Latex或MathML。

Latex有 LatexLet 常量

MathML有 MathJax

如何寫出優(yōu)雅Java編程

如何寫出好的Java代碼

1.

優(yōu)雅需要付出代價。從短期利益來看,對某個問題提出優(yōu)雅的解決方法,似乎可能花你更多的時間。但當(dāng)它終于能夠正確執(zhí)行并可輕易套用于新案例中,不需要花上數(shù)以時計,甚至以天計或以月計的辛苦代價時,你會看得到先前所花功夫的回報(即使沒有人可以衡量這一點)。這不僅給你一個可更容易開發(fā)和調(diào)試的程序,也更易于理解和維護。這正是它在金錢上的價值所在。這一點有賴某種人生經(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è)這一小塊東西能夠神奇地處理掉最難的部分。這”一小塊”東西其實就是對象–請撰寫運用該對象的程序代碼,然后檢視對象,并將其中困難的部分再包裝成其他對象,依此類推。

4. 區(qū)分class開發(fā)者和class使用者(使用端程序員)。Class

使用者扮演著”客戶”角色,不需要(也不知道)class的底層運作方式。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)|西在整個程序生命期中都饒富價值?如果并非如此,那么,維護它們會使你付出代價。開發(fā)團隊的成員都有不維護”無益于生產(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),是來自型別檢查、異常處理等機制所賦予的內(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的大?。喝绻艽?,那么它工作量過多的機會就可能很高,那就應(yīng)該被切割。重新設(shè)計class的建議線索是:

1) 復(fù)雜的switch語句:請考慮運用多態(tài)(Polymorphism)。 2)

許多函數(shù)各自處理類型極為不同的動作:請考慮切割為多個不同的(classes)。

12. 小心冗長的引數(shù)列(argument

lists)。冗長的引數(shù)列會使函數(shù)的調(diào)用動作不易撰寫、閱讀、維護。你應(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í)行此類型別檢驗,并提供更可靠更容易的擴充性。

15. 從設(shè)計觀點來看,請找出變動的事物,并使它和不變的事物分離。也就是說,找出系統(tǒng)中可能被你改變的元素,將它們封裝于classes中。

16. 不要利用subclassing來擴充基礎(chǔ)功能。如果某個接口元素對class而言極重要,它應(yīng)該被放在base class

里頭,而不是直到衍生(derivation)時才被加入。如果你在繼承過程中加入了函數(shù),或許你應(yīng)該重新思考整個設(shè)計。

17. 少就是多。從class

的最小接口開始妨展,盡可能在解決問題的前提下讓它保持既小又單純。不要預(yù)先考量你的class被使用的所有可能方式。一旦class被實際運用,你自然會知道你得如何擴充接口。不過,一旦class被使用后,你就無法在不影響客戶程序代碼的情況下縮減其接口。如果你要加入更多函數(shù)倒是沒有問題–不會影響既有的客戶程序代碼,它們只需重新編譯即可。但即使新函數(shù)取代了舊函數(shù)的功能,也請你保留既有接口。如果你得通過”加入更多引數(shù)”的方式來擴充既有函數(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. 運用數(shù)據(jù)成員來表示數(shù)值的變化,運用經(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)就夠了。飛機上的”旅客舒適系統(tǒng)”包括數(shù)個分離的元素:座椅、空調(diào)、視訊設(shè)備等等,你會需要在飛機上產(chǎn)生許多這樣的東西。你會將它們聲明為Private成員并開發(fā)出一個全新的接口嗎?不會的,在這個例子中,元素也是Public接口的一部分,所以仍然是安全的。當(dāng)然啦,簡單聚合并不是一個常被運用的解法,但有時候的確是。

24. 試著從客戶程序員和程序維護的角度思考。你的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.

運用繼承和函數(shù)覆寫機制來展現(xiàn)行為上的差異,運用fields(數(shù)據(jù)成員)來展現(xiàn)狀態(tài)上的差異。這句話的極端例子,就是繼承出不同的classes表現(xiàn)各種不同的顏色,而不使用”color”field.31.

當(dāng)心變異性(variance)。語意相異的兩個對象擁有相同的動作(或說責(zé)任)是可能的。OO世界中存在著一種天生的引誘,讓人想要從某個class繼承出另一個subclass,為的是獲得繼承帶來的福利。這便是所謂”變異性”。但是,沒有任何正當(dāng)理由足以讓我們強迫制造出某個其實并不存在的superclass/subclass關(guān)系。比較好的解決方式是寫出一個共用的base

class,它為兩個derived

classes制作出共用接口–這種方式會耗用更多空間,但你可以如你所盼望地從繼承機制獲得好處,而且或許能夠在設(shè)計上獲得重大發(fā)現(xiàn)。

32.

注意繼承上的限制。最清晰易懂的設(shè)計是將功能加到繼承得來的class里頭;繼承過程中拿掉舊功能(而非增加新功能)則是一種可疑的設(shè)計。不過,規(guī)則可以打破。如果你所處理的是舊有的class程序庫,那么在某個class的subclass限制功能,可能會比重新制定整個結(jié)構(gòu)(俾使新class得以良好地相稱于舊

class)有效率得多。

33. 使用設(shè)計模式(design patterns)來減少”赤裸裸無加掩飾的機能(naked

functionality)”。舉個例子,如果你的class只應(yīng)該產(chǎn)出惟一一個對象,那么請不要以加思索毫無設(shè)計的手法來完成它,然后撰寫”只該產(chǎn)生一份對象”這樣的注解就拍拍屁股走人。請將它包裝成singleton(譯注:一個有名的設(shè)計模式,可譯為”單件”)。如果主程序中有多而混亂的”用以產(chǎn)生對象”的程序代碼,請找出類似

factory method這樣的生成模式(creational patterns),使價錢可用以封裝生成動作減少”赤裸裸無加掩飾的機能”(naked

functionality)不僅可以讓你的程序更易理解和維護,也可以阻止出于好意卻帶來意外的維護者。

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)時,請試著加以演練。將團隊以外的某些人帶進(jìn)來-他不必非得是個顧問不可,他可以是公司其他團隊的成員。請那個人以新鮮的姿態(tài)審視你們的成果,這樣可以在尚可輕易修改的階段找出問題,其收獲會比因演練而付出的時間和金錢代價來得高。實現(xiàn)

(Implementation)

36. 一般來說,請遵守Sun的程序編寫習(xí)慣。

37.

無論使用何種編寫風(fēng)格,如果你的團隊(或整個公司,那就更好了)能夠加以標(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é)肋似的。這樣的命名方式容易讓人混淆又難以閱讀,也不易推行和維護。就讓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的運用方式來運用你的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)。這不僅強調(diào)二者間的關(guān)聯(lián),也是通過”將class名稱嵌套置于另一個class 內(nèi)”而使同一個class

名稱在單一Package中可被重復(fù)使用。Java 容器庫在每個容器類中都定義了一個內(nèi)隱的(inner)Iterator

class,因而能夠提供容器一份共通接口。運用內(nèi)隱類的另一個原因是讓它成為private實現(xiàn)物的一部分。在這里,內(nèi)隱類會為信息隱藏帶來好處,而不是對上述的class關(guān)聯(lián)性提供肋益,也不是為了防止命名空間污染問題(namespace

pollution)。

46、任何時候你都要注意那些高度耦合(coupling)的 classes.請考慮內(nèi)隱類(inner

classes)為程序擬定和維護帶來的好處。內(nèi)隱類的使用并不是要去除classes間的耦合,而是要讓耦合關(guān)系更明顯也更便利。

47、不要成為”過早最佳化”的犧牲品。那會讓人神經(jīng)錯亂。尤其在系統(tǒng)建構(gòu)初期,先別煩惱究竟要不要撰寫(或避免)原生函數(shù)(native

methods)、要不要將某些數(shù)聲明為final、要不要調(diào)校程序代碼效率等等。你的主要問題應(yīng)該是先證明設(shè)計的正確性,除非設(shè)計本身需要某種程度的效率。

網(wǎng)頁題目:java優(yōu)雅的代碼 一段java代碼的詳細(xì)解說
分享鏈接:http://www.muchs.cn/article38/doeejpp.html

成都網(wǎng)站建設(shè)公司_創(chuàng)新互聯(lián),為您提供全網(wǎng)營銷推廣品牌網(wǎng)站設(shè)計、Google、微信公眾號、搜索引擎優(yōu)化手機網(wǎng)站建設(shè)

廣告

聲明:本網(wǎng)站發(fā)布的內(nèi)容(圖片、視頻和文字)以用戶投稿、用戶轉(zhuǎn)載內(nèi)容為主,如果涉及侵權(quán)請盡快告知,我們將會在第一時間刪除。文章觀點不代表本網(wǎng)站立場,如需處理請聯(lián)系客服。電話:028-86922220;郵箱:631063699@qq.com。內(nèi)容未經(jīng)允許不得轉(zhuǎn)載,或轉(zhuǎn)載時需注明來源: 創(chuàng)新互聯(lián)

成都網(wǎng)頁設(shè)計公司