詳細設計說明書-模板

1、項目名稱項目名稱編 號當前版本擬 制 人審 核 人批 準 人文件狀態(tài) 征求意見稿 正式發(fā)布完成日期 詳細設計說明書詳細設計說明書項目名稱詳細設計說明書 版版 本本 歷歷 史史版本作 者參與者起止時間備 注項目名稱詳細設計說明書 目 錄1. 引言引言 .11.1 編寫目的.11.2 項目背景.11.3 參考資料.12.1 項目現(xiàn)狀項目現(xiàn)狀 .22.2 建設目標.22.3 建設內(nèi)容.22.4 功能需求.22.5 非功能需求.23. 總體設計總體設計 .33.1 體系結構.33.2 邏輯架構.33.2.1 分層架構模型.33.2.2 組件架構模型.33.2.3 數(shù)據(jù)流轉(zhuǎn)模型.43.3 包結構設計.4

2、3.3.1包介紹.43.3.2包介紹.53.3.3包介紹.63.3.4 頁面資源介紹.63.3 軟件功能結構設計.83.4 系統(tǒng)運行環(huán)境.93.5 標準性與擴展性.94功能設計功能設計 .114.1 功能設計 .114.1.1 業(yè)務流程設計.114.1.2 功能概述.114.1.3 主要功能模塊設計.115非功能性設計非功能性設計 .115.1 系統(tǒng)接口設計.115.1 系統(tǒng)集成設計.115.2 系統(tǒng)配置設計.115.3 系統(tǒng)安全設計.115.4 系統(tǒng)部署方案設計.11項目名稱詳細設計說明書第 0 頁 1.1. 引言引言1.1 編寫目的編寫目的本文檔描述了維護審批程序設計人員對該程序總體框架的

3、設計方案，用于指導程序開發(fā)人員進行編碼設計開發(fā)，并且?guī)椭罄m(xù)升級維護人員了解掌握該程序的設計思路。用戶也可以通過該文檔更深一步的了解該程序。1.2 項目背景項目背景1.3 參考資料參考資料項目項目任務書2014-06-01項目任務書-1.0 版2013-11-18項目名稱詳細設計說明書 2. 項目概述2.12.1 項目現(xiàn)狀項目現(xiàn)狀2.2 建設目標建設目標2.3 建設內(nèi)容建設內(nèi)容2.4 功能需求功能需求2.5 非功能需求非功能需求(1) 可用性：系統(tǒng)應操作簡單、實用高效、好記易學、少錯和令人滿意，具備較高的可用性；(2) 可靠性：系統(tǒng)應經(jīng)過完善的設計和充分的測試運行，具備在較長時間內(nèi)連續(xù)無故障的

4、運行能力；(3) 健壯性：系統(tǒng)應具備較強的容錯、數(shù)據(jù)恢復與穩(wěn)定運行的能力。(4) 擴展性：。項目名稱詳細設計說明書 3.3. 總體設計總體設計3.1 體系結構體系結構3.2 邏輯架構邏輯架構本系統(tǒng)核心架構為 FreeMarker+hibernate+Spirng 的 mvc 分層架構。.1 分層架構模型分層架構模型.2 組件架構模型組件架構模型業(yè)業(yè)務務層層（含含持持久久層層）基基礎礎設設施施層層JTAEhCacheQuartz展展現(xiàn)現(xiàn)層層FreeMarkerJSONHibernate3客客戶戶層層Log4JSpringMVCJavaMailJDBC Driver

5、XfireTAGCommons-fileuploadCommons-ioHttpClientSLF4JJQueryHTML5CSS3Spring3DWRLuceneDom4JJUnitAntCommons-netC3P0Jmagickhtmlparser項目名稱詳細設計說明書 .3 數(shù)據(jù)流轉(zhuǎn)模型數(shù)據(jù)流轉(zhuǎn)模型3.3 包結構設計包結構設計.1包介紹包介紹具體包名相關功能描述comjeecmscms常量包comjeecmscmsaction通用 action 抽象類包comjeecmscmsactionadmin后臺歡迎頁的 actioncomjeecmscmsact

6、ionadminassist后臺輔助包comjeecmscmsactionadminmain后臺核心功能包comjeecmscmsactiondirectivecms 自定義標簽包,公用部分繼承于 abs 包comjeecmscmsactiondirectiveabs公用部分自定義標簽的抽象包comjeecmscmsactionfront前臺 action 包comjeecmscmsaction.member會員中心包comjeecmscmsdaoassist輔助 dao 的接口層comjeecmscmsdaoassistimpl輔助 dao 的接口實現(xiàn)層comjeecmscmsdaomain

7、核心的 dao 接口層comjeecmscmsdaomainimpl核心的 dao 接口實現(xiàn)層comjeecmscmsentityassistcms 輔助實體類子類comjeecmscmsentityassistbasecms 輔助實體類基類項目名稱詳細設計說明書 comjeecmscmsentityassisthbmhibernate 輔助實體類的關系映射文件comjeecmscmsentitybackcms 備份實體類子類comjeecmscmsentitybackbasecms 備份實體類基類comjeecmscmsentitybackhbmhibernate 備份實體類類的關系映射文件

8、comjeecmscmsentitymaincms 核心實體類子類comjeecmscmsentitymainbasecms 核心實體類基類comjeecmscmsentitymainhbmhibernate 核心實體類的關系映射文件comjeecmscmslucene搜索引擎封裝包comjeecmscmsmanagerassist輔助的 service 接口層comjeecmscmsmanagerassistimpl輔助的 service 接口實現(xiàn)層comjeecmscmsmanagermain核心的 service 接口層comjeecmscmsmanagermainimpl核心的 ser

9、vice 接口實現(xiàn)層comjeecmscmsserviceservice 封裝層comjeecmscmsstaticpage靜態(tài)頁的封裝包包comjeecmscmsstaticpageexception靜態(tài)頁的異常處理類型comjeecmscmsstatistic內(nèi)容發(fā)布統(tǒng)計包comjeecmscmsstatisticworkload流量統(tǒng)計包comjeecmscmsweb攔截器包comjeecmscmstask任務包comjeecmscmstaskjob具體任務包.2包介紹包介紹具體包名相關功能描述comjeecmscommoncaptcha驗證碼封裝包comjeecmsco

10、mmondic分詞comjeecmscommonemail郵件包comjeecmscommonfckfck 編輯器封裝包comjeecmscommonfile文件操作封裝包comjeecmscommonhibernate3hibeinate 封裝包comjeecmscommonimage圖片的封裝包comjeecmscommonipseekip 地址庫封裝comjeecmscommonlucene收索引擎的基礎包comjeecmscommonoffice文檔轉(zhuǎn)換相關工具類comjeecmscommonpagejeecms 分頁封裝包comjeecmscommonsecuritycomjeecm

11、scommonsecurityannotationcomjeecmscommonsecurityencodercomjeecmscommonsecurityremembermecomjeecmscommonsecurityuserdetails安全認證相關的包comjeecmscommonupload上傳封裝包項目名稱詳細設計說明書 comjeecmscommonutil工具包comjeecmscommonweb常量包comjeecmscommonwebfreemarkerfreemarker 視圖封裝包comjeecmscommonwebsessionsession 包comjeecmsco

12、mmonwebsessioncachesession 緩存包comjeecmscommonwebspringmvcspringMVC 的簡單封裝comjeecmscmsmanagermain核心的 service 接口層comjeecmscmsmanagermainimpl核心的 service 接口實現(xiàn)層comjeecmscmsserviceservice 封裝層comjeecmscmsstaticpage靜態(tài)頁的封裝包comjeecmscmsstaticpageexception靜態(tài)頁的異常處理類型comjeecmscmsstatistic流量統(tǒng)計包comjeecmscmsstatisti

13、cworkload內(nèi)容發(fā)布統(tǒng)計包comjeecmscmsweb攔截器包.3包介紹包介紹具體包名相關功能描述comjeecmscore一般常量和異常處理comjeecmscoreactionfront核心前臺的 actioncomjeecmscoredao核心 dao 的接口comjeecmscoredaoimpl核心 dao 的接口實現(xiàn)類comjeecmscoreentity登錄認證和核心用戶的實體子類comjeecmscoreentitybase登錄認證和核心用戶的實體基類comjeecmscoreentityhbm相關的 hibernate 的映射文件comjeecmsco

14、remanager核心的 service 接口層comjeecmscoremanagerimpl核心的 service 接口實現(xiàn)層comjeecmscoresecurity認證登錄、退出相關comjeecmscoretpl模板接口和相關 service 層comjeecmscoreweb定義內(nèi)容顯示的接口，工具類，和錯誤頁面的指定comjeecmscorewebutiluri 幫助類.4 頁面資源介紹頁面資源介紹具體包名相關功能描述WebContentr前臺資源文件，如 css、img、js 等res后臺資源文件thirdparty第三方插件（ckeditor 編輯器、swf

15、上傳、My97DatePicker 日項目名稱詳細設計說明書 期選擇）u默認的用戶上傳資源目錄WebContent/WEB-INFcache緩存文件common通用頁面config核心的配置文件，如果 action，service,manager,dao,bean 等directive標簽向?qū)０逦募rror錯誤頁面ftl自定義的 freemark 宏文件ispeekip 地址庫jeecms_sys后臺管理頁面account賬號綁定列表acquisition采集admin管理員advertising廣告advertising_space廣告版位channel欄目comment評論common

16、公用錯誤頁面config系統(tǒng)配置content內(nèi)容content_reuse內(nèi)容復用data數(shù)據(jù)備份department部門dictionary字典directive向?qū)撕瀎ile文件frame框架集friendlink友情鏈接friendlink_ctg友情鏈接分類ftpftpgroup用戶組guestbook留言guestbook_ctg留言分類item模型字段keyword關鍵詞log日志lucene全文檢索member會員menu自定義菜單message短消息model模型項目名稱詳細設計說明書 origin來源personal個人中心plug插件resource資源role角色sc

17、oregroup評分組scoreitem評分項searchwords搜索詞sensitivity敏感詞site站點site_config站點配置static靜態(tài)化statistic瀏覽統(tǒng)計tagTag 關鍵詞template模版topic專題type內(nèi)容類型visual可視化編輯unified_user用戶vote_topic投票workflow工作流workflowRecord工作流記錄languages國際化配置jeecms/admin后臺jeecms/front前臺jeecms/tpl模版jeecore/admin公用國際化lucenelucene 文件夾t/cms前臺模板頁面t/cms

18、/www站點資源目錄t/cms/www/plan站點方案3.3 軟件功能結構設計軟件功能結構設計的功能描述如下表所示，其詳細功能介紹請參見后面幾章內(nèi)容介紹。子系統(tǒng)功能描述項目名稱詳細設計說明書 模塊 1(1) 項目組公告通知及工作動態(tài)(2) 項目成果展示(3) 各農(nóng)村人居環(huán)境改善標準化試點單位的宣傳與展示(4) 其它媒體、部門與本項目相關的信息整理與發(fā)布(5) 相關新聞資訊發(fā)布模板 2(1) 內(nèi)部討論、互動交流(2) 文件共享(3) 網(wǎng)站視頻會議項目名稱模板 3(1) 農(nóng)村人居環(huán)境改善標準化試點單位運轉(zhuǎn)情況上報(2) 用農(nóng)村人居環(huán)境改善標準化試點單位上報數(shù)據(jù)指標提取(3) 各類地方標準分類上傳

19、共享(4) 試點單位工作動態(tài)、年終考核與項目驗收上報(5) 上報數(shù)據(jù)統(tǒng)計分析為決策服務(6) 國家標準委管理、跟蹤各試點單位工作情況3.4 系統(tǒng)運行環(huán)境系統(tǒng)運行環(huán)境服務器操作系統(tǒng)Windows 2008 Server數(shù)據(jù)庫管理系統(tǒng)（DBMS）MYSQL 5.6Web 服務器Apache Tomcat 7.X客戶端操作系統(tǒng)Windows 9X/2000/NT Workstation 系列客戶端 Web 瀏覽器IE7.0 以上或 firefox 等主流瀏覽器網(wǎng)絡傳輸協(xié)議TCP/IP、HTTP、FTP3.5 標準性與擴展性標準性與擴展性操作系統(tǒng)支持要求操作系統(tǒng)支持要求項目名稱詳細設計說明書 Windows 2008(x86,x64,EM64T,AMD64,Itanium)數(shù)據(jù)庫支持要求數(shù)據(jù)庫支持要求Mysql 5.6應用服務器支持要求應用服務器支持要求支持 JDK1.6 以上版本和 J2EE1.2 以上版本支持 JSP1.