天天看點

java開發規範

代碼規範每家都有, 可發現開發的時候執行力很差. 是以自己小結了一下具有"可操作性"的規定. 呵呵.

1/ 所有檔案編碼為utf-8

2/ 所有操作的入口都必須log開始和結束時間, 并記錄功能點名稱 及功能負責人

3/ 及時重構

    (不要出現重複的代碼. 代碼越少, 複雜度越小, 需要大改的時候可以來一個"華麗麗的轉身". 船小好調頭)

4/ 詳細的log資訊【要知道發生了什麼】

    (測試的mm會按照你的log資訊和功能文檔來對比, 你的log資訊中有沒有實作"一對一")

5/ 自定義類要重載 tostring()方法

    (友善log的輸出)

6/ 使用枚舉而不要使用string來區分類型

    (之前使用字元串來辨別"成功"/"失敗"/"挂起", 後來發現接手的人不知道查詢條件是什麼...不要跟我說"你們的文檔呢"..當你的面對一百來篇文檔時, 你的後面還有一個老大來看着你的進度..你就會知道我說的什麼意思.)

7/ 使用stringbuffer或者stringbuilder建構長字元串而不要使用加号

8/ 寫單元測試

    (這個不太好操作. 因為測試的粒度每個項目會不一樣)

9/ 使用 findbugs 代碼自查

http://findbugs.cs.umd.edu/eclipse

一. 編碼風格規範

代碼命名規範采用sun命名規範。 代碼布局規範采用myeclipse建議(source->format)。 每個java類長度不得超過1000行;大型類需要備案。

二. 程式設計規範

代碼中禁止出現system.out/system.err調用 代碼中任何對httpsession的引用和使用必須備案 代碼中關鍵位置需要書寫完整的注釋,包括:代碼的作用,适用傳回,特殊的輸入和輸出參數等。如果此處出現過bug,需要記錄bug出現的原因以及修複辦 法。 代碼中關鍵位置和錯誤需要記錄到log中,采用apache common logs進行日志記錄。 所有某些資料庫專用的sql語句需要備案,并盡量避免。 關鍵代碼需要編寫測試用例,測試采用junit。

三. 代碼管理

代碼伺服器采用svn。 每天早上需要從svn下載下傳最新的代碼,每天晚上下班前送出本地代碼。 送出到svn的代碼需要保證可以随時運作,有問題的代碼不得送出。

四. 設計與資源限定

資料庫表每列總長度不得超過1024位元組。 超過1024位元組的表,字段數不得超過5個。 執行時長超過1秒的sql語句,每分鐘不得多于1次執行。 執行join查詢的sql語句,每秒鐘不得多于1次執行。