【正文】 數(shù)據(jù)中心產(chǎn)品開發(fā)規(guī)范XXXX公司XX業(yè)務(wù)部XXXX年XX月38 / 39文檔說明本文檔所涉及到的文字、圖表等，僅限于內(nèi)部使用，未經(jīng)雙方書面許可，請(qǐng)勿擴(kuò)散到第三方。文檔屬性屬性內(nèi)容客戶名稱：項(xiàng)目名稱：文檔主題：文檔編號(hào)：文檔版本：版本日期：文檔狀態(tài)：作者：文檔變更版本修訂日期修訂人描述文檔送呈單位姓名目的審閱參閱目 錄1 概述 5 最根本原則 52 Java技術(shù)規(guī)范 6 平臺(tái)使用的相關(guān)技術(shù) 6 基本核心框架包 6 其他框架包 6 程序設(shè)計(jì)標(biāo)準(zhǔn) 7 命名約定 8 包名，類名，方法名，屬性名，常量名命名約定 9 注釋約定 10 快速瀏覽JavaDoc 11 開發(fā)規(guī)范 12 項(xiàng)目結(jié)構(gòu)說明 12 整體包結(jié)構(gòu)說 12 項(xiàng)目模塊包結(jié)構(gòu)及命名 13 各子項(xiàng)目模塊功能包結(jié)構(gòu) 14 配置文件包結(jié)構(gòu) 14 命名規(guī)則 15 共用類 15 業(yè)務(wù)層 15 展現(xiàn)層 15 模型層 16 持久層 16 XML配置 16 資源文件 19 JSP文件 20 事務(wù)命名約束 20 JS命名約束 213 數(shù)據(jù)庫技術(shù)規(guī)范 22 概述 22 命名基本規(guī)則 22 數(shù)據(jù)庫表空間 22 命名基本規(guī)則 22 默認(rèn)用戶方案 22 表的命名規(guī)則、約定 22 視圖的命名規(guī)則、約定 23 字段命名規(guī)則、約定 23 存儲(chǔ)過程的命名規(guī)則、約定 23 序列對(duì)象的命名規(guī)則、約定 24 觸發(fā)器命名規(guī)則、約定 244 HIVE技術(shù)規(guī)范 255 HBase設(shè)計(jì)規(guī)范 26 Namespace命名空間設(shè)計(jì) 26 . Table表設(shè)計(jì) 27 理想HBase表 27 預(yù)創(chuàng)建分區(qū) 28 列族數(shù)量 28 可配置的數(shù)據(jù)塊大小 29 數(shù)據(jù)塊緩存 29 激進(jìn)緩存 29 布隆過濾器（Bloom filters） 30 生存時(shí)間（TTL） 31 數(shù)據(jù)壓縮 32 數(shù)據(jù)分割 33 單元時(shí)間版本 34 ColumnFamily列族設(shè)計(jì) 35 Qualifier列設(shè)計(jì) 36 版本設(shè)計(jì) 37 HBase命名規(guī)范 371 概述本文提供一整套編寫高效可靠的Java代碼的標(biāo)準(zhǔn)、約定和指南。它們以安全可靠的軟件工程原則為基礎(chǔ)，使代碼易于理解、維護(hù)和增強(qiáng)。而且，通過遵循這些程序設(shè)計(jì)標(biāo)準(zhǔn)，你作為一個(gè)Java軟件開發(fā)者的生產(chǎn)效率會(huì)有顯著提高。經(jīng)驗(yàn)證明，若從一開始就花時(shí)間編寫高質(zhì)量的代碼，則在軟件開發(fā)階段，對(duì)代碼的修改要容易很多。最后，遵循一套通用的程序設(shè)計(jì)標(biāo)準(zhǔn)將帶來更大的一致性，使軟件開發(fā)團(tuán)隊(duì)的效率明顯提高。 最根本原則r 運(yùn)用常識(shí)當(dāng)找不到任何規(guī)則或指導(dǎo)方針，當(dāng)規(guī)則明顯不能適用，當(dāng)所有的方法都失效的時(shí)侯： 運(yùn)用常識(shí)并核實(shí)這些基本原則。這條規(guī)則比其它所有規(guī)則都重要。r 駝峰命名法駝峰命名法（CamelCase）：就是當(dāng)變量名或函式名是由一個(gè)或多個(gè)單字連結(jié)在一起，而構(gòu)成的唯一識(shí)別字時(shí)，第一個(gè)單字以小寫字母開始；第二個(gè)單字的首字母大寫或每一個(gè)單字的首字母都采用大寫字母，例如：myFirstName、myLastName，這樣的變量名看上去就像駱駝峰一樣此起彼伏，故得名。駝峰命名法的命名規(guī)則可視為一種慣例，并無絕對(duì)與強(qiáng)制，目的是增加識(shí)別和可讀性。2 Java技術(shù)規(guī)范 平臺(tái)使用的相關(guān)技術(shù)平臺(tái)使用的框架包分核心框架包和其他必須的框架包，各框架包本身所依賴的開源包不做列舉，由框架包本身的信息來定。 基本核心框架包平臺(tái)采用Spring+Struts2+myBatis的三層架構(gòu)作為基本框架。（+）。參考如下：名稱版本備注Struts2Springmybatiscore不支持跨數(shù)據(jù)庫建議，目前開發(fā)在mysql上，現(xiàn)網(wǎng)環(huán)境在db2上mybatisspringMySQLTomcatjQuery 其他框架包除基本框架外，平臺(tái)其他將采用的一些框架包，參考如下：（+）名稱版本備注Spring SecurityApache Commons常用的工具包等SLF4JApache Logging log4jApache AntOscacheXMemcacheC3P0Dom4jmonsbeanutilsMybatisspringHadoopcoreHivecliHbase 程序設(shè)計(jì)標(biāo)準(zhǔn)Java的程序設(shè)計(jì)標(biāo)準(zhǔn)很重要，原因在于它將提高開發(fā)團(tuán)隊(duì)各成員的代碼的一致性。一致性的提高會(huì)使代碼更易理解，這意味著它更易開發(fā)和維護(hù)。從而降低了應(yīng)用程序的總開發(fā)成本。你必須牢記的是：你的Java代碼在你已離開并開始另一個(gè)項(xiàng)目之后，會(huì)保留相當(dāng)長(zhǎng)的一段時(shí)間。因此開發(fā)過程中一個(gè)很重要的目標(biāo)就是要確保在開發(fā)成員或開發(fā)團(tuán)隊(duì)之間的工作可以順利交接，不必花很大的力氣便能理解已編寫的代碼，以便繼續(xù)維護(hù)和改進(jìn)以前的工作。如果代碼難以理解，很有可能被廢棄和重寫。s 命名約定我們將在整個(gè)標(biāo)準(zhǔn)中討論命名約定，以下是幾個(gè)基本點(diǎn)：r 使用可以準(zhǔn)確說明變量/字段/類的完整的英文描述符例如，采用類似firstName，grandTotal 或 CorporateCustomer這樣的名字。雖然象x1，y1或fn 這樣的名字很簡(jiǎn)短，輸入起來容易，但是我們難以知道它們代表什么、結(jié)果是什么含義，因而使代碼難以理解、維護(hù)和改進(jìn)。r 采用該領(lǐng)域的術(shù)語如果用戶稱他們的“客戶” (clients) 為“顧客” (customers)，那么就采用術(shù)語Customer 來命名這個(gè)類，而不用 Client。許多程序開發(fā)者會(huì)犯的一個(gè)錯(cuò)誤是，不去使用工業(yè)或領(lǐng)域里已經(jīng)存在著很完美的術(shù)語時(shí)，卻生造出一些普通詞匯。r 采用大小寫混合，提高名字的可讀性一般應(yīng)該采用小寫字母，但是類和接口的名字的首字母，以及任何中間單詞的首字母應(yīng)該大寫。r 盡量少用縮寫，但如果一定要使用，就要謹(jǐn)慎地使用這意味著應(yīng)該保留一個(gè)標(biāo)準(zhǔn)縮寫的列表，明智地從中選取，并且在使用時(shí)保持一致。例如，想對(duì)單詞“number”采用縮寫，那么可從 nbr，no 或者 num 中選取一個(gè)，說明一下采用了哪一個(gè)（具體是哪個(gè)倒無所謂），并且只使用這一種形式。r 避免使用長(zhǎng)名稱（不超過15 個(gè)字母）例如： PhysicalOrVirtualProductOrService 看起來似乎是個(gè)不錯(cuò)的類名，但是名字太長(zhǎng)，應(yīng)該考慮重新給它起個(gè)短一點(diǎn)的名字，比如象 Offering。 r 避免使用相似或者僅在大小寫上有區(qū)別的名字例如，不應(yīng)同時(shí)使用變量名 persistentObject和persistentObjects及anSqlDatabase和 anSQLDatabase這樣的名稱r 避免使用下劃線作為名字的首末字母以下劃線為首末字母的名字通常為系統(tǒng)保留，除預(yù)處理定義之外，一般不用作用戶命名。更重要的是，下劃線經(jīng)常造成麻煩而且難輸入，所以盡量避免使用。 包名，類名，方法名，屬性名，常量名命名約定r 包命名包命名全部使用小寫英文字母，中間不允許有數(shù)字下劃線等特殊字符。r 類，接口命名類，接口名開頭使用大寫英文字母，多單詞使用駝峰命名法。類名中不要使用下劃線和數(shù)字等特殊字符，正確的寫法示例：HibernateDaoSupport。如果表示特殊功能的類，在類名的末尾加上所要表示的功能英文名稱，如：****Listener，表示監(jiān)聽器等。r 方法命名方法命名使用駝峰命名法，方法名中間不要使用下劃線和數(shù)字等特殊字符，正確的示例：processing()。方法的參數(shù)以及方法內(nèi)部的局部參數(shù)可自定，符合要求就行。r 特殊Bean類的屬性命名約定Bean的屬性命名規(guī)則嚴(yán)格使用駝峰命名法，不允許使用下劃線，名字長(zhǎng)度最長(zhǎng)不要超過15個(gè)字符，確實(shí)需要長(zhǎng)名字時(shí)，適當(dāng)縮寫部分英文字母。r 常量屬性命名常量的命名規(guī)則一般為常量名全部采用大寫字母，多單詞之間使用下劃線隔開，不允許使用數(shù)字等特殊字符，并且常量的聲明一定要是static final的。r 普通類的屬性命名普通類的屬性命名除常量依照常量命名法外，其他的屬性的名字使用“英文名字（首字母大寫）”命名