Java語言編程規(guī)范——編碼規(guī)范

  • 明確方法功能,精確(而不是近似)地實現(xiàn)方法設(shè)計。一個函數(shù)僅完成一件功能,即使簡單功能也應該編寫方法實現(xiàn)。
    說明:雖然為僅用一兩行就可完成的功能去編方法好象沒有必要,但用方法可使功能明確化,增加程序可讀性,亦可方便維護、測試。

  • 對方法參數(shù)的合法性檢查由方法本身負責,方法調(diào)用者不負責。
    說明:對于模塊間接口方法的參數(shù)的合法性檢查這一問題,往往有兩個極端現(xiàn)象,即:要么是調(diào)用者和被調(diào)用者對參數(shù)均不作合法性檢查,結(jié)果就遺漏了合法性檢查這一必要的處理過程,造成問題隱患;要么就是調(diào)用者和被調(diào)用者均對參數(shù)進行合法性檢查,這種情況雖不會造成問題,但產(chǎn)生了冗余代碼,降低了效率。

  • 明確類的功能,精確(而非近似)地實現(xiàn)類的設(shè)計。一個類僅實現(xiàn)一組相近的功能。
    說明:劃分類的時候,應該盡量把邏輯處理、數(shù)據(jù)和顯示分離,實現(xiàn)類功能的單一性。
    示例:
    數(shù)據(jù)類不能包含數(shù)據(jù)處理的邏輯。
    通信類不能包含顯示處理的邏輯。

  • 數(shù)據(jù)庫操作、IO操作等需要使用結(jié)束close()的對象必須在try -catch-finally 的finally中close()。
    示例:

try
{
    // ... ...
}
catch(IOException ioe)
{
    //... ...
}
finally
{
    try
    {
        out.close();
    }
    catch (IOException ioe)
    {
        //... ...
    }
}
  • 異常捕獲后,應該紀錄日志或者ex.printStackTrace() 。
    說明:若有特殊原因必須用注釋加以說明。
    示例:
try
{
    //.... ...
}
catch (IOException ioe)
{
    ioe.printStackTrace ();
}
  • 采用錯誤返回碼代替拋出異常。一個函數(shù)必須在其內(nèi)部對所有異常進行處理, 禁止主動拋出的異常(禁止使用throw new IOException()),采用錯誤返回碼代替拋出異常。
  • 注意運算符的優(yōu)先級,并用括號明確表達式的操作順序,避免使用默認優(yōu)先級。
    說明:防止閱讀程序時產(chǎn)生誤解,防止因默認的優(yōu)先級與設(shè)計思想不符而導致程序出錯。
    示例:
    下列語句中的表達式
word = (high << 8) | low     (1)
if ((a | b) && (a & c))      (2)
if ((a | b) < (c & d))       (3)

如果書寫為

high << 8 | low
a | b && a & c
a | b < c & d

雖然不會出錯,但語句不易理解;造成了判斷條件出錯。

  • 避免使用不易理解的數(shù)字,用有意義的標識來替代。涉及物理狀態(tài)或者含有物理意義的常量,不應直接使用數(shù)字,必須用有意義的靜態(tài)變量來代替。
    示例:如下的程序可讀性差。
if (state == 0)
{
    state = 1;
    ...  // program code
}

應改為如下形式:

private final static int TRUNK_IDLE = 0;
private final static int TRUNK_BUSY = 1;
private final static int TRUNK_UNKNOWN = -1;    
if (state == TRUNK_IDLE)
{
    state = TRUNK_BUSY;
    ...  // program code
}
  • 數(shù)組聲明的時候使用int index[],而不要使用int[] index。但函數(shù)返回值為數(shù)值類型時應使用int[] getIndex(),而不要使用int getIndex()[]。
    示例:
    如下程序可讀性差:
public int getIndex()[]
{
    ....
}
如下程序可讀性好:
public int[] getIndex()
{
    ....
}
  • 調(diào)試代碼的時候,禁止使用 System.out 和 System.err 進行打印,應該使用log4j統(tǒng)一打印。
    說明:代碼發(fā)布的時候可以統(tǒng)一關(guān)閉調(diào)試代碼,定位問題的時候又可以打開開關(guān)。

  • 禁止在版本正式代碼中寫測試代碼。測試代碼應使用junit單獨編寫。

  • 一個函數(shù)除注釋、空行外的代碼行數(shù)不得超過50行。如果一個函數(shù)的代碼行數(shù)超過50行,必須把它拆分為多個函數(shù),直到每個函數(shù)的代碼行數(shù)小于等于50行為止。

  • 禁止使用難懂的技巧性很高的語句。禁止使用不常用的語法。
    說明:高技巧語句不等于高效率的程序,實際上程序的效率關(guān)鍵在于算法。

建議

  • 記錄異常不要保存exception.getMessage(),而要記錄exception.toString()。
    示例:NullPointException拋出時常常描述為空,這樣往往看不出是出了什么錯。

  • 異常捕獲盡量不要直接 catch (Exception ex),應該把異常細分處理。

  • 如果多段代碼重復做同一件事情,那么在方法的劃分上可能存在問題。
    說明:若此段代碼各語句之間有實質(zhì)性關(guān)聯(lián)并且是完成同一件功能的,那么可考慮把此段代碼構(gòu)造成一個新的方法。

  • 源程序中關(guān)系較為緊密的代碼應盡可能相鄰。
    說明:便于程序閱讀和查找。
    示例:矩形的長與寬關(guān)系較密切,放在一起。

rect.length = 10;
rect.width = 5;
最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 227,250評論 6 530
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 97,923評論 3 413
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 175,041評論 0 373
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經(jīng)常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 62,475評論 1 308
  • 正文 為了忘掉前任,我火速辦了婚禮,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 71,253評論 6 405
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 54,801評論 1 321
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 42,882評論 3 440
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 42,023評論 0 285
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 48,530評論 1 331
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 40,494評論 3 354
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發(fā)現(xiàn)自己被綠了。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 42,639評論 1 366
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,177評論 5 355
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點故事閱讀 43,890評論 3 345
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,289評論 0 25
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 35,552評論 1 281
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 51,242評論 3 389
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 47,626評論 2 370

推薦閱讀更多精彩內(nèi)容

  • Spring Cloud為開發(fā)人員提供了快速構(gòu)建分布式系統(tǒng)中一些常見模式的工具(例如配置管理,服務發(fā)現(xiàn),斷路器,智...
    卡卡羅2017閱讀 134,775評論 18 139
  • 1. Java基礎(chǔ)部分 基礎(chǔ)部分的順序:基本語法,類相關(guān)的語法,內(nèi)部類的語法,繼承相關(guān)的語法,異常的語法,線程的語...
    子非魚_t_閱讀 31,704評論 18 399
  • Android 自定義View的各種姿勢1 Activity的顯示之ViewRootImpl詳解 Activity...
    passiontim閱讀 172,574評論 25 707
  • (一)Java部分 1、列舉出JAVA中6個比較常用的包【天威誠信面試題】 【參考答案】 java.lang;ja...
    獨云閱讀 7,127評論 0 62
  • 樹語 序 夏去了,心氣勁兒也沒有了,聽到風一絲悲涼的嘆息。 薄日初生,暈紅了天的唇。 似乎今天,天空美了一點點,起...
    月似故鄉(xiāng)明s閱讀 202評論 0 1