java開發規範總結_代碼編碼規範

来源:http://www.cnblogs.com/shouce/archive/2016/04/01/5343598.html
-Advertisement-
Play Games

規範需要平時編碼過程中註意,是一個慢慢養成的好習慣 1.基本原則 強制性原則: 1.字元串的拼加操作,必須使用StringBuilder; 2.try…catch的用法 try{ }catch{Exception e e.printStackTrace(); }finally{ }//在最外層的Ac ...


規範需要平時編碼過程中註意,是一個慢慢養成的好習慣

1.基本原則

   強制性原則:
     1.字元串的拼加操作,必須使用StringBuilder;
     2.try…catch的用法

複製代碼
try{

}catch{Exception e
    e.printStackTrace();
}finally{

}//在最外層的Action中可以使用,其它地方一律禁止使用;
複製代碼
try{
    //程式代碼
}catch(Exception e){
    //為空,什麼都不寫
}//在任何場景中都禁止使用
複製代碼
try{

}catch{Exception e
    throw new runtimeException(e);//最優先採用的寫法
}finally{

}
複製代碼

     1.對於捕獲後,不知道乾什麼事情或者也不知道怎樣處理的情況,就不要捕獲異常,留給外出層去捕獲處理;
     2.返回類型為集合的,在方法聲明中必須使用泛型,必須在javadoc中註明什麼情況下返回null,什麼情況下返回空集合。
     3.對於方法、變數聲明範圍要採用如下優先順序:private、protected、public,對於變數要採用如下的優先順序:局部變數、實例變數、類變數,如果必須要採用實例變數或類變數的情況下,要保證線程安全性,如有可能儘量採用ThreadLocal保存實例變數或類變數;
     4.如果不是必須,不要在迴圈中去定義變數或者new 對象;儘量在需要的最後一刻才去new 對象;
     5.如果不是必須,不要在迴圈中去用try…catch;
     6.類中對於比較複雜的邏輯要採用行註釋的方式進行註釋,java代碼中絕對不允許採用塊註釋(/**/)進行註釋;
     7.Java類的名稱第一個子母必須大寫,有多個單片語成的,每個單詞的首字母大寫
     8.jsp的文件名必須全部小寫;
     9.Spring的bean配置文件名必須小寫,格式為xxx.bean.xml,xxx.bean.xml配置文件中的<bean id=”” ,此處的id,就是將類名的第一個字母小寫放到此處。
    10.xwork的配置文件名必須小寫,且遵循xwork_xxx.xml的格式書寫,其中XXX是業務名稱的縮寫;
   11.日誌的處理,

if (log.isDebugEnabled())
ex.printStackTrace();
else
log.error("從資料庫刪除: [" + entity.getClass().getName() + "] 實例失敗", daex);
throw new PersistenceException("從資料庫刪除: [" + entity.getClass().getName()+ "] 實例失敗", daex);

    12.代碼中嚴禁使用System.out.println()進行調試輸出,如果要使用調試信息,必須使用log.debug()。對於必要的信息使用log.info()進行輸出;
    13.類中不要出現無用import,可以採用IDE工具進行優化,類提交前進行代碼的格式化;
    14.有業務邏輯處理的類必須寫junit單元測試類;
    15.國際化的支持:ftl模板中不允許出現中文字元,要全部放到相應的properties文件中,properties文件要放到和Action類同樣的目錄中;ftl的編碼要全部採用UTF-8的格式;properties文件的命名:中文:Action名稱+“_zh”+“_CN”.properties,英文:Action名稱+“_en”+“_US”.properties
    16.一個程式文件最好不要超過2000行
    17.儘可能縮小對象的作用域,這樣對象的可見範圍和生存期也都會儘可能地小,盡所有可能優先採用局部變數,實在沒有辦法用全局變數的,優先採用ThreadLocal來處理。
    18.一個方法所完成的功能要單一,不同的功能封裝為不同的方法.
    19.儘可能的處理異常或轉換異常,不要一味的包裝異常
    20.如果對象在某個特定範圍內必須被清理(而不是作為垃圾被回收),請使用帶有finally子句的try塊,在finally子句中進行清理。
    21.對於把一些邏輯相關的類組織在一起,可以考慮把一個類的定義放在另一個類的定義中,這種情況推薦使用內部類(比如界面層中的事件響應等)。內部類擁有所有外圍類所有成員的訪問權。
    22.對成員變數的訪問最好通過getter/setter方法,這樣能夠保證訪問的合法性,以及代碼調整
    23.優先選擇介面而不是抽象類或具體類。如果你知道某些東西將成為基類,你應當優先把它們設計成介面;只有在必須放進方法定義或成員變數時,才把它修改為具體或抽象類。介面只和客戶希望的動作有關(協議),而類則傾向於關註實現細節。
    24.使用java標準庫提供的容器。精通他們的用法,將極大地提高工作效率。優先選擇ArrayList來處理順序結構,選擇HashSet來處理集合,選擇HashMap來處理關聯數組,選擇linkedList來處理堆棧和隊列,它對順序訪問進行了優化,向List中間插入與刪除的開銷小,但隨機訪問則較慢。當使用前三個的時候,應該把他們向上轉型為List、Set和Map,這樣就可以在必要的時候以其它方式實現
    25.數組是一種效率最高的存儲和隨機訪問對象引用序列的方式,但是當創建了一個數組對象,數組的大小就被固定了,如果在空間不足時再創建新的數組進行複製,這樣效率就比ArrayList開銷大了。所以必須明確使用場景。
    26.儘量使用”private”、”protected”關鍵字。一旦你把庫的特征(包括類、方法、欄位)標記為public,你就再也不可能去掉他們。在這種方式下,實現的變動對派生類造成的影響最小,在處理多線程問題的時候,保持私有性尤其重要,因為只有Private的欄位才會受到保護,而不用擔心被未受同步控制的使用所破壞。
    27.禁止後臺業務代碼使用如下代碼

try{
    something()
}catch(Exception ex)
{}
new Exception()

2.類編寫規範

   類的結構組織,一般按照如下的順序:
     1.常量聲明
     2.靜態變數聲明
     3.成員變數聲明
     4.構造函數部分
     5.Finalize部分
     6.成員方法部分
     7.靜態方法部分
     8.這種順序是推薦的,在實際開發中可以按照一定的尺度修改,原則是程式更易讀。如對方法的排序按照重要性,或按照字母順序排列或按照方法之間的關係排列。
     9.每個方法(包括構造與finalize)都是一個段。多個變數聲明按照邏輯共同組成一個段,段與段之間以空行分隔。
     10.類聲明時,要指出其訪問控制,一般為沒有修飾符,public,和private。
     11.方法與方法之間,大的部分之間都需要以空行隔離。
     12.編寫通用性的類時,請遵守標準形式。包括定義equals()、hasCode()、toString()、Clone(實現Cloneable介面),並實現Comparable和Serialiable介面
     13.對於設計期間不需要繼承的類,儘量使用final

3.變數編寫規範

   1.對成員變數, 儘量採用private
   2.每一個變數聲明/定義占一行(參數變數除外),如

int a;
int b;

        比int a,b; 更容易讀, 更容易查找bug

   3.局部變數在使用前必須初始化,一般在聲明時初始化
   4.變數的聲明要放在程式塊的開始位置

     如

複製代碼
public void myMethod() {
  int int1 = 0; // beginning of method block
  if (condition) {
    int int2 = 0; // beginning of "if" block
    ...
  }
}
複製代碼

    一種例外情況是在for語句中,定義聲明不僅不占一行,還在表達式內部,完全採用Eclips生成,如:

for(int i = 0; i<100; i++)

    5.數組的申明採用 <數據類型[] + 變數名>方式如

char[] buffer;

而不是

char buffer[];

4.方法編寫規範

    1.對成員方法,不要輕易的採用public的成員變數。主要的修飾符有public, private, protected, 無
    2.空方法中方法聲明和函數體可都在一行。如: void func(){}
    3.方法和方法之間空一行
    4.方法的文檔註釋放在方法的緊前面,不能空一行。
    5.避免過多的參數列表,儘量控制在5個以內,若需要傳遞多個參數時,當使用一個容納這些參數的對象進行傳遞,以提高程式的可讀性和可擴展性
    6.方法中的迴圈潛套不能超過2層
    7.對於設計期間不需要子類來重載的類,儘量使用final
    8.每個方法儘量代碼行數儘量不要超過100行(有效代碼行,不包括註釋),但必須保證邏輯的完整性
    9.介面中的方法預設級別為protected,只有很確認其它子系統的包會調用自己子系統的介面中的方法時,才將方法暴露為public.

5.語言使用及書寫規範

   1.避免變數的定義與上一層作用域的變數同名。
   2.方法與方法之間用需要用一空行隔開
   3.局部變數在使用時刻聲明,局部變數/靜態變數在聲明時同時初始化
   4.在與常數作比較時常數放在比較表達式的前面如:

if(“simpleCase”.equals(obj))…
if(null == obj)….

   5.return語句中,不要有複雜的運算。
   6.switch語句,需要一個預設的分支

 


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 例如: 當我們遇到這種情況:(下拉框的隱藏值和顯示值皆為實體類進行綁定值時)下拉框的隱藏值並不能成功獲取到。 我們就可以使用下麵 的方案來解決 ok ,成功獲取到隱藏值。 還有一個,附加解決方案: ...
  • 1.實現兩級下拉框的聯動。 功能:實現點擊年級下拉框,載入對應科目的下拉框。 第一步:首先要載入年級下拉框中的數據。 01.在GradeDAL層(數據訪問層)寫一個方法,查詢所有年級的信息。 02.在GradeBLL層(業務邏輯層)調用數據訪問層的方法,返回給UI層來調用。 03.在UI層(表示層) ...
  • 自己寫實體可以完美解決這個問題。 用匿名類型也可以。 設置上下文方法如下: (jz為資料庫上下文對象) jz.Configuration.ProxyCreationEnabled = false;jz.Configuration.LazyLoadingEnabled = false; 不用這個的原因 ...
  • 如果想要將FlexChart在應用之外使用,比如使用在報表中,Web API幫助你將FlexChart導出成任何你需要的圖片格式。 下麵是實現的步驟: 1:創建FlexChart 2:調用Service 3:運行項目 第一步: 需要一個FlexChart,本文的註意力放在Web API部分。因此從一 ...
  • Github地址: day0 初始化資料庫: 輸入密碼 Aa123456 (假設你設置的密碼為這個),完成mysql的初始化。 運行程式: 在瀏覽器(Chrome)查看運行效果: 嘗試新增幾個todo看一下效果: 標記為完成: 這樣一個簡單的待辦事項就運行起來了 目前的項目大致結構: 1. appl ...
  • ################################### 方法與觀念的改變 ################################### 錯誤導向: 我在網上會看到人們怎麼優化網站,就是用yslow這樣的工具來看,工具會告訴你要怎麼做,哪方面有問題,比如我寫在文檔裡面的像這樣 ...
  • 查了下tcl wiki,tcl比較成熟的mysql庫是mysqltcl,於是到其官方網站(http://www.xdobry.de/mysqltcl/)下載3.05版本回來,讀了下README沒有什麼特殊事項,慣例性進行linux軟體安裝三部曲: ./configuremakemake instal ...
  • 源代碼:下載 VC開發程式單調的界面相信大家都是深有感觸,提到界面美化編程,人們都會說做界面不要用VC寫,太難了。一句俗語:難者不會,會者不難。VC的美化界面編程並沒有人們想像的那麼難。這篇文章是我寫的一個用戶登錄界面,但界面被我美化了,我將一步一步的來講解它的美化界面的實現步驟。相信有了這篇文章, ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發(一):使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說,近來想嘗試開發一款安卓APP,考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP,畢竟是使用Visual Studio開發工具,使用起來也比較的順手,結合微軟官方的教程進行了安卓 ...
  • 前言 QuestPDF 是一個開源 .NET 庫,用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫,它徹底改變了我們生成 PDF 文檔的方 ...
  • 項目地址 項目後端地址: https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址: ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址: http://tree ...
  • 話不多說,直接開乾 一.下載 1.官方鏈接下載: https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe,運行開始下載SQL server; 二. ...
  • 前言 隨著物聯網(IoT)技術的迅猛發展,MQTT(消息隊列遙測傳輸)協議憑藉其輕量級和高效性,已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫,為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog支持多種接收器用於日誌存儲,增強器用於添加屬性,LogContext管理動態屬性,支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項,適用於不同需求。 ...
  • 目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據,爬取信息時需要模擬瀏覽器行為,否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下: 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • 1.前言 什麼是熱更新 游戲或者軟體更新時,無需重新下載客戶端進行安裝,而是在應用程式啟動的情況下,在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR,Xlua,ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles,Addressable, ...
  • 本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺,其實像阿裡雲,騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後,它會送 ...
  • 通過以下方式可以高效,並保證數據同步的可靠性 1.API設計 使用RESTful設計,確保API端點明確,並使用適當的HTTP方法(如POST用於創建,PUT用於更新)。 設計清晰的請求和響應模型,以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證,確保接收到的數據符合預期格 ...