公司企業(yè)8-配置管理制度 10-Delphi開發(fā)規(guī)范

PAGE文件編碼文件密級最新發(fā)布日期當前版本Delphi開發(fā)規(guī)范鄭重聲明：XX軟件股份有限公司版權(quán)所有。本文檔中任何部分未經(jīng)XX軟件股份有限公司書面授權(quán)，不得將材料泄露給第三方，不得以任何手段、任何形式進行復(fù)制與傳播。變更履歷版本日期變更位置變更理由/變更內(nèi)容變更人備注1.0新建1.1根據(jù)研發(fā)項目管理流程問題巡檢檢查出的問題進行更新：增加變更履歷

目錄1 前言 32 模塊劃分策略 33 模塊間交互模式設(shè)計 34 編碼與命名規(guī)范 45 工程屬性和版本命名規(guī)范 46 模塊依賴關(guān)系 47 代碼構(gòu)建體系規(guī)劃 57.1 源代碼目錄結(jié)構(gòu)（要考慮第三方類庫、公共組件的配置） 57.2 模塊構(gòu)建輸出策略 57.3 編譯/構(gòu)建選項 58 附錄：構(gòu)建腳本（ant或FinalBuilder構(gòu)建文件） 68.1 附錄1FinalBuilder[ForDelphi]工程構(gòu)建指南 68.1.1 引入 68.1.2 設(shè)置 108.1.3 編譯 118.2 附錄2VA開發(fā)規(guī)范介紹 128.2.1 模塊劃分 128.2.2 VA命名規(guī)則 13

前言Delphi開發(fā)平臺下，常規(guī)項目一般有兩類，一類是對單元進行管理的單個exe工程文件，一類是通過包(dpk)來組織的大型系統(tǒng)。對于第二類大型系統(tǒng)，提供如下工程組織建議。模塊劃分策略較大規(guī)模系統(tǒng)建議劃分為基礎(chǔ)模塊和業(yè)務(wù)模塊兩大類。基礎(chǔ)模塊是系統(tǒng)的基本模塊，是指系統(tǒng)能夠運行的必須依賴的模塊。業(yè)務(wù)模塊是系統(tǒng)的擴展模塊，是指系統(tǒng)可選加載的處理某類業(yè)務(wù)的模塊。業(yè)務(wù)模塊分為基本業(yè)務(wù)模塊和輔助工具模塊，基本業(yè)務(wù)模塊完成獨立業(yè)務(wù)處理，輔助工具模塊用來實現(xiàn)模塊間的協(xié)同處理或擴展系統(tǒng)功能。列出模塊列表及功能說明（模塊的粒度根據(jù)具體情況確定，基本原則是公共的、基礎(chǔ)的細，業(yè)務(wù)部分粗）在考慮模塊劃分時，要結(jié)合版本的劃分、分支/合并策略模塊間交互模式設(shè)計模塊間的交互模式按照定義操作規(guī)范和發(fā)起調(diào)用的原則劃分，可以分為：直接交互、間接交互和輔助交互三種。直接交互：（橙色表示規(guī)范定義者，箭頭背向表示調(diào)用發(fā)起者，紅線表示交互或協(xié)同工作的雙方）直接交互模式，是指模塊之間有直接的引用或調(diào)用關(guān)系。直接交互是一種高效、簡單的高耦合度交互模式。直接將使模塊直接產(chǎn)生依賴關(guān)系，被引用的模塊有任何調(diào)整時，引用的模塊都要做相應(yīng)的調(diào)整，并且模塊加載時，被引用的模塊必須加載。直接交互簡單高效，因此常用于基本模塊跟擴展模塊直接的交互。間接交互：間接交互模式，是指模塊之間通過基礎(chǔ)模塊或公共模塊交互的模式，協(xié)作模塊之間沒有直接的關(guān)系，通過公共模塊定義的規(guī)范交互。間接交互是一種高擴展性的低耦合度交互模式，所以是高擴展性系統(tǒng)中擴展模塊間的常用交互模式。輔助交互：（虛線表示可能不存在，存在與否不影響規(guī)范的制定）輔助交互模式，是指模塊提供遵守某公共規(guī)范或自定規(guī)范操作接口，通過第三方模塊調(diào)用的交互模式，協(xié)作模塊都被動的等待第三方模塊調(diào)用。輔助交互一般用于任務(wù)可以切割成幾塊完成，而且每小塊任務(wù)之間相互獨立的情況下。輔助交互的模塊之間的耦合度為零，所以可配置性很強，并且可以很好的支持業(yè)務(wù)過程重組。需要對外提供業(yè)務(wù)服務(wù)的業(yè)務(wù)模塊，盡量制定操作規(guī)范接口，以支持此交互模式。編碼與命名規(guī)范在遵循公司相關(guān)編碼和命名規(guī)范的基礎(chǔ)上，在這里補充具體項目的編碼和命名規(guī)范，比如增加前綴、比如結(jié)構(gòu)化命名的分段規(guī)范工程屬性和版本命名規(guī)范DLL/EXE/BPL在編譯后有一系列屬性值，可以通過資源管理器瀏覽版本命名規(guī)范包括內(nèi)部測試版本和外部正式發(fā)布版本（在遵循公司相關(guān)規(guī)范的基礎(chǔ)上）模塊依賴關(guān)系模塊依賴關(guān)系表各個模塊必須按照編譯的順序列出清晰列出模塊之間的依賴關(guān)系定義模塊的粒度（比如包、單元、類），以及根據(jù)具體項目在模塊依賴關(guān)系表中表現(xiàn)的粒度的策略模塊依賴關(guān)系是編譯時，確定模塊需要前置編譯順序。通過整理模塊依賴關(guān)系，可以在進行每日構(gòu)建時，保證正確的編譯完成。序號模塊名稱依賴關(guān)系模塊功能說明備注…11V5SysMngJob。。。12V5BusinessUI。。。13V5SysMngUI11、12…此處維護的是每個模塊（包）依賴的包清單。代碼構(gòu)建體系規(guī)劃源代碼目錄結(jié)構(gòu)（要考慮第三方類庫、公共組件的配置）模塊構(gòu)建輸出策略模塊輸出目標文件規(guī)劃（DLL/EXE/DCU/BPL、運行包/設(shè)計包的考慮，Java類似）、輸出目錄結(jié)構(gòu)、管理策略（根據(jù)具體項目情況確定模塊的粒度）編譯/構(gòu)建選項根據(jù)具體IDE工具確定，先列出常用的編譯指令或選項及其應(yīng)用場合附錄：構(gòu)建腳本（ant或FinalBuilder構(gòu)建文件）附錄1FinalBuilder[ForDelphi]工程構(gòu)建指南對于以包(dpk)組織的大型系統(tǒng)，工程打開、編譯都是非常耗時的，因此利用工具進行系統(tǒng)構(gòu)建，是提高工作效率的有效手段。下面對如何利用FinalBuilder進行Delphi系統(tǒng)構(gòu)建進行介紹說明。引入首先是新建一個FinalBuilder工程，引入需要進行編譯的工程文件。步驟如下圖所示步驟一點擊進入ImportDelphiProjectGroup：步驟二選擇需要引入的工程的具體包文件，注意不要重復(fù)引入步驟三選擇Delphi版本步驟四指定相關(guān)屬性，也可以后面再設(shè)置設(shè)置工程文件引入后，需要進行必要的熟悉調(diào)整。對于FinalBuilder2來說，主要是改變兩個地方，如下圖所示編譯完成相關(guān)工程的引入和配置后，還可以隨時調(diào)整依賴關(guān)系，同時可以根據(jù)需要，進行分組管理，方便配置管理員進行版本編譯發(fā)布。常用調(diào)整功能快捷按鈕如下：補充一些基本概念內(nèi)容更豐富一些補充命令行說明

附錄2VA開發(fā)規(guī)范介紹模塊劃分VA目前劃分為基礎(chǔ)模塊和業(yè)務(wù)模塊兩大類。按照目前VA的客戶端、服務(wù)器端和管理平臺三部分劃分方法，基礎(chǔ)模塊必須能保證這三部分分別啟動和運行。業(yè)務(wù)模塊是系統(tǒng)的擴展模塊，是指系統(tǒng)可選加載的處理某類業(yè)務(wù)的模塊。業(yè)務(wù)模塊分為基本業(yè)務(wù)模塊和輔助工具模塊，基本業(yè)務(wù)模塊完成獨立業(yè)務(wù)處理，輔助工具模塊用來實現(xiàn)模塊間的協(xié)同處理或擴展系統(tǒng)功能。這里的模塊是指系統(tǒng)模塊，即有目前VA系統(tǒng)的Job、Logic、GUI三個包共同組成的模塊，部署模塊必須三個包同時部署。按照當前VA的目錄劃分，BillDsgn、FrameWork、QueryAlys、V5BaseData、V5Business、V5Comm、V5DataCst、V5Mngplatform、V5SysMng等以及第三方組件包劃為基礎(chǔ)模塊，其余目錄劃為業(yè)務(wù)模塊。下圖是VA新版配置庫目錄結(jié)構(gòu)：VA命名規(guī)則服務(wù)命名規(guī)則：每個服務(wù)分為三個包(Package)，同屬于一個工程組。工程組的命名規(guī)則為：V5[服務(wù)名].pbg三個包分別為工作包：V5[服務(wù)名]Job.dpk邏輯包：V5[服務(wù)名]Logic.dpk界面包：V5[服務(wù)名]UI.Dpk包需要代版本信息：版本標識為1.0單元命名規(guī)則：單元分為7類Svc:服務(wù)類所在單元：V5_Svc_[服務(wù)名]Job:工作類所在單元：V5_Job_[工作名或工作范疇名]Assitant:工作助理所在單元：V5_Asst_[助理名或助理范疇名]Util:輔助類所在單元：V5_Util_[類名或范疇名]Frame:層類所在單元：V5_Frame_[層名]DataModule:數(shù)據(jù)服務(wù)單元:V5_DataModule_[數(shù)據(jù)模塊名]Dsgn:設(shè)計時類所在單元：V5_Dsgn_[類名或范疇名]Define:定義所在單元：V5_Define_[服務(wù)名]類命名規(guī)則：Service:TV5[服務(wù)名]ServiceAssistant:T[助理名]AssistantJob:T[工作名]JobFrame:T[層名]FrameDataModule:T[數(shù)據(jù)模塊名]DataModuleJob類屬性命名規(guī)則：于數(shù)據(jù)庫表字段有關(guān)的類屬性名應(yīng)與表字段名相同JobMethod枚舉類型命名規(guī)則：枚舉類型命名規(guī)則：TJobMethod[工作名]枚舉項命名規(guī)則：Jm_[工作名縮寫]_[方法名]工作助理工作處理方法命名規(guī)則：procedureDo[工作名][方法名]Job(Context:TEFWDBContext;Job:[工作類];