一.基本原則
創(chuàng)新互聯(lián)專注于企業(yè)成都全網(wǎng)營銷推廣、網(wǎng)站重做改版、遠安網(wǎng)站定制設(shè)計、自適應(yīng)品牌網(wǎng)站建設(shè)、H5場景定制、商城網(wǎng)站開發(fā)、集團公司官網(wǎng)建設(shè)、外貿(mào)網(wǎng)站建設(shè)、高端網(wǎng)站制作、響應(yīng)式網(wǎng)頁設(shè)計等建站業(yè)務(wù),價格優(yōu)惠性價比高,為遠安等各大城市提供網(wǎng)站開發(fā)制作服務(wù)。
強制性原則:
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);//最優(yōu)先采用的寫法 }finally{ }
1.對于捕獲后,不知道干什么事情或者也不知道怎樣處理的情況,就不要捕獲異常,留給外出層去捕獲處理;
2.返回類型為集合的,在方法聲明中必須使用泛型,必須在javadoc中注明什么情況下返回null,什么情況下返回空集合。
3.對于方法、變量聲明范圍要采用如下優(yōu)先級:private、protected、public,對于變量要采用如下的優(yōu)先級:局部變量、實例變量、類變量,如果必須要采用實例變量或類變量的情況下,要保證線程安全性,如有可能盡量采用ThreadLocal保存實例變量或類變量;
4.如果不是必須,不要在循環(huán)中去定義變量或者new 對象;盡量在需要的最后一刻才去new 對象;
5.如果不是必須,不要在循環(huán)中去用try…catch;
6.類中對于比較復(fù)雜的邏輯要采用行注釋的方式進行注釋,java代碼中絕對不允許采用塊注釋(/**/)進行注釋;
7.Java類的名稱第一個子母必須大寫,有多個單詞組成的,每個單詞的首字母大寫
8.jsp的文件名必須全部小寫;
9.Spring的bean配置文件名必須小寫,格式為xxx.bean.xml,xxx.bean.xml配置文件中的 10.xwork的配置文件名必須小寫,且遵循xwork_xxx.xml的格式書寫,其中XXX是業(yè)務(wù)名稱的縮寫; 11.日志的處理; 12.代碼中嚴禁使用System.out.println()進行調(diào)試輸出,如果要使用調(diào)試信息,必須使用log.debug()。對于必要的信息使用log.info()進行輸出; 13.類中不要出現(xiàn)無用import,可以采用IDE工具進行優(yōu)化,類提交前進行代碼的格式化; 14.有業(yè)務(wù)邏輯處理的類必須寫junit單元測試類; 15.國際化的支持:ftl模板中不允許出現(xiàn)中文字符,要全部放到相應(yīng)的properties文件中,properties文件要放到和Action類同樣的目錄中;ftl的編碼要全部采用UTF-8的格式;properties文件的命名:中文:Action名稱+“_zh”+“_CN”.properties,英文:Action名稱+“_en”+“_US”.properties 16.一個程序文件最好不要超過2000行 17.盡可能縮小對象的作用域,這樣對象的可見范圍和生存期也都會盡可能地小,盡所有可能優(yōu)先采用局部變量,實在沒有辦法用全局變量的,優(yōu)先采用ThreadLocal來處理。 18.一個方法所完成的功能要單一,不同的功能封裝為不同的方法. 19.盡可能的處理異常或轉(zhuǎn)換異常,不要一味的包裝異常 20.如果對象在某個特定范圍內(nèi)必須被清理(而不是作為垃圾被回收),請使用帶有finally子句的try塊,在finally子句中進行清理。 21.對于把一些邏輯相關(guān)的類組織在一起,可以考慮把一個類的定義放在另一個類的定義中,這種情況推薦使用內(nèi)部類(比如界面層中的事件響應(yīng)等)。內(nèi)部類擁有所有外圍類所有成員的訪問權(quán)。 22.對成員變量的訪問最好通過getter/setter方法,這樣能夠保證訪問的合法性,以及代碼調(diào)整 23.優(yōu)先選擇接口而不是抽象類或具體類。如果你知道某些東西將成為基類,你應(yīng)當優(yōu)先把它們設(shè)計成接口;只有在必須放進方法定義或成員變量時,才把它修改為具體或抽象類。接口只和客戶希望的動作有關(guān)(協(xié)議),而類則傾向于關(guān)注實現(xiàn)細節(jié)。 24.使用java標準庫提供的容器。精通他們的用法,將極大地提高工作效率。優(yōu)先選擇ArrayList來處理順序結(jié)構(gòu),選擇HashSet來處理集合,選擇HashMap來處理關(guān)聯(lián)數(shù)組,選擇linkedList來處理堆棧和隊列,它對順序訪問進行了優(yōu)化,向List中間插入與刪除的開銷小,但隨機訪問則較慢。當使用前三個的時候,應(yīng)該把他們向上轉(zhuǎn)型為List、Set和Map,這樣就可以在必要的時候以其它方式實現(xiàn) 25.數(shù)組是一種效率最高的存儲和隨機訪問對象引用序列的方式,但是當創(chuàng)建了一個數(shù)組對象,數(shù)組的大小就被固定了,如果在空間不足時再創(chuàng)建新的數(shù)組進行復(fù)制,這樣效率就比ArrayList開銷大了。所以必須明確使用場景。 26.盡量使用”private”、”protected”關(guān)鍵字。一旦你把庫的特征(包括類、方法、字段)標記為public,你就再也不可能去掉他們。在這種方式下,實現(xiàn)的變動對派生類造成的影響最小,在處理多線程問題的時候,保持私有性尤其重要,因為只有Private的字段才會受到保護,而不用擔心被未受同步控制的使用所破壞。 27.禁止后臺業(yè)務(wù)代碼使用如下代碼 二.類編寫規(guī)范 類的結(jié)構(gòu)組織,一般按照如下的順序: 1.常量聲明 2.靜態(tài)變量聲明 3.成員變量聲明 4.構(gòu)造函數(shù)部分 5.Finalize部分 6.成員方法部分 7.靜態(tài)方法部分 8.這種順序是推薦的,在實際開發(fā)中可以按照一定的尺度修改,原則是程序更易讀。如對方法的排序按照重要性,或按照字母順序排列或按照方法之間的關(guān)系排列。 9.每個方法(包括構(gòu)造與finalize)都是一個段。多個變量聲明按照邏輯共同組成一個段,段與段之間以空行分隔。 10.類聲明時,要指出其訪問控制,一般為沒有修飾符,public,和private。 11.方法與方法之間,大的部分之間都需要以空行隔離。 12.編寫通用性的類時,請遵守標準形式。包括定義equals()、hasCode()、toString()、Clone(實現(xiàn)Cloneable接口),并實現(xiàn)Comparable和Serialiable接口 13.對于設(shè)計期間不需要繼承的類,盡量使用final 三.變量編寫規(guī)范 1.對成員變量, 盡量采用private 2.每一個變量聲明/定義占一行(參數(shù)變量除外),如 比int a,b; 更容易讀, 更容易查找bug 3.局部變量在使用前必須初始化,一般在聲明時初始化 4.變量的聲明要放在程序塊的開始位置 如 一種例外情況是在for語句中,定義聲明不僅不占一行,還在表達式內(nèi)部,完全采用Eclips生成,如: 5.數(shù)組的申明采用 <數(shù)據(jù)類型[] + 變量名>方式如 而不是 四.方法編寫規(guī)范 1.對成員方法,不要輕易的采用public的成員變量。主要的修飾符有public, private, protected, 無 2.空方法中方法聲明和函數(shù)體可都在一行。如: void func(){} 3.方法和方法之間空一行 4.方法的文檔注釋放在方法的緊前面,不能空一行。 5.避免過多的參數(shù)列表,盡量控制在5個以內(nèi),若需要傳遞多個參數(shù)時,當使用一個容納這些參數(shù)的對象進行傳遞,以提高程序的可讀性和可擴展性 6.方法中的循環(huán)潛套不能超過2層 7.對于設(shè)計期間不需要子類來重載的類,盡量使用final 8.每個方法盡量代碼行數(shù)盡量不要超過100行(有效代碼行,不包括注釋),但必須保證邏輯的完整性 9.接口中的方法默認級別為protected,只有很確認其它子系統(tǒng)的包會調(diào)用自己子系統(tǒng)的接口中的方法時,才將方法暴露為public. 五.語言使用及書寫規(guī)范 1.避免變量的定義與上一層作用域的變量同名。 2.方法與方法之間用需要用一空行隔開 3.局部變量在使用時刻聲明,局部變量/靜態(tài)變量在聲明時同時初始化 4.在與常數(shù)作比較時常數(shù)放在比較表達式的前面如: 5.return語句中,不要有復(fù)雜的運算。 6.switch語句,需要一個缺省的分支 以上就是本文的全部內(nèi)容,希望對大家的學習有所幫助,也希望大家多多支持創(chuàng)新互聯(lián)。if (log.isDebugEnabled())
ex.printStackTrace(); else log.error("從數(shù)據(jù)庫刪除: [" + entity.getClass().getName() + "] 實例失敗", daex);
throw new PersistenceException("從數(shù)據(jù)庫刪除: [" + entity.getClass().getName()+ "] 實例失敗", daex);
try{
something()
}catch(Exception ex)
{} new Exception()
int a; int b;
public void myMethod() { int int1 = 0; // beginning of method block if (condition) { int int2 = 0; // beginning of "if" block ...
}
}
for(int i = 0; i<100; i++)
char[] buffer;
char buffer[];
if(“simpleCase”.equals(obj))… if(null == obj)….
當前文章:養(yǎng)成良好java代碼編碼規(guī)范
文章源于:http://weahome.cn/article/jpgdce.html