Java開發(fā)規(guī)范

1、培訓(xùn)綱要培訓(xùn)綱要前言概述前言概述1WEB規(guī)范規(guī)范2Java規(guī)范規(guī)范3數(shù)據(jù)庫規(guī)范數(shù)據(jù)庫規(guī)范45基本概念基本概念v開發(fā)規(guī)范 在軟件開發(fā)過程中，為了讓開發(fā)人員間便于交流和協(xié)作，并起到“指導(dǎo)開發(fā)”和“規(guī)范開發(fā)”作用的條文。從軟件工程的項(xiàng)目生命周期而言，開發(fā)過程主要涉及設(shè)計(jì)和編碼兩個(gè)過程域。v編碼規(guī)范 系統(tǒng)編碼過程中，項(xiàng)目工程所涉及到的文件內(nèi)容編輯的代碼規(guī)則。范圍定義范圍定義v開發(fā)規(guī)范 開發(fā)規(guī)范涉及范圍較廣，編碼規(guī)范最為核心。除此之外的規(guī)范有：設(shè)計(jì)規(guī)范、開發(fā)環(huán)境、部署環(huán)境、內(nèi)部軟件平臺(tái)或軟件成品使用以及項(xiàng)目管理涉及的相關(guān)規(guī)約。v編碼規(guī)范 針對(duì)公司主要是WEB項(xiàng)目的特點(diǎn)，編碼規(guī)范涉及的范圍有：WEB規(guī)范、

2、Java規(guī)范、數(shù)據(jù)庫規(guī)范培訓(xùn)綱要培訓(xùn)綱要前言概述前言概述1WEB規(guī)范規(guī)范2Java規(guī)范規(guī)范3數(shù)據(jù)庫規(guī)范數(shù)據(jù)庫規(guī)范45WEB規(guī)范規(guī)范v目錄結(jié)構(gòu)v命名v注釋vUIv代碼目錄結(jié)構(gòu)目錄結(jié)構(gòu) 根目錄有images、script、style、WEB-INF四個(gè)目錄以外，可創(chuàng)建如：platform（業(yè)務(wù)平臺(tái)）、skyflow（工作流）公司復(fù)用產(chǎn)品文件夾等。（執(zhí)行） 根目錄中可創(chuàng)建項(xiàng)目應(yīng)用目錄，應(yīng)用目錄下可逐級(jí)創(chuàng)建子系統(tǒng)、功能模塊的文件夾，最好不要超過3層。（建議） 根目錄中，項(xiàng)目組研發(fā)人員對(duì)項(xiàng)目應(yīng)用目錄有權(quán)限修改，其他目錄不允許修改。（執(zhí)行） 項(xiàng)目應(yīng)用目錄下的子系統(tǒng)、功能模塊目錄不能讓研發(fā)人員隨意修改，由項(xiàng)

3、目經(jīng)理或分配專人統(tǒng)一設(shè)計(jì)。（建議）命名規(guī)范命名規(guī)范v文件夾 英文或中文首字母來表達(dá)目錄的“作用”或“功能”，推薦采用英文較為規(guī)范。（建議）v文件 除特定的頁面之外，如index.jsp，一般采用“作用”或“功能”+“名詞”和“作用”或“功能”+“動(dòng)詞”；也可以在兩者之間添加下劃線“_”。（建議） 文件命名與目錄一樣，統(tǒng)一使用小寫字母。如：draft_do.jsp。如不使用下劃線，單詞連接首字母要大寫，如：draftDo.jsp（執(zhí)行）命名規(guī)范命名規(guī)范v標(biāo)簽、樣式（待補(bǔ)充）v腳本 “方法”命名采用“動(dòng)詞”或“動(dòng)賓”結(jié)構(gòu)，多個(gè)單詞之間可添加下劃線“_”或單詞連接首字母要大寫；腳本命名統(tǒng)一使用小寫字

4、母。舉例來說，“動(dòng)詞”命名，如：trim(str)、save()；“動(dòng)賓”結(jié)構(gòu)命名，如：send_mail()、openPage()、isNumber()（執(zhí)行） “內(nèi)部變量與參數(shù)”命名采用“名字”來命名。多個(gè)單詞之間可添加下劃線“_”或單詞連接首字母要大寫。舉例：var windowWidth; var file_size（執(zhí)行）注釋規(guī)范注釋規(guī)范v文件 文件代碼頂部必須存在一個(gè)基本描述注釋，包含文件名、功能描述、參數(shù)列表和歷史修改信息。（執(zhí)行） Jsp文件的HTML代碼中，如需添加HTML注釋的，自行定義注釋格式，簡潔就好。HTML注釋：（建議）v腳本 方法注釋在方法體頭部添加注釋說明，主要

5、描述腳本方法的功能和參數(shù)。（執(zhí)行） 變量注釋在方法體內(nèi)部定義變量時(shí)進(jìn)行說明，臨時(shí)變量可不注釋。（建議） 腳本塊注釋在腳本方法體內(nèi)部存在if-else、循環(huán)語句和特定的功能代碼塊需要增加注釋。（執(zhí)行）UI規(guī)范規(guī)范v樣式 應(yīng)根據(jù)客戶需求委托美工設(shè)計(jì)頁面樣式，頁面樣式提交給項(xiàng)目組，項(xiàng)目組不允許隨便添加CSS樣式。（執(zhí)行）v布局 功能按鈕在頁面位置以及樣式要一致，尤其按鈕的大小和背景顏色（客戶特別要求的除外）。（執(zhí)行） 常規(guī)頁面，如：檢索頁面、列表頁面、編輯頁面，頁面中表格大小、表格線條樣式、form表單中元素樣式以及排版要一致。（建議） 列表頁面各列表項(xiàng)的數(shù)據(jù)信息是“居中”還是“居左”要統(tǒng)一設(shè)計(jì)，同

6、類的列展現(xiàn)方式保持一致；form表單內(nèi)的各數(shù)據(jù)項(xiàng)必填標(biāo)識(shí)要一致（執(zhí)行） 常規(guī)功能模塊中，編輯頁面的表格寬度一般設(shè)置為“640”。高度推薦控制在一屏之內(nèi)。（建議）代碼規(guī)范代碼規(guī)范v排版 Jsp代碼中Java代碼的“”要頂頭寫。（執(zhí)行） 腳本代碼同一層級(jí)需要對(duì)齊；子代碼應(yīng)該在父代碼后換行縮進(jìn)，縮進(jìn)寬度統(tǒng)一為4個(gè)空格。（執(zhí)行）v表單校驗(yàn) 校驗(yàn)內(nèi)容：必填數(shù)據(jù)項(xiàng)、邏輯數(shù)據(jù)項(xiàng)、數(shù)據(jù)項(xiàng)長度。與業(yè)務(wù)無關(guān)的復(fù)用腳本函數(shù)必須統(tǒng)一，不允許開發(fā)人員隨意添加修改。如：判斷身份證號(hào)、數(shù)字、不為空等。（執(zhí)行）v操作提示 項(xiàng)目經(jīng)理要統(tǒng)一定義各類操作提示（推薦使用配置文件或宏定義方式統(tǒng)一管理，在操作提示時(shí)統(tǒng)一調(diào)用）。（執(zhí)行）培

7、訓(xùn)綱要培訓(xùn)綱要前言概述前言概述1WEB規(guī)范規(guī)范2Java規(guī)范規(guī)范3數(shù)據(jù)庫規(guī)范數(shù)據(jù)庫規(guī)范45Java規(guī)范規(guī)范v目錄結(jié)構(gòu)v排版v命名v注釋v聲明v類、接口v函數(shù)v表達(dá)式、語句v性能與安全目錄結(jié)構(gòu)目錄結(jié)構(gòu) 根目錄下存在的包基本有：基本包、配置文件包、開源包。項(xiàng)目中，公用或平臺(tái)配置文件一律在配置文件包下創(chuàng)建；項(xiàng)目中的包、類、文件在基本包下創(chuàng)建。（執(zhí)行） 基本包：com.skytech；配置文件包：config；開源包：按照開源產(chǎn)品默認(rèn)的包路徑。（執(zhí)行） 項(xiàng)目的包按如下規(guī)則組成：基本包.項(xiàng)目.模塊.子模塊。在基本包下，除了項(xiàng)目包外，還允許創(chuàng)建公司自研、重用整理的成品包，如：業(yè)務(wù)平臺(tái)包（platform）

8、、工作流引擎（easyflow）、通用工具類包（common、tools、util、web）。（執(zhí)行）排版規(guī)范排版規(guī)范v縮進(jìn) 子代碼塊應(yīng)當(dāng)在父代碼塊后進(jìn)行縮進(jìn)；縮進(jìn)寬度統(tǒng)一設(shè)置為4個(gè)空格。（執(zhí)行） 子代碼塊層級(jí)太多導(dǎo)致縮進(jìn)太深時(shí)將代碼塊提取出來創(chuàng)建子函數(shù) 。（建議）v長度 單個(gè)函數(shù)的行數(shù)一般控制在150行以內(nèi)；過長時(shí)將抽取創(chuàng)建子函數(shù)。（建議） 單個(gè)類的長度包括注釋不超過1500行；多長時(shí)應(yīng)考慮重構(gòu)其他類。（建議）排版規(guī)范排版規(guī)范v行寬 編碼的行寬在80-120之間，Sun Java開發(fā)規(guī)范（版本2.0alpha）規(guī)定行寬為80。（建議）v間隔 方法及功能塊間需空行間隔，但不允許出現(xiàn)大片空行；操

9、作符兩端應(yīng)當(dāng)各空一個(gè)字符。（執(zhí)行）v對(duì)齊 同一層級(jí)編碼需對(duì)齊，編碼換行需對(duì)齊。（執(zhí)行）v括號(hào) 中的語句應(yīng)該單獨(dú)作為一行，左括號(hào)當(dāng)緊跟其語句后，右括號(hào)永遠(yuǎn)單獨(dú)作為一行且與其匹配行對(duì)齊。（執(zhí)行）命名規(guī)范命名規(guī)范v包 包一般采用項(xiàng)目名或模塊名來命名，少用英文縮寫和過長名稱，包名一律小寫。（執(zhí)行）v類、接口 類、接口一般采用能確切描述該類、接口含義或功能、作用的單詞來命名，一般采用名詞。所有單詞首字母大寫； 接口類命名添加前綴“I”，抽象類添加前綴“Abstract”，接口實(shí)現(xiàn)類、抽象繼承類添加后綴“Impl”；異常類名由表示該異常類型的單詞+Exception組成，如：SQLException。（執(zhí)

10、行）命名規(guī)范命名規(guī)范v成員/變量 常量命名采用大寫字母，多個(gè)單詞之間添加下劃線“_”如：MAX_NUM。（執(zhí)行） 對(duì)不易識(shí)別變量類型的變量應(yīng)添加類型縮寫作其前綴，如：字符串型strXXX，布爾型isXXX、hasXXX等。（建議） 變量命名有多個(gè)單詞時(shí)，除第一個(gè)單詞外，其余單詞首字母大寫。（執(zhí)行） 對(duì)私有實(shí)例變量可添加“_”前綴，但在其存取方法中則應(yīng)該將其前綴去掉。（建議） 集合命名應(yīng)采用完整的英文描述符，名字中所有非開頭的單詞的第一個(gè)字母應(yīng)大寫，適當(dāng)使用集合后綴。（建議） 命名時(shí)應(yīng)使用復(fù)數(shù)來表示它們代表多值，如：userNames（建議）命名規(guī)范命名規(guī)范v函數(shù) 除構(gòu)造函數(shù)采用類名外，一般函數(shù)

11、用“動(dòng)賓”結(jié)構(gòu)來命名，如get、set函數(shù)，以及判斷類函數(shù)添加is(has)前綴或直接采用動(dòng)詞來命名，如：save()、update()。（執(zhí)行）注釋規(guī)范注釋規(guī)范v包 在源碼相應(yīng)包路徑下建立package.xml以描述包的功能作用等。（建議）v類、接口 類、接口注釋信息要包含文件名、功能描述、作者、版本、版權(quán)信息以及修改記錄。（執(zhí)行）v函數(shù) 對(duì)函數(shù)進(jìn)行注釋，需明確該函數(shù)功能作用、各參數(shù)含義以及返回值等。（執(zhí)行） 參數(shù)注釋時(shí)當(dāng)注明其取值范圍等；返回值當(dāng)注釋出失敗、錯(cuò)誤、異常時(shí)的返回情況。（建議）注釋規(guī)范注釋規(guī)范v成員/變量 類中的常量或不變量都要給出注釋；應(yīng)對(duì)重要的變量加以注釋，注釋信息一般需說

12、明作用或目的。（執(zhí)行） 常量或不變量采用行尾注釋；重要變量采用單行注釋。（執(zhí)行） 在同一代碼塊或同一局部的多個(gè)常量或變量的定義時(shí)，注意行尾注釋要對(duì)齊。（建議）注釋規(guī)范注釋規(guī)范v代碼塊 代碼塊注釋信息一般要包含代碼作用或功能描述、作者和時(shí)間，有的注釋還包含代碼塊的原因以及修改歷史等；代碼塊一般采用的塊注釋（多行注釋）。（建議） 代碼塊行數(shù)較多時(shí)，一般通過塊注釋 + 單行注釋來標(biāo)注代碼塊，在塊注釋結(jié)束行換行添加單行注釋標(biāo)注代碼塊的開始，在代碼塊的結(jié)束處換行添加單行注釋標(biāo)注代碼塊的結(jié)束。（建議） 較長的代碼塊的右括號(hào)后應(yīng)使用/end .等標(biāo)識(shí)其結(jié)束，如： if-else塊結(jié)束：/end if use

13、rId is not null；循環(huán)快結(jié)束：/end for userList（建議）聲明規(guī)范聲明規(guī)范v包 在導(dǎo)入包時(shí)要直接導(dǎo)入使用類的名字，盡量少用通配符的方式，如導(dǎo)入一些通用包且用到一個(gè)包下大部分類時(shí)，則可是使用通配符方式。（建議）v類、接口 定義語法規(guī)范：可見性(abstract|final) Class|Interface class_name (extends|implements)父類或接口名。（執(zhí)行）聲明規(guī)范聲明規(guī)范v函數(shù) 盡量限制成員函數(shù)的可見性。如果成員函數(shù)沒必要公有(public)，就定義為保護(hù)(protected)；沒必要保護(hù)(protected)，就定義為私有(priv

14、ate)。（建議） 定義語法規(guī)范：可見性(abstract|final) synchronized返回值類型 method_name(參數(shù)列表)(throws)異常列表 （執(zhí)行） 聲明順序：構(gòu)造函數(shù) 靜態(tài)公共函數(shù) 靜態(tài)私有函數(shù) 受保護(hù)函數(shù)。若有toString()，equals()，hashCode()，colone()等重載Object的函數(shù)放在類的最后。（建議）聲明規(guī)范聲明規(guī)范v成員/變量 定義語法規(guī)范：(public|private|protected) (final|volatile)statictransient data_type field_name = expression ;

15、（執(zhí)行） 若沒有足夠理，不要把實(shí)例或類變量聲明為公有。通常，實(shí)例變量無需顯式的設(shè)置(set)和獲取(get)。（建議） 局部變量所取的名字，不可與另一個(gè)更大范圍內(nèi)定義的變量的名字相同(或相似)。（執(zhí)行） 一行代碼只聲明一個(gè)變量,僅將一個(gè)變量用于一件事。（執(zhí)行） 聲明順序：常量 類變量 實(shí)例變量 公有字段 受保護(hù)字段 私有字段。（建議）類、接口類、接口 多使用設(shè)計(jì)模式，方便重構(gòu)；多個(gè)類中使用相同方法時(shí)將其方法提到一個(gè)接口中或使用抽象類，盡量提高重用度。（建議） 將不希望再被繼承的類聲明成final，例如某些實(shí)用類，但不要濫用final，否則會(huì)對(duì)系統(tǒng)的可擴(kuò)展性造成影響。（建議） 被實(shí)例化的類的缺省

16、構(gòu)造函數(shù)不可聲明成private。（執(zhí)行）函函 數(shù)數(shù)v基本原則 一個(gè)函數(shù)只完成一項(xiàng)功能，盡量縮小其可見性。（建議） 避免用一個(gè)類是實(shí)例去訪問其靜態(tài)變量和函數(shù)；避免在一個(gè)方法里提供多個(gè)出口（只允許一個(gè)return） 。（執(zhí)行）v參數(shù)/返回值 避免過多的參數(shù)，應(yīng)控制在5個(gè)以內(nèi)，若需傳遞多個(gè)參數(shù)時(shí)，用一個(gè)容納這些參數(shù)的對(duì)象進(jìn)行傳遞； （建議） 參數(shù)和返回值類型接口化，屏蔽具體的實(shí)現(xiàn)細(xì)節(jié)。（執(zhí)行）v異常 異常處理時(shí)應(yīng)考慮錯(cuò)誤狀態(tài)返回值。（建議）表達(dá)式與語句表達(dá)式與語句v基本原則 每行至多包含一條執(zhí)行語句，過長當(dāng)換行。（建議） 避免在構(gòu)造函數(shù)中執(zhí)行大量耗時(shí)的初始化工作，如果不可避免，則當(dāng)使用對(duì)象池和Ca

17、che等技術(shù)提高系統(tǒng)性能；避免在一個(gè)語句中給多個(gè)變量賦相同的值；不要使用內(nèi)嵌(embedded)賦值運(yùn)算符試圖提高運(yùn)行時(shí)的效率（執(zhí)行） 盡量在聲明局部變量的同時(shí)初始化；在含有多種運(yùn)算符的表達(dá)式中使用圓括號(hào)來避免運(yùn)算符優(yōu)先級(jí)問題（建議）v返回語句 一個(gè)帶返回值的return語句不使用小括號(hào)“()”，除非它們以某種方式使返回值更為顯見。（執(zhí)行）表達(dá)式與語句表達(dá)式與語句vif-else語句 所有if語句必須用包括起來，即便是只有一句。（執(zhí)行） 過多的else分句轉(zhuǎn)成switch語句或使用子函數(shù)。（建議）v循環(huán)語句 當(dāng)在for語句的初始化或更新子句中使用逗號(hào)時(shí)，避免因使用三個(gè)以上變量，而導(dǎo)致復(fù)雜度提高

18、。（執(zhí)行） 循環(huán)中必須有終止循環(huán)的條件或語句，避免死循環(huán)。（執(zhí)行） 盡量避免在其中調(diào)用耗時(shí)或費(fèi)資源的操作。（建議）性能與安全性能與安全v字符串 如字符串必須不斷地在其后添加許多字符來完成構(gòu)造，應(yīng)使用StringBuffer對(duì)象和它的append()方法，當(dāng)工作完成后將StringBuffer對(duì)象再轉(zhuǎn)換為需要的String對(duì)象。（建議）v對(duì)象 避免在循環(huán)中頻繁構(gòu)建和釋放對(duì)象；不再使用的對(duì)象應(yīng)及時(shí)銷毀；如無必要,不要序列化對(duì)象。（建議）性能與安全性能與安全v同步 在不需要同步操作時(shí)避免使用同步操作類，如能使用ArrayList時(shí)不要使用Vector。（執(zhí)行） 盡量少用同步方法，避免使用太多的 sy

19、nchronized 關(guān)鍵字；盡量將同步最小化，即將同步作用到最需要的地方。（建議）v垃圾回收 IO操作時(shí)，輸出流創(chuàng)建后需關(guān)閉；數(shù)據(jù)庫連接時(shí)，結(jié)果集和數(shù)據(jù)連接對(duì)象需關(guān)閉；（執(zhí)行）培訓(xùn)綱要培訓(xùn)綱要前言概述前言概述1WEB規(guī)范規(guī)范2Java規(guī)范規(guī)范3數(shù)據(jù)庫規(guī)范數(shù)據(jù)庫規(guī)范45數(shù)據(jù)庫規(guī)范數(shù)據(jù)庫規(guī)范v命名vSQL語句v存儲(chǔ)過程v設(shè)計(jì)v維護(hù)命名規(guī)范命名規(guī)范v總則 所有名稱的字符范圍為：A-Z, a-z, 0-9 和_(下劃線)。不允許使用其他字符作為名稱。（執(zhí)行） 采用英文單詞或英文短語（包括縮寫）作為名稱，不能使用無意義的字符或漢語拼音。（執(zhí)行）v表 表名以代表表內(nèi)內(nèi)容的一個(gè)和多個(gè)名詞組成；一些作為多對(duì)

20、多連接的表，可以使用兩個(gè)表的前綴作為表名；（執(zhí)行） 使用表的業(yè)務(wù)名稱作為表名的前綴；為了方便數(shù)據(jù)庫的維護(hù)，對(duì)項(xiàng)目引用的成品涉及的表可添加前綴。（建議）命名規(guī)范命名規(guī)范v字段 字段不使用任何前綴。（執(zhí)行） 字典名也避免采用過于普遍過于簡單的名稱；布爾型的字段，以一些助動(dòng)詞開頭，更加直接生動(dòng)。（建議） 多個(gè)單詞的字段名，Oracle默認(rèn)大寫，可在單詞間添加下劃線。（建議）SQL語句語句 避免使用SELECT * FROM ，必須指明需要讀取的具體字段；所有的SQL關(guān)鍵字大寫 。（建議） 避免在一行內(nèi)寫太長的SQL語句，在SQL關(guān)鍵字的地方將SQL語句分成多行會(huì)更加清晰。（建議） 通過SQL訪問數(shù)據(jù)

21、庫，尤其針對(duì)較復(fù)雜的數(shù)據(jù)庫業(yè)務(wù)邏輯時(shí)，盡量多編寫存儲(chǔ)過程，應(yīng)用程序通過調(diào)用存儲(chǔ)過程來訪問數(shù)據(jù)庫。（建議） 在一些塊形式的SQL語句中，就算只有一行代碼，也要加上BEGINEND塊。（執(zhí)行） SQL批處理語句的空行和縮進(jìn)與結(jié)構(gòu)化程序語言一致，應(yīng)該保持良好的代碼格式。（建議）存儲(chǔ)過程存儲(chǔ)過程 存儲(chǔ)過程開發(fā)不區(qū)分大小寫，為了便于維護(hù)和開發(fā)不能出現(xiàn)既有大寫也有小寫的情況，統(tǒng)一使用小寫。（執(zhí)行） 在存儲(chǔ)過程頭上要添加注釋，說明存儲(chǔ)過程具體功能，以及簡單的描述，同時(shí)要書寫開發(fā)日期，和作者。（執(zhí)行） 業(yè)務(wù)模塊命名：（項(xiàng)目名_模塊名_功能名）,公共模塊的命名：（項(xiàng)目名_功能名，或者直接以功能名命名）。（建議）

22、 傳入?yún)?shù)必須對(duì)每個(gè)參數(shù)進(jìn)行注釋，詳細(xì)描述其作用和用途，返回值也要詳細(xì)描述其含義和目的。（執(zhí)行） 變量命名要合理明了，不要使用漢語拼音作為變量名，變量類型要合理，符合開發(fā)需求，同時(shí)長度要合理。（建議） SQL對(duì)齊和縮進(jìn)可參考Java編碼規(guī)范。（建議） 邏輯開發(fā)代碼需要有注釋說明，重要的判斷，執(zhí)行sql等等都需要加上注釋。（執(zhí)行）存儲(chǔ)過程存儲(chǔ)過程 調(diào)用其他存儲(chǔ)過程時(shí)要說明調(diào)用原因和返回結(jié)果，做好異常處理和注釋書寫。（建議） 時(shí)刻需要關(guān)心數(shù)據(jù)安全和數(shù)據(jù)量的大小；在大批量數(shù)據(jù)處理時(shí)候要注意效率和穩(wěn)定性；頻繁使用的sql盡量使用動(dòng)態(tài)sql執(zhí)行；刪除數(shù)據(jù)使用truncate代替delete。（建議） 游標(biāo)的使用：使用前一定要先行定義再使用，使用完后一定要關(guān)閉游標(biāo)。（執(zhí)行） 異常代碼的書寫，做一些必要的判斷，不能將異常拋出給數(shù)據(jù)庫；Exception的異