引言
-
爲代碼添加註釋（Add comments to your code）.– 每個人都知道這一點，但不是每個人都會這麼做。你有多少次“忘記”添加註釋了？確實，註釋不會爲你的程序增加任何函數功能。但是，有多少次，看到2周前寫的代碼，你都記不起它是幹什麼的？你很幸運，那些未註釋的代碼是你自己寫的，你腦海中還會有殘存的印象。非常不幸，大多時候，代碼是別人寫的，並且那個人很可能已經離開公司了。有句諺語說的好：“有來有往，互惠互利”，因此程序員應該體諒彼此（還有你自己），給你的代碼加上註釋。
2. 不要把簡單事情複雜化（Do not complicate things）.– 我曾經這麼做過，我相信你也一樣。開發者都傾向於採用複雜方式解決簡單問題。我們在一個只有5個用戶的系統中引入EJB，爲一個並不需要框架的應用實現一套框架，採用屬性文件、採用面向對象解決方案、使用線程，而這些根本用不着。爲什麼會這麼做？一些人可能不知道有更好的解決方案，但另一些人可能故意這樣做來學習新知識，或僅僅是因爲有趣。對那些不知道更好解決方案的人，要多聽有經驗程序員的建議。對於那些純粹出於個人目的而將設計複雜化的人，我建議你要更加專業一點。
3. 記住 － “越少越好”並非總是如此(Keep in Mind – “Less is more” is not always better).– 高效率的代碼是件好事，但很多情況下，並非代碼行數越少效率就越高。看下面這個“簡單”的例子：
if(newStatusCode.equals("SD") && (sellOffDate ==null|| todayDate.compareTo(sellOffDate)<0|| (lastUsedDate !=null&& todayDate.compareTo(lastUsedDate)>0)) ||(newStatusCode.equals("OBS") && (OBSDate ==null|| todayDate.compareTo(OBSDate)<0))){newStatusCode ="NYP"; }
指出這個if條件是什麼有多困難？再設想一下，寫這段代碼的人並沒遵循第1條 － 爲代碼添加註釋。
把if條件分解成2個if語句不是更容易理解嗎？現在讓我們看一下修改過的代碼：
if(newStatusCode.equals("SD") && (sellOffDate ==null|| todayDate.compareTo(sellOffDate)<0|| (lastUsedDate !=null&& todayDate.compareTo(lastUsedDate)>0))){newStatusCode="NYP"; }elseif(newStatusCode.equals("OBS") && (OBSDate ==null|| todayDate.compareTo(OBSDate)<0)) { newStatusCode="NYP"; }
這樣可讀性不是更好嗎？的確，我們寫了重複語句；的確，我們多寫了一個if和2個大括號；但是代碼確實更加易讀、更加容易理解了！
4. 不要“硬編碼”（No hard coding please）.– 由於時間緊迫，開發者總是會忘記或故意忽略這一條。然而另一種可能是，遵循這條戒律，我們就不會陷入“時間緊迫”的困境。定義一個static final 變量，增加一行代碼，又能花多長時間呢？譬如：
/**
* Java學習交流QQ羣：589809992 我們一起學Java！
*/publicclassA{publicstaticfinalString S_CONSTANT_ABC ="ABC";publicbooleanmethodA(String sParam1){if(A.S_CONSTANT_ABC.equalsIgnoreCase(sParam1)){returntrue; }returnfalse; } }
現在，每次需要比較字符串“ABC”與某個變量的時候，我們只要引用 A.S_CONSTANT_ABC 即可，而不必記住它本身是什麼。對這個常量的修改也非常方便，改一個地方即可，而不必在全部代碼中查找。
5. 不要發明你自己的框架（Do not invent your own frameworks）.– 不誇張地講，已經有幾千個框架存在了，大多數還是開源的。很多框架都是極完美的解決方案，並已被用到成千的系統中。我們只要關注最新的流行的框架，至少表面上要熟悉一下。一個最成功的、也是被廣泛使用的例子是Struts框架，這個開源的web框架是建立web系統的極佳選擇，不要試圖構造你自己的Struts版本，會累死的。但你必須記住第2條（譯註：原文是“第3條”，顯然不對）戒律 —— 不要把簡單事情複雜化。如果你要開發的系統只有3個界面，就不要用Struts. 對於這樣一個系統，沒有足夠的需要被“控制”的東西（譯註：Struts將界面做MVC劃分，C即controller，所以作者說there isn’t much “controlling” required）。
6. 對Print行或字符串說不（Say no to Print lines and String Concatenations）.– 我知道爲了調試方便，程序員喜歡到處用System.out.println ,然後對自己說過一會就刪掉。但我們常常忘記刪掉這些行或不願刪掉，我們用System.out.println 做測試，爲什麼測完後還要去改代碼？這很可能導致誤刪一行我們需要的代碼。不要低估System.out.println 的危害，看下面代碼：
publicclassBadCode{publicstaticvoidcalculationWithPrint(){doublesomeValue =0D;for(inti =0; i <10000; i++) { System.out.println(someValue = someValue + i); } }publicstaticvoidcalculationWithOutPrint(){doublesomeValue =0D;for(inti =0; i <10000; i++) { someValue = someValue + i; } }publicstaticvoidmain(String [] n){ BadCode.calculationWithPrint(); BadCode.calculationWithOutPrint(); } }
下面表格可以看出，calculationWithOutPrint()
方法執行時間是0.001204 s. 作爲對比，calculationWithPrint() 方法居然需要令人難以置信的10.52 s來執行！
(若你想知道怎麼做一個這樣的表，請閱讀另一篇文章”Java Profiling with WSAD” Java Profiling with WSAD )
爲了避免CPU浪費，最好的辦法是引入一個包裝的方法，如下：
/**
* Java學習交流QQ羣：589809992 我們一起學Java！
*/publicclassBadCode{publicstaticfinalintDEBUG_MODE =1;publicstaticfinalintPRODUCTION_MODE =2;publicstaticvoidcalculationWithPrint(intlogMode){doublesomeValue =0D;for(inti =0; i <10000; i++) { someValue = someValue + i; myPrintMethod(logMode, someValue); } }publicstaticvoidmyPrintMethod(intlogMode,doublevalue){if(logMode > BadCode.DEBUG_MODE) {return; } System.out.println(value); }publicstaticvoidmain(String [] n){ BadCode.calculationWithPrint(BadCode.PRODUCTION_MODE); } }
字符串(String)連接是另一種CPU浪費方式，看下面的例子：
publicstaticvoidconcatenateStrings(StringstartingString) {for(inti =0; i <20; i++) { startingString = startingString + startingString; } }publicstaticvoidconcatenateStringsUsingStringBuffer(StringstartingString) { StringBuffer sb =newStringBuffer(); sb.append(startingString);for(inti =0; i <20; i++) { sb.append(sb.toString()); } }
從下面表格可以看出使用 StringBuffer只要花
0.01 s 而使用String 連接需要0.08 s，選擇哪種應該很明顯了。
7. 注意圖形用戶界面（Pay attention to the GUI）. – 無論聽上去多荒謬，但有一點我注意過多次了：圖形用戶界面（GUI）對於商業用戶而言與程序功能及執行效率一樣重要。GUI對於應用程序的成功至關重要。 IT管理者（譯註：這裏應該是指程序開發方的IT management）常常忽略GUI的重要性，很多公司爲了省錢而不僱傭Web設計人員，而這些設計人員有足夠的經驗來設計“用戶友好”的應用軟件。 Java程序員不得不依賴他們有限的HMTL知識。我見過非常多對“計算機友好”而非對“用戶友好”的應用程序，同時精通軟件開發和用戶界面開發的開發者非常少見。 如果你是一位不幸被指派做界面開發的Java程序員，你要遵循下面3條規則：
不要重新發明輪子。去看那些類似應用系統的界面。
首先建立一個原型。這一步非常關鍵。客戶喜歡提前看到他們要用的東西。同樣你可以得到他們的反饋，而不是你辛辛苦苦做出來一個客戶不喜歡的東西。
試戴用戶的帽子。換句話說，站在用戶的角度查看需求。譬如，一個統計的界面可以分頁，也可以不分頁。作爲開發者，很可能會忽略分頁，因爲這會減少很多麻煩；而站在客戶角度，這就不是一個好的方案，因爲數據可能多達幾百行。
8. 提前準備需求文檔（Always Prepare Document Requirements）.– 每項業務需求都記入文檔。這在童話故事中可能實現，而現實中很難做到。無論時間多麼緊迫，無論截止日期如何迫近，你必須確保業務需求被記錄下來。（譯註：這條明顯悖于敏捷開發的觀念，大家要獨立思考，甄別是非）
9. 單元測試，單元測試，單元測試 （Unit-test. Unit-test. Unit-test）.– 我不準備討論如何單元測試的細節，我只是想說這必須要做。這是編程中最基本的規則了，尤其不能忽略。如果你同事能爲你的代碼創建一個測試計劃，那就再好不過了；如果不能，那就要自己做。做單元測試計劃時，遵循下面原則：
編碼前就寫單元測試
保留單元測試的註釋
對任何“有趣的”公共方法都要做單元測試（“有趣的”是指除了像最常見的getter/setter這類方法外的方法，但包含有自己內容的getter/setter 方法）
10. 記住：質量，而非數量（Remember – quality, not quantity）.- 不要待的太晚（除非有必要）。我知道有時因爲產品問題，截止期限或其他突發事件，不能按時下班。但經理不會因爲你爲一般問題待的太晚而感激或獎勵你；他們會爲有質量的工作而感激你。如果你遵循上面的列的原則，你就會寫更健壯的、少bug的程序。這纔是你最應該做的
總結
想了解學習Java方面的技術以及學習進階哪方面的技術知識點等
可加羣：722040762 驗證碼：666（CSDN）歡迎大家的加入喲
微服務、分佈式、高併發、高可用，性能優化丶源碼分析等等一些技術等着你來探討學習！
歡迎關注CSDN:JAVA編程大飛哥
覺得收穫的話可以點個關注評論轉發一波喔，謝謝大佬們支持！
最後，每一位讀到這裏的Java程序猿朋友們，感謝你們能耐心地看完。希望在成爲一名更優秀的Java程序猿的道路上，我們可以一起學習、一起進步！都能贏取白富美，走向架構師的人生巔峯!