總體設(shè)計說明書

精品文檔精心整理精品文檔可編輯的精品文檔文檔編碼密級文檔版本擬制人日期項目編號和項目名稱總體設(shè)計說明書變更履歷版本日期變更位置變更理由/變更內(nèi)容變更人備注1.0創(chuàng)建目錄1 概述 41.1 目的 41.2 定義、縮略語 41.3 參考資料 42 系統(tǒng)業(yè)務(wù)架構(gòu) 42.1 系統(tǒng)邏輯視圖 42.2 系統(tǒng)運(yùn)行時邏輯視圖 42.3 系統(tǒng)關(guān)鍵對外接口 53 總體設(shè)計 53.1 ServiceID 53.2 系統(tǒng)規(guī)劃 63.3 全局信息 64 關(guān)鍵模塊（子系統(tǒng)）設(shè)計與規(guī)劃 65 CCP平臺銜接擴(kuò)展 75.1 概述 75.2 功能擴(kuò)展 75.2.1 機(jī)構(gòu)管理 75.2.2 通用內(nèi)容管理 75.3 項目實際應(yīng)用配置 85.3.1 機(jī)構(gòu)級次配置 85.3.2 組織機(jī)構(gòu)維護(hù)配置 86 其他設(shè)計約束 9

概述目的描述村民自治管理系統(tǒng)架構(gòu)設(shè)計，包括系統(tǒng)主要業(yè)務(wù)模塊，軟件組件和它們之間的交互；解釋當(dāng)前架構(gòu)設(shè)計及實現(xiàn)中得原理；解釋架構(gòu)設(shè)計如何滿足肺功能性需求等，以便于項目組內(nèi)部，項目組和項目管理人之間交流和溝通。本說明書的使用者：客戶、項目組成員、項目管理人、公司領(lǐng)導(dǎo)。定義、縮略語MCAVSR：村民自治管理信息系統(tǒng)參考資料《MCAVSR村民自治系統(tǒng)需求說明書（草稿）.doc》《MCAVSR數(shù)據(jù)庫設(shè)計說明書.doc》《CCP1.0Final數(shù)據(jù)庫設(shè)計說明書.doc》《CCP1.0Final后臺開發(fā)參考手冊.doc》《CCP1.0Final前臺開發(fā)參考手冊.doc》《CCP1.0使用手冊——研發(fā)版.doc》系統(tǒng)業(yè)務(wù)架構(gòu)系統(tǒng)邏輯視圖【描述系統(tǒng)整體邏輯架構(gòu)設(shè)計】系統(tǒng)運(yùn)行時邏輯視圖【描述系統(tǒng)運(yùn)行時的各邏輯組件及其交互】系統(tǒng)關(guān)鍵對外接口【描述關(guān)鍵的對外服務(wù)與接口】總體設(shè)計ServiceID規(guī)則提示：1）首先描述SercicesID的組成規(guī)則，然后分模塊列舉模塊SerciceID范圍2）以9開頭的ServiceID為系統(tǒng)專用，此處不能進(jìn)行編號SerivceID為5位數(shù)字，其中前3位為功能模塊編號，后2位為順序號。前3位數(shù)字分配如下：第一位描述描述備注1民主選舉2村務(wù)公開3農(nóng)村社區(qū)建設(shè)4信訪管理5工作信息交流6系統(tǒng)管理8前兩位數(shù)字分配如下：前兩位描述ServiceID描述備注11選舉實施民主選舉12選舉快報民主選舉13民主選舉查詢統(tǒng)計民主選舉21主要統(tǒng)計指標(biāo)村務(wù)公開22領(lǐng)導(dǎo)協(xié)調(diào)機(jī)構(gòu)村務(wù)公開和社區(qū)建設(shè)23村務(wù)公開查詢統(tǒng)計31主要統(tǒng)計指標(biāo)社區(qū)建設(shè)32農(nóng)村社區(qū)建設(shè)查詢統(tǒng)計社區(qū)建設(shè)41信訪管理42信訪管理查詢統(tǒng)計62基本信息系統(tǒng)規(guī)劃<pkg>：com.jiuqi.mcavsr業(yè)務(wù)模塊名稱ServiceAction包名Web目錄Logic包名備注民主選舉Id10_Service<pkg>.action.empinfo.*村務(wù)公開Id20_Service<pkg>.action.wrkrc.*農(nóng)村社區(qū)建設(shè)Id30_Service<pkg>.action.qrstanls.*信訪管理Id40_Service<pkg>.action.sysmng.*工作信息交流Id50_Service系統(tǒng)管理Id60_Service全局信息LoginForm標(biāo)識com.jiuqi.ctcps.formbean.sysform.LoginForm功能說明：系統(tǒng)登錄對象字段類型字段名稱字段含義默認(rèn)值備注關(guān)鍵模塊（子系統(tǒng)）設(shè)計與規(guī)劃【對關(guān)鍵業(yè)務(wù)模塊的總體設(shè)計和規(guī)劃進(jìn)行說明】CCP平臺銜接擴(kuò)展概述【簡單介紹CCP平臺，說明CCP版本等相關(guān)信息】mcavsr基于CCP各組件的版本如下：CCP版本：V1.0final(包括src和web)數(shù)據(jù)庫版本:截止到2008.3.14的最新版本自動生成代碼版本：沒有明確版本號功能擴(kuò)展機(jī)構(gòu)管理一、數(shù)據(jù)庫擴(kuò)展在CCP原有組織機(jī)構(gòu)（sys_organizations）的基礎(chǔ)上，添加了組織機(jī)構(gòu)擴(kuò)展信息表(CCP_ACLS_ORG)，用以存儲系統(tǒng)組織機(jī)構(gòu)信息。二、業(yè)務(wù)代碼擴(kuò)展1、繼承OrgBO(com.jiuqip.logic.core.acls.OrgBO)類，新增OrgExtBO類，重寫原組織結(jié)構(gòu)機(jī)構(gòu)業(yè)務(wù)類中的機(jī)構(gòu)新增、修改以及刪除方法，以保證原（Sys_Organizations）數(shù)據(jù)表與擴(kuò)展的機(jī)構(gòu)信息表（CCP_ACLS_ORG）的數(shù)據(jù)一致性。2、為了保證系統(tǒng)機(jī)構(gòu)信息導(dǎo)入功能能夠正常運(yùn)轉(zhuǎn)，需要重寫原組織機(jī)構(gòu)類中的dealOrg方法，重寫后的方法，在更新原（Sys_Organizations）數(shù)據(jù)表的同時，同步寫擴(kuò)展的機(jī)構(gòu)信息表（CCP_ACLS_ORG）的相同字段。三、配置文件變更由于擴(kuò)展了機(jī)構(gòu)管理的功能，需要同步修改CCP配置文件appCtx-service-ccp.xml中，改變原組織結(jié)構(gòu)業(yè)務(wù)類OrgBO對象的實現(xiàn)類指向XX，將該對象的實現(xiàn)類指向到XX注：Bean配置文件定義中，id的屬性值保持不變。通用內(nèi)容管理一、業(yè)務(wù)代碼擴(kuò)展在CCP通用內(nèi)容中員機(jī)構(gòu)風(fēng)格的基礎(chǔ)上，根據(jù)實際業(yè)務(wù)需要，需要重寫原有機(jī)構(gòu)風(fēng)格在瀏覽中的機(jī)構(gòu)展示以及查看業(yè)務(wù)邏輯。二、配置文件變更擴(kuò)展了通用內(nèi)容機(jī)構(gòu)風(fēng)格的功能，需要同步修改CCP配置文件appCtx-service-ccp.xml中，改變原機(jī)構(gòu)風(fēng)格控制類對象的實現(xiàn)類指向，將對象的實現(xiàn)類指向到注：Bean配置文件定義中，id的屬性值保持不變。項目實際應(yīng)用配置機(jī)構(gòu)級次配置修改CCP默認(rèn)的機(jī)構(gòu)級次設(shè)置，將機(jī)構(gòu)級次按照如下類別重新設(shè)置：機(jī)構(gòu)級次機(jī)構(gòu)名稱描述1民政部2省級單位3市級單位4縣級單位組織機(jī)構(gòu)維護(hù)配置機(jī)構(gòu)維護(hù)在原有機(jī)構(gòu)維護(hù)的基礎(chǔ)上，主要有如下限制：機(jī)構(gòu)代碼必須是原行政區(qū)劃代碼去除00的部分民政部組織機(jī)構(gòu)代碼默認(rèn)為00其中直轄市下屬的區(qū)縣單位的直接上級是省，對于直轄市來說，直轄市的機(jī)構(gòu)代碼為2為，其區(qū)縣的機(jī)構(gòu)代碼為6為，中間沒有機(jī)構(gòu)代碼為4為的地市示例如下：機(jī)構(gòu)代碼機(jī)構(gòu)名稱上級機(jī)構(gòu)備注00民政部1100省級單位11010111縣級單位1200省級單位1300省級單位130113市級單位1301021301縣級單位其他設(shè)計約束精品文檔精心整理精品文檔可編輯的精品文檔文檔編碼密級文檔版本擬制人日期項目編號和項目名稱設(shè)計說明書[其他如副標(biāo)題/子模塊]變更履歷版本日期變更位置變更理由/變更內(nèi)容變更人備注1.0創(chuàng)建

目錄1 概述 32 總體設(shè)計 33 模塊1設(shè)計（模塊唯一編號） 33.1 子模塊1設(shè)計（模塊唯一編號） 33.1.1 模塊概述 33.1.2 類圖 33.1.3 調(diào)用關(guān)系/時序圖 43.1.4 類及接口設(shè)計 53.2 子模塊2設(shè)計（模塊唯一編號） 63.2.1 模塊概述 63.2.2 類圖 63.2.3 調(diào)用關(guān)系/時序圖 63.2.4 類及接口設(shè)計 6

【重要提示】本文檔的目錄結(jié)構(gòu)應(yīng)與需求規(guī)格說明書一一對應(yīng)。概述描述該功能的主要設(shè)計目標(biāo)和設(shè)計思路，對設(shè)計部分的內(nèi)容做一個簡要的說明?？傮w設(shè)計總體設(shè)計針對所有不能歸入任何一個模塊的功能進(jìn)行設(shè)計，可以分節(jié)進(jìn)行描述：對于較為復(fù)雜的模塊，可以使用模塊架構(gòu)圖來說明模塊的整體框架結(jié)構(gòu)，以方便閱讀者直觀地理解模塊的體系架構(gòu)從總體上描述所有功能模塊應(yīng)遵循的規(guī)則。例如模塊劃分的原則等。代碼的目錄結(jié)構(gòu)性能方面的設(shè)計：例如數(shù)據(jù)緩沖的設(shè)計等安全性方面的設(shè)計擴(kuò)展性方面的設(shè)計穩(wěn)定性方面的設(shè)計模塊1設(shè)計（模塊唯一編號）子模塊1設(shè)計（模塊唯一編號）模塊概述對模塊1的設(shè)計進(jìn)行概要描述，主要有設(shè)計思路、主要原理、設(shè)計目標(biāo)等。類圖描述所有類之間的關(guān)聯(lián)、繼承、依賴等關(guān)系?？梢允褂肬ML類圖的規(guī)則來繪制（推薦使用VisualPraradigm或RationalRose工具進(jìn)行繪制）。類圖中出現(xiàn)的現(xiàn)有系統(tǒng)中已經(jīng)實現(xiàn)的類，可以不用體現(xiàn)類中具體的屬性和方法，對于本模塊設(shè)計的類必須體現(xiàn)類中public類型的所有方法及屬性（屬性的get和set方法可以省略）。如果類比較多，可以分多個類圖進(jìn)行繪制。類圖以圖片的形式插入本文檔，同時保留與本文檔同名的類圖文件作為附件，以便修改。

例：調(diào)用關(guān)系/時序圖注：調(diào)用關(guān)系/時序的技術(shù)原則為實用原則，即對于不言而喻的調(diào)用關(guān)系/時序圖可以不必描述，例如簡單的增、刪、改操作，這里只需描述調(diào)用關(guān)系較為復(fù)雜的時序。時序圖1描述一個完整的業(yè)務(wù)功能操作的處理流程，通過類之間的調(diào)用關(guān)系流程來體現(xiàn)程序的執(zhí)行順序。可以使用UML時序圖的規(guī)則來繪制（推薦使用VisualPramdigm或RationalRose工具進(jìn)行繪制）。時序圖中對現(xiàn)有系統(tǒng)中已經(jīng)實現(xiàn)的類的調(diào)用，可以不用體現(xiàn)類中被調(diào)用方法的具體參數(shù)，對于本模塊設(shè)計的類的調(diào)用，則必須體現(xiàn)類中所有方法的調(diào)用參數(shù)及類型。時序圖以圖片的形式插入本文檔，同時保留與本文檔同名的時序圖文件作為附件，以便修改。注：需要先描述此時序圖發(fā)生的場景以便于理解，例如“點(diǎn)擊生成按鈕觸發(fā)此時序圖”。例：時序圖2同時序1類及接口設(shè)計基礎(chǔ)類1基礎(chǔ)類的設(shè)計，可以使用UML類圖來描述，或者使用類定義的偽代碼來描述，描述時要注意把類屬性的含義、類型、約束、方法、參數(shù)等描述清楚，如果涉及到持久化（存儲），需要描述其存儲方式（文件、數(shù)據(jù)庫、注冊表等等）、數(shù)據(jù)