中臺技術(shù)hap框架開發(fā)

1、HAP 開發(fā)規(guī)范文檔作者: 創(chuàng)建日期: 更新日期: 文檔編號:當前版本:Hand 2016-06-282016-08-231.0文檔變更審閱分發(fā)拷貝編號位置/崗位1234職位日期作者版本變更說明目錄文檔. 2開發(fā)規(guī)范4官方推薦規(guī)范4推薦規(guī)范（后端開發(fā)）4推薦規(guī)范（前端開發(fā)）7更改歷史10開發(fā)規(guī)范官方推薦規(guī)范HAP 開發(fā)的規(guī)范基礎(chǔ)，請務(wù)必遵守官方的規(guī)范進行開發(fā)流程規(guī)范具體請參看：er3.md開發(fā)編碼規(guī)范具體請參看：g_spec.md推薦規(guī)范（后端開發(fā)）統(tǒng)一統(tǒng)一是指，對于同一個概念，在用同一種表示，比如對于供應(yīng)商，既可以用r，也可以用 provider，但是我們只能選定一個使用，至少在一個 Jav

2、a 項目中保持統(tǒng)一。統(tǒng)一是作為重要的，如果對同一概念有不同的表示，會使代碼混亂難以理解。即使不能取得要理解一次。名稱，但是只，閱讀起來也太，因為閱讀者只達意達意是指，標識符能準確的表達出它所代表的意義，比如：newr,OrderPaymentGatewayService 等；而r1, service2 等則不是命名方式。準確有兩成含義，一是正確，二是豐富。如果給一個代表供應(yīng)商的變量起名是 order，顯然沒有正確表達。同樣的，r1, 遠沒有 targetr 意義豐富。簡潔簡潔是指，在統(tǒng)一和達意的前提下，用盡量少的標識符。如果不能達意，寧愿不。比如：theOrderNameOfTheTarget

3、rWhichIsTransfered,太長，transferedTargetrOrderName 可以的，但是 transTgtSplOrdNm 就不可以了。緩存的作用做任何改變，但是如果每次都從 DB 端獲效率，對于這種情況，緩存會成為一種最由于經(jīng)常獲取的一些基本數(shù)據(jù)和靜態(tài)數(shù)據(jù)取會產(chǎn)生大量的連接資源浪費且也降低了為適合的解決方式，首先會將這種類型數(shù)據(jù)以鍵值對的形式把這些數(shù)據(jù)緩存到內(nèi)存里面，每次操作的時候，先到內(nèi)存里面找，看有沒有這些數(shù)據(jù)，如果有，那么就直接使用，如果沒有那么就獲取它，并設(shè)置到緩存中，下一次中獲取了。從而節(jié)省大量的時間，資源，有效提高了的時候就可以直接從內(nèi)存數(shù)據(jù)效率常量的設(shè)定由

4、于 JAVA 項目中常常有多個類會用到同一個改變的值，假如各個類自行定義同一個常量數(shù)據(jù)會產(chǎn)生大量的內(nèi)存冗余，而將一些公用的常量統(tǒng)一定義到一個工具類中，這樣就會節(jié)省大量內(nèi)存空間，提高項目運行效率，提高了代碼重用性。表創(chuàng)建規(guī)范(1)普通表：_模塊_屬性比如 hfs_org_companys(2)多語言處理表基表：_模塊_屬性_B如：hfs_org_companys_b注：需要包含多有字段，多語言字段多語言表：_模塊_屬性_TL如：hfs_org_companys_tl注：只需要包含多語言字段，加上語言字段 LANG包名創(chuàng)建規(guī)范(1)使用小寫字母如 com.core.utils，不要 com.cor

5、e.Utils(2)單詞間不要用字符隔開，比如 com.core.utils，而不要 com.core.ut_ils(3)包結(jié)構(gòu)模塊化：比如在 hfs.模塊.controllers 可定義包名為 hfs.fnd.controllers工具包的使用規(guī)范全局工具包包命名規(guī)范：hfs.utils模塊工具包包命名規(guī)范：hfs.模塊.utils實例：hfs.fnd.utils 公用模塊工具包hfs.ar.utils 應(yīng)收模塊工具包類名創(chuàng)建規(guī)范類名要首字母大寫比如 RoleController類名往往用不同的后綴表達額外的意思比如 RoleController，IRoleService。類名后綴Contr

6、oller:直接處理頁面請求，管理頁面邏輯類Service:表明這個類是服務(wù)類，主要為其他類提供服務(wù)的DTO:表明這個類為實體封裝類，和 DB 端進行Impl:表明這個類是實現(xiàn)類，不是接口Mapper:數(shù)據(jù)庫交互層Job:按時間順序運行的任務(wù)Factory:生成某種對象工廠的類名創(chuàng)建規(guī)范(1)首字母小寫如 addOrder() 不要 AddOrder()(2)動詞在前如 addOrder()，不要 orderAdd()(3)動詞前綴往往表達特定的含義如 createOrder() 即創(chuàng)建訂單靜態(tài)常量創(chuàng)建規(guī)范全大寫用下劃線分割如 public static final String ORDER_

7、STATUS_CD_D="8"屬性名創(chuàng)建規(guī)范首字母小寫，駱駝法則如：public String orderName;。多語言命名規(guī)范1） 功能層面多語言hfs.模塊.功能.屬性實例：hfs.gl.daily_rate.from_currency 幣種從2） 模塊層面多語言hfs.模塊.屬性hfs.ar.customer_name 客戶名稱3） 系統(tǒng)層面多語言hfs.屬性hfs.query注意：盡量考慮多語言的通用性和靈活性，如“是否啟用”這種類似的可以考慮建到模塊層或系統(tǒng)層，Mybatis 使用規(guī)范1）Mapper 目錄規(guī)范文件夾基于模塊配置，根目錄 src/main/re

8、sources模塊目錄：fnd 基礎(chǔ)模塊、gl 總帳模塊 org 組織模塊實例：src/main/resources/fnd/mapper2）Mapper 的 XML 文件規(guī)范只做增刪改查，為了使用 HAP 框架的封裝特性，一個實體類需要建一個映射文件，如果不使用框架對操作的增刪改查特性，建議一個功能使用一個文件：3）Mapper 中 SQL 語句規(guī)范>>>>拼接 SQL 盡量減少冗余為了增強程序跨多數(shù)據(jù)庫的部署需求，盡量使用標準 SQL SQL 別名盡量與 DTO 字段名字對應(yīng)，以提高代碼閱讀性非特殊情況不建議拼接模糊的“%”，可使用 Like 讓用戶決定事務(wù)處理規(guī)范

9、在 Service 層編寫的如果新增、編輯等 DML 操作，需要注意事務(wù)處理的管理，比如通過注解的方式進行處理注：在 Controller 層的里不能調(diào)用多個帶事務(wù)處理的Service 層，建議在 Service層進行組合構(gòu)建新進行調(diào)用推薦規(guī)范（前端開發(fā)）LigerUI 使用規(guī)范1）必輸字段處理規(guī)則必輸字段除在 LigerUI 界面端需要做處理外，在 Controller 層也需要做非空邏輯處理，如：getValidator().validate(lookupTypes, result);2）VIEW 層 HTML 文件命名規(guī)范整個功能的 HTML 命名必須遵如：應(yīng)付模塊，零售單界面開發(fā)目錄結(jié)

10、構(gòu)：的風(fēng)格，參考數(shù)據(jù)庫表名規(guī)范進行。匯總界面：retail_bill_summary.html明細界面：1）同時支持新增、編輯、查看retail_bill.html2）新增retail_bill_add.html3)編輯查看retail_bill_edit.htmlLOV 頁面命名：全局級：統(tǒng)一放置 view/lov 目錄下inventory_item_lov.html功能級：retail_bill_user_lov.html拓展文件使用為了豐富 UI 組件的多樣性，滿足框架支持以外的需求，需要在開發(fā)過程中去拓展 JS、CSS、Images、HTML 等文件，本小節(jié)將能。怎樣拓展和使用 HAP 框架以外的組件功首先為了便于管理和維護，在 webapp/resources 下分別建了 css、images、js 等目錄用于存放 css 等文件，在 WEB-INF/view 下新建了include 目錄用于存放 html 文件。> 拓展 JS在 webapp/resources/js 下存放拓展開發(fā)的JS 文件，如圖：> 拓展 CSS在 webapp/resources/css 下存放拓展開發(fā)的 CSS 文件，如圖：> 拓展 Images在 webapp/resources/images 下存放拓展開發(fā)的 Imag