1、Java代碼規范本規范以SUN的標準Java代碼規范為基礎，根據公司的實際需要，做一些修改。本文檔中沒有說明的地方，請參看SUN Java標準代碼規范。如果兩邊有沖突，以SUN Java標準為準。1. 標識符命名規范1.1 概述標識符的命名力求做到統一、達意和簡潔。盡量做到每個人按照規范來，多人開發如一人開發一樣。1.1.1 統一統一是指，對于同一個概念，在程序中用同一種表示方法，比如對于供應商，既可以用supplier，也可以用provider，但是我們只能選定一個使用，至少在一個Java項目中保持統一。統一是作為重要的，如果對同一概念有不同的表示方法，會使代碼混亂難以理解。即使不能取得好的

2、名稱，但是只要統一，閱讀起來也不會太困難，因為閱讀者只要理解一次。1.1.2 達意達意是指，標識符能準確的表達出它所代表的意義，比如： newSupplier, OrderPaymentGatewayService等；而 supplier1, service2，idtts等則不是好的命名方式。準確有兩成含義，一是正確，而是豐富。如果給一個代表供應商的變量起名是 order，顯然沒有正確表達。同樣的，supplier1, 遠沒有targetSupplier意義豐富。1.1.3 簡潔簡潔是指，在統一和達意的前提下，用盡量少的標識符。如果不能達意，寧愿不要簡潔。比如：theOrderNameOfTh

3、eTargetSupplierWhichIsTransfered 太長， transferedTargetSupplierOrderName則較好，但是transTgtSplOrdNm就不好了。省略元音的縮寫方式不要使用，我們的英語往往還沒有好到看得懂奇怪的縮寫。1.1.4 駱駝法則Java中，除了包名，靜態常量等特殊情況，大部分情況下標識符使用駱駝法則，即單詞之間不使用特殊符號分割，而是通過首字母大寫來分割。比如: supplierName, addNewContract，而不是 supplier_name, add_new_contract。1.1.5 英文 vs 拼音盡量使用通俗易懂的英

4、文單詞，如果不會可以向隊友求助，實在不行則使用漢語拼音，避免拼音與英文混用。比如表示歸檔，用archive比較好, 用pigeonhole則不好，用guiDang尚可接受。1.2 包名使用小寫字母如 com.amerisia.ebills，不要 com.amerisia.Ebills單詞間不要用字符隔開，比如 com.amerisia.ebills，而不要com.amerisia.ebills _util1.3 類名1.3.1 首字母大寫類名要首字母大寫，比如 LCIssueInfoManagerEJB, LCIssueAction；不要 lcIssueInfoManagerEJB, lcIs

5、sueAction.1.3.2 后綴類名往往用不同的后綴表達額外的意思，如下表：后綴名意義舉例EJB表示這個類為EJB類LCIssueInfoManagerEJBService表明這個類是個服務類，里面包含了給其他類提同業務服務的方法PaymentOrderServiceImpl這個類是一個實現類，而不是接口PaymentOrderServiceImplInter這個類是一個接口LifeCycleInterDao這個類封裝了數據訪問方法PaymentOrderDaoAction直接處理頁面請求，管理頁面邏輯了類UpdateOrderListActionListener響應某種事件的類Payme

6、ntSuccessListenerEvent這個類代表了某種事件PaymentSuccessEventServlet一個ServletPaymentCallbackServletFactory生成某種對象工廠的類PaymentOrderFactoryAdapter用來連接某種以前不被支持的對象的類DatabaseLogAdapterJob某種按時間運行的任務PaymentOrderCancelJobWrapper這是一個包裝類，為了給某個類提供沒有的能力SelectableOrderListWrapperBean這是一個POJOMenuStateBean1.4 方法名首字母小寫，如 addOr

7、der() 不要 AddOrder()動詞在前，如 addOrder()，不要orderAdd()查詢方法要查詢的內容在前，條件在后。 如getXxByXx（）動詞前綴往往表達特定的含義，如下表：前綴名意義舉例create創建createOrder()delete刪除deleteOrder()add創建，暗示新創建的對象屬于某個集合addPaidOrder()remove刪除removeOrder()init或則initialize初始化，暗示會做些諸如獲取資源等特殊動作initializeObjectPooldestroy銷毀，暗示會做些諸如釋放資源的特殊動作destroyObjectPoo

8、lopen打開openConnection()close關閉closeConnection() b ) /do something here;運算符兩邊用一個空格隔開例如：不要寫成： 逗號語句后如不換行，緊跟一個空格如下：call(a, b, c);不能如下：call(a,b,c);2.6.3 空行的使用空行可以表達代碼在語義上的分割，注釋的作用范圍，等等。將類似操作，或一組操作放在一起不用空行隔開，而用空行隔開不同組的代碼， 如圖：上例中的空行，使注釋的作用域很明顯. 連續兩行的空行代表更大的語義分割。 方法之間用空行分割（盡量用一行空行） 域之間用空行分割 超過

9、十行的代碼如果還不用空行分割，就會增加閱讀困難3. 注釋規范3.1 注釋 vs 代碼 注釋宜少二精，不宜多而濫，更不能誤導 命名達意，結構清晰， 類和方法等責任明確，往往不需要，或者只需要很少注釋，就可以讓人讀懂；相反，代碼混亂，再多的注釋都不能彌補。所以，應當先在代碼本身下功夫。 不能正確表達代碼意義的注釋，只會損害代碼的可讀性。 過于詳細的注釋，對顯而易見的代碼添加的注釋，羅嗦的注釋，還不如不寫。 注釋要和代碼同步，過多的注釋會成為開發的負擔3.2 Java Doc表明類、域和方法等的意義和用法等的注釋，要以javadoc的方式來寫。Java Doc是個類的使用者來看的，主要介紹 是什么，

10、怎么用等信息。凡是類的使用者需要知道，都要用Java Doc 來寫。非Java Doc的注釋，往往是個代碼的維護者看的，著重告述讀者為什么這樣寫，如何修改，注意什么問題等。 如下：類3.3 塊級別注釋3.3.1 塊級別注釋，單行時用 /, 多行時用 /* . */。3.3.2 較短的代碼塊用空行表示注釋作用域3.3.3 較長的代碼塊要用/*- start: -*/和/*- end: -*/包圍3.4 行內注釋行內注釋用 / 寫在行尾4 最佳實踐和禁忌4.1 每次保存的時候，都讓你的代碼是最美的程序員都是懶惰的，不要想著等我完成了功能，再來優化代碼的格式和結構，等真的把功能完成，很少有人會再愿意

11、回頭調整代碼。4.2 使用log而不是System.out.println()log可以設定級別，可以控制輸出到哪里，容易區分是在代碼的什么地方打印的，而System.out.print則不行。而且，System.out.print的速度很慢。所以，除非是有意的，否則，都要用log。至少在提交到svn之前把System.out.print換成log。4.3 每個if while for等語句，都不要省略大括號看下面的代碼：if (a b) a+;如果在以后維護的時候，需要在a b 時，把b+，一步小心就會寫成：if (a b) a+; b+;這樣就錯了，因為無論a和b是什么關系，b+都會執行。

12、 如果一開始就這樣寫：if (a b) a+;相信沒有哪個笨蛋會把b+添加錯的。而且，這個大括號使作用范圍更明顯，尤其是后面那行很長要折行時。4.4 善用TODO:在代碼中加入 /TODO: ，大部分的ide都會幫你提示，讓你知道你還有什么事沒有做。比如：if (order.isPaid() /TODO: 更新訂單4.5 在需要留空的地方放一個空語句或注釋，告述讀者，你是故意的比如：if (!exists(order) ;或：if (!exists(order) /nothing to do4.6 不要再對boolean值做true false判斷比如：if (order.isPaid() =

13、 true) / Do something here不如寫成：if (order.isPaid() /Do something here后者讀起來就很是 if order is paid, . 要比 if orders isPaid method returns true, 更容易理解4.7 減少代碼嵌套層次代碼嵌套層次達3層以上時，一般人理解起來都會困難。下面的代碼是一個簡單的例子：public void demo(int a, int b, int c) if (a b) if (b c) doJobA(); else if (b c) if (a b & b c) doJobA(); i

14、f (a b & c b) doJobB(); if (a = b & c b & a b) if (b c) doJobA(); return; doJobB() return; if (b c) if (a c) doJobC(); 利用子方法，就是將嵌套的程序提取出來放到另外的方法里。4.8 程序職責單一關注點分離是軟件開發的真理。人類自所以能夠完成復雜的工作，就是因為人類能夠將工作分解到較小級別的任務上，在做每個任務時關注更少的東西。讓程序單元的職責單一，可以使你在編寫這段程序時關注更少的東西，從而降低難度，減少出錯。4.9 變量的聲明，初始化和被使用盡量放到一起比方說如下代碼：int

15、 orderNum= getOrderNum();/do something withou orderNum herecall(orderNum);上例中的注釋處代表了一段和orderNum不相關的代碼。orderNum的聲明和初始化離被使用的地方相隔了很多行的代碼，這樣做不好，不如這樣：/do something withou orderNum hereint orderNum= getOrderNum();call(orderNum);4.10 縮小變量的作用域能用局部變量的，不要使用實例變量，能用實例變量的，不要使用類變量。變量的生存期越短，以為著它被誤用的機會越小，同一時刻程序員要關注

16、的變量的狀態越少。實例變量和類變量默認都不是線程安全的，局部變量是線程安全的。比如如下代碼：public class OrderPayAction private Order order; public void doAction() order = orderDao.findOrder(); doJob1(); doJob2(); private void doJob1() doSomething(order); private void doJob2() doOtherThing(order); 上例中order只不過擔當了在方法間傳遞參數之用，用下面的方法更好：public class

17、OrderPayAction public void doAction() order = orderDao.findOrder(); doJob1(order); doJob2(order); private void doJob1(Order order) doSomething(order); private void doJob2(Order order) doOtherThing(order); 4.11 盡量不要用參數來帶回方法運算結果比如：public void calculate(Order order) int result = 0; /do lots of computing and store it in the result order.setResult(result);public void action() order = orderDao.findOrder(); calculate(order); / do lots of things abo