欧美bbbwbbbw肥妇,免费乱码人妻系列日韩,一级黄片

養(yǎng)成良好java代碼編碼規(guī)范

 更新時間:2019年06月04日 14:50:04   作者:伊謝爾倫  
這篇文章主要介紹了如何養(yǎng)成良好java代碼編碼規(guī)范,規(guī)范需要平時編碼過程中注意,是一個慢慢養(yǎng)成的好習(xí)慣,下面小編就帶大家來一起詳細(xì)了解一下吧

一.基本原則

強制性原則:

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ù)雜的邏輯要采用行注釋的方式進(jìn)行注釋,java代碼中絕對不允許采用塊注釋(/**/)進(jìn)行注釋;

7.Java類的名稱第一個子母必須大寫,有多個單詞組成的,每個單詞的首字母大寫

8.jsp的文件名必須全部小寫;

9.Spring的bean配置文件名必須小寫,格式為xxx.bean.xml,xxx.bean.xml配置文件中的<bean id=”” ,此處的id,就是將類名的第一個字母小寫放到此處。

10.xwork的配置文件名必須小寫,且遵循xwork_xxx.xml的格式書寫,其中XXX是業(yè)務(wù)名稱的縮寫;

11.日志的處理;

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

12.代碼中嚴(yán)禁使用System.out.println()進(jìn)行調(diào)試輸出,如果要使用調(diào)試信息,必須使用log.debug()。對于必要的信息使用log.info()進(jìn)行輸出;

13.類中不要出現(xiàn)無用import,可以采用IDE工具進(jìn)行優(yōu)化,類提交前進(jìn)行代碼的格式化;

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.盡可能的處理異?;蜣D(zhuǎn)換異常,不要一味的包裝異常

20.如果對象在某個特定范圍內(nèi)必須被清理(而不是作為垃圾被回收),請使用帶有finally子句的try塊,在finally子句中進(jìn)行清理。

21.對于把一些邏輯相關(guān)的類組織在一起,可以考慮把一個類的定義放在另一個類的定義中,這種情況推薦使用內(nèi)部類(比如界面層中的事件響應(yīng)等)。內(nèi)部類擁有所有外圍類所有成員的訪問權(quán)。

22.對成員變量的訪問最好通過getter/setter方法,這樣能夠保證訪問的合法性,以及代碼調(diào)整

23.優(yōu)先選擇接口而不是抽象類或具體類。如果你知道某些東西將成為基類,你應(yīng)當(dāng)優(yōu)先把它們設(shè)計成接口;只有在必須放進(jìn)方法定義或成員變量時,才把它修改為具體或抽象類。接口只和客戶希望的動作有關(guān)(協(xié)議),而類則傾向于關(guān)注實現(xiàn)細(xì)節(jié)。

24.使用java標(biāo)準(zhǔn)庫提供的容器。精通他們的用法,將極大地提高工作效率。優(yōu)先選擇ArrayList來處理順序結(jié)構(gòu),選擇HashSet來處理集合,選擇HashMap來處理關(guān)聯(lián)數(shù)組,選擇linkedList來處理堆棧和隊列,它對順序訪問進(jìn)行了優(yōu)化,向List中間插入與刪除的開銷小,但隨機訪問則較慢。當(dāng)使用前三個的時候,應(yīng)該把他們向上轉(zhuǎn)型為List、Set和Map,這樣就可以在必要的時候以其它方式實現(xiàn)

25.數(shù)組是一種效率最高的存儲和隨機訪問對象引用序列的方式,但是當(dāng)創(chuàng)建了一個數(shù)組對象,數(shù)組的大小就被固定了,如果在空間不足時再創(chuàng)建新的數(shù)組進(jìn)行復(fù)制,這樣效率就比ArrayList開銷大了。所以必須明確使用場景。

26.盡量使用”private”、”protected”關(guān)鍵字。一旦你把庫的特征(包括類、方法、字段)標(biāo)記為public,你就再也不可能去掉他們。在這種方式下,實現(xiàn)的變動對派生類造成的影響最小,在處理多線程問題的時候,保持私有性尤其重要,因為只有Private的字段才會受到保護(hù),而不用擔(dān)心被未受同步控制的使用所破壞。

27.禁止后臺業(yè)務(wù)代碼使用如下代碼

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

二.類編寫規(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.編寫通用性的類時,請遵守標(biāo)準(zhǔn)形式。包括定義equals()、hasCode()、toString()、Clone(實現(xiàn)Cloneable接口),并實現(xiàn)Comparable和Serialiable接口

13.對于設(shè)計期間不需要繼承的類,盡量使用final

三.變量編寫規(guī)范

1.對成員變量, 盡量采用private

2.每一個變量聲明/定義占一行(參數(shù)變量除外),如

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語句中,定義聲明不僅不占一行,還在表達(dá)式內(nèi)部,完全采用Eclips生成,如:

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

5.數(shù)組的申明采用 <數(shù)據(jù)類型[] + 變量名>方式如

char[] buffer;

而不是

char buffer[];

四.方法編寫規(guī)范

1.對成員方法,不要輕易的采用public的成員變量。主要的修飾符有public, private, protected, 無

2.空方法中方法聲明和函數(shù)體可都在一行。如: void func(){}

3.方法和方法之間空一行

4.方法的文檔注釋放在方法的緊前面,不能空一行。

5.避免過多的參數(shù)列表,盡量控制在5個以內(nèi),若需要傳遞多個參數(shù)時,當(dāng)使用一個容納這些參數(shù)的對象進(jìn)行傳遞,以提高程序的可讀性和可擴展性

6.方法中的循環(huán)潛套不能超過2層

7.對于設(shè)計期間不需要子類來重載的類,盡量使用final

8.每個方法盡量代碼行數(shù)盡量不要超過100行(有效代碼行,不包括注釋),但必須保證邏輯的完整性

9.接口中的方法默認(rèn)級別為protected,只有很確認(rèn)其它子系統(tǒng)的包會調(diào)用自己子系統(tǒng)的接口中的方法時,才將方法暴露為public.

五.語言使用及書寫規(guī)范

1.避免變量的定義與上一層作用域的變量同名。

2.方法與方法之間用需要用一空行隔開

3.局部變量在使用時刻聲明,局部變量/靜態(tài)變量在聲明時同時初始化

4.在與常數(shù)作比較時常數(shù)放在比較表達(dá)式的前面如:

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

5.return語句中,不要有復(fù)雜的運算。

6.switch語句,需要一個缺省的分支

以上就是本文的全部內(nèi)容,希望對大家的學(xué)習(xí)有所幫助,也希望大家多多支持腳本之家。

相關(guān)文章

  • 解決SpringBoot運行報錯:找不到或無法加載主類的問題

    解決SpringBoot運行報錯:找不到或無法加載主類的問題

    這篇文章主要介紹了解決SpringBoot運行報錯:找不到或無法加載主類的問題,具有很好的參考價值,對大家的學(xué)習(xí)或工作有一定的參考價值,需要的朋友可以參考下
    2023-09-09
  • 淺談一下maven優(yōu)缺點及使用和特點

    淺談一下maven優(yōu)缺點及使用和特點

    這篇文章主要介紹了淺談一下maven優(yōu)缺點及使用和特點,一個項目管理工具軟件,那么maven項目有什么優(yōu)缺點呢,讓我們一起來看看吧
    2023-03-03
  • SpringBoot攔截器實現(xiàn)項目防止接口重復(fù)提交

    SpringBoot攔截器實現(xiàn)項目防止接口重復(fù)提交

    基于SpringBoot框架來開發(fā)業(yè)務(wù)后臺項目時,接口重復(fù)提交是一個常見的問題,本文主要介紹了SpringBoot攔截器實現(xiàn)項目防止接口重復(fù)提交,具有一定的參考價值,感興趣的可以了解一下
    2023-09-09
  • Java實現(xiàn)畫線、矩形、橢圓、字符串功能

    Java實現(xiàn)畫線、矩形、橢圓、字符串功能

    本篇文章主要介紹了Java實現(xiàn)畫線、矩形、橢圓、字符串功能的實例代碼,小編覺得挺不錯的,現(xiàn)在分享給大家,也給大家做個參考。一起跟隨小編過來看看吧
    2018-05-05
  • SpringBoot+Thymeleaf實現(xiàn)生成PDF文檔

    SpringBoot+Thymeleaf實現(xiàn)生成PDF文檔

    Thymeleaf是一個現(xiàn)代的服務(wù)器端?Java?模板引擎,適用于?Web?和獨立環(huán)境。Thymeleaf?的主要目標(biāo)是為您的開發(fā)工作流程帶來優(yōu)雅的自然模板,本文就來用它實現(xiàn)生成PDF,感興趣的可以了解一下
    2022-09-09
  • Java調(diào)度線程池ScheduledThreadPoolExecutor不執(zhí)行問題分析

    Java調(diào)度線程池ScheduledThreadPoolExecutor不執(zhí)行問題分析

    最近項目上反饋某個重要的定時任務(wù)突然不執(zhí)行了,很頭疼,開發(fā)環(huán)境和測試環(huán)境都沒有出現(xiàn)過這個問題。定時任務(wù)采用的是ScheduledThreadPoolExecutor,后來一看代碼發(fā)現(xiàn)踩了一個大坑。本文就來和大家聊聊這次的踩坑記錄與解決方法,需要的可以參考一下
    2023-03-03
  • Jmeter基于JDBC請求實現(xiàn)MySQL數(shù)據(jù)庫測試

    Jmeter基于JDBC請求實現(xiàn)MySQL數(shù)據(jù)庫測試

    這篇文章主要介紹了Jmeter基于JDBC請求實現(xiàn)MySQL數(shù)據(jù)庫測試,文中通過示例代碼介紹的非常詳細(xì),對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值,需要的朋友可以參考下
    2020-10-10
  • java與微信小程序?qū)崿F(xiàn)websocket長連接

    java與微信小程序?qū)崿F(xiàn)websocket長連接

    這篇文章主要為大家詳細(xì)介紹了java與微信小程序?qū)崿F(xiàn)websocket長連接,具有一定的參考價值,感興趣的小伙伴們可以參考一下
    2019-05-05
  • Java Spring注解之@Async的基本用法和示例

    Java Spring注解之@Async的基本用法和示例

    Spring為任務(wù)調(diào)度與異步方法執(zhí)行提供了注解支持,通過在方法上設(shè)置@Async注解,可使得方法被異步調(diào)用,下面這篇文章主要給大家介紹了關(guān)于Java Spring注解之@Async的基本用法和示例,需要的朋友可以參考下
    2022-03-03
  • Java通過Process類Runtime.getRuntime().exec()執(zhí)行bat腳本程序

    Java通過Process類Runtime.getRuntime().exec()執(zhí)行bat腳本程序

    用Java編寫應(yīng)用時,有時需要在程序中調(diào)用另一個現(xiàn)成的可執(zhí)行程序或系統(tǒng)命令,這篇文章主要給大家介紹了關(guān)于Java如何通過Process類Runtime.getRuntime().exec()執(zhí)行bat腳本程序的相關(guān)資料,需要的朋友可以參考下
    2024-01-01

最新評論