詳細設計說明書(僅供參考)

南陽市地方稅務局直屬局網站管理系統(tǒng)詳細設計說明書PAGEPAGE34

南陽市地方稅務局直屬局網站管理系統(tǒng)詳細設計說明書文件狀態(tài)：[]草稿[√]正式發(fā)布[]正在修改文件標識：APP-WEBAPP-NYR-SD-DETAIL當前版本：1.0作者：鄭州仟佰完成日期：2012-04-27鄭州仟佰網絡技術有限公司地址:鄭州市東風路與文化路交叉處小南國對面電話:0371-6013286860132869傳真箱:appcom@網址:目錄一、引言 31.1編寫目的 31.2背景 31.3定義 31.4參考文獻 4二、系統(tǒng)框架結構 4三、系統(tǒng)的結構 6四、本軟件各模塊的設計說明 84.1安全管理模塊 84.1.1用戶管理 84.1.2模塊管理 94.1.3權限管理 104.1.4數(shù)據(jù)庫備份 114.1.5網站瀏覽量統(tǒng)計 114.1.6信息采用量統(tǒng)計 124.2在線考試模塊 124.3網上簽到模塊 144.4下載管理模塊 154.4.1網上圖書館 164.4.2下載中心 174.5專題管理模塊 174.5.1熱點專欄 174.5.2科室動態(tài) 184.5.3征納互動 194.5.4休閑驛站 204.5.5信息發(fā)布 214.6菜單管理模塊 224.6.1本局簡介 224.6.2政策法規(guī) 234.6.3辦稅指南 244.6.4教育培訓 254.6.5廉政建設 264.6.6資訊中心 274.7系統(tǒng)結構管理模塊 284.7.1頁眉管理 284.7.2頁腳管理 294.7.3菜單項管理 30五、外部接口 30一、引言1.1編寫目的為開發(fā)人員提供一份針對本系統(tǒng)實現(xiàn)的具體設計方案和實現(xiàn)方法，也讓系統(tǒng)用戶對開發(fā)的功能有個大致了解。1.2背景軟件名稱：南陽市地方稅務局直屬局網站管理系統(tǒng)委托單位：南陽市地方稅務局直屬稅務分局承辦單位：鄭州仟佰網絡技術有限公司1.3定義類圖：類圖(Classdiagram)是顯示了模型的靜態(tài)結構，特別是模型中存在的類、類的內部結構以及它們與其他類的關系等，用于描述系統(tǒng)的結構化設計。對象圖：對象圖(ObjectDiagram)是顯示了一組對象和他們之間的關系的圖示，一個對象圖可看成一個類圖的特殊用例，狀態(tài)圖：狀態(tài)圖(StateDiagram)是描述一個實體基于事件反應的動態(tài)行為，顯示了該實體如何根據(jù)當前所處的狀態(tài)對不同的時間做出反應的，用于顯示狀態(tài)機（它指定對象所在的狀態(tài)序列）、使對象達到這些狀態(tài)的事件和條件、以及達到這些狀態(tài)時所發(fā)生的操作。1.4參考文獻《中華人民共和國國家標準計算機軟件產品開發(fā)文件編寫指南》中華人民共和國電子工業(yè)部《中華人民共和國國家標準信息處理-數(shù)據(jù)流程圖、程序流程圖、系統(tǒng)流程圖、程序網絡圖和系統(tǒng)資源圖的文件編制符號及約定》中華人民共和國機械電子工業(yè)部《中華人民共和國國家標準計算機軟件產品開發(fā)文件編寫指南》中華人民共和國電子工業(yè)部《中華人民共和國國家標準信息處理-數(shù)據(jù)流程圖、程序流程圖、系統(tǒng)流程圖、程序網絡圖和系統(tǒng)資源圖的文件編制符號及約定》中華人民共和國機械電子工業(yè)部GB8566-88計算機軟件開發(fā)規(guī)范GB9385-88計算機軟件需求說明編制指南GB9386-88計算機軟件測試文件編制規(guī)范BG/T12504-90計算機軟件質量保證計劃規(guī)范GB/T12505-90計算機軟件配置管理計劃規(guī)范二、系統(tǒng)框架結構本系統(tǒng)采用三層架構設計，三層架構就是將整個業(yè)務應用劃分為：表現(xiàn)層（UI）、業(yè)務邏輯層（BLL）、數(shù)據(jù)訪問層（DAL）。區(qū)分層次的目的即為了“高內聚，低耦合”的思想。１、表現(xiàn)層（UI）：通俗講就是展現(xiàn)給用戶的界面，即用戶在使用一個系統(tǒng)的時候他的所見所得。２、業(yè)務邏輯層（BLL）：針對具體問題的操作，也可以說是對數(shù)據(jù)層的操作，對數(shù)據(jù)業(yè)務邏輯處理。３、數(shù)據(jù)訪問層（DAL）：該層所做事務直接操作數(shù)據(jù)庫，針對數(shù)據(jù)的增添、刪除、修改、更新、查找等。3個層次中，系統(tǒng)主要功能和業(yè)務邏輯都在業(yè)務邏輯層進行處理。三層體系將業(yè)務規(guī)則、數(shù)據(jù)訪問及合法性校驗等工作放在中間層處理?？蛻舳瞬恢苯优c數(shù)據(jù)庫交互，而是通過組件與中間層建立連接，再由中間層與數(shù)據(jù)庫交互。中間層采用的是流行的Spring+Hibernate+Struts，為了將控制層與業(yè)務邏輯層分離，又細分為以下幾種。Web層：就是MVC模式里面的“C”（controller），負責控制業(yè)務邏輯層與表現(xiàn)層的交互，調用業(yè)務邏輯層，并將業(yè)務數(shù)據(jù)返回給表現(xiàn)層作組織表現(xiàn)，該系統(tǒng)的MVC框架采用Struts。Service層（就是業(yè)務邏輯層）：負責實現(xiàn)業(yè)務邏輯。業(yè)務邏輯層以DAO層為基礎，通過對DAO組件的正面模式包裝，完成系統(tǒng)所要求的業(yè)務邏輯。DAO層：負責與持久化對象交互。該層封裝了數(shù)據(jù)的增、刪、查、改的操作。PO（持久化對象）：通過實體關系映射工具將關系型數(shù)據(jù)庫的數(shù)據(jù)映射成對象，很方便地實現(xiàn)以面向對象方式操作數(shù)據(jù)庫，該系統(tǒng)采用Hibernate作為ORM框架，將Strust2作為流程控制。Spring的作用貫穿了整個中間層，將Web層、Service層、DAO層及PO無縫整合，其數(shù)據(jù)服務層用來存放數(shù)據(jù)。本系統(tǒng)中用到的這三層的結構層次如下圖所示：三、系統(tǒng)的結構系統(tǒng)的結構主要由兩方面構成，一是系統(tǒng)的軟件結構框圖，二是系統(tǒng)的硬件結構框圖。軟件結構框圖中將給出系統(tǒng)所應分層的頂級模塊；而硬件結構框圖將給出系統(tǒng)運行的硬件結構示意圖；本軟件采用傳統(tǒng)的軟件開發(fā)生命周期的方法，采用自頂向下，逐步求精的結構化的軟件設計方法，圖表如下：四、本軟件各模塊的設計說明以下為系統(tǒng)中各模塊的具體設計實現(xiàn)方案，對于層次比較低的模塊或子程序，如實現(xiàn)方法與條目中其他已闡述模塊實現(xiàn)方法相同，則只給出不用之處，相同之處不再一一詳述。4.1安全管理模塊本模塊是用來維護系統(tǒng)安全，防止非法登錄，進行非法數(shù)據(jù)修改而設立的模塊。其中包含三個子模塊，分別為用戶管理、模塊管理、角色管理等。其特點是高安全性和嚴謹性。4.1.1用戶管理模塊描述：用來對使用本系統(tǒng)軟件的用戶進行管理。功能：對用戶的增加、刪除、修改、查詢以及是否啟用。性能：頁面風格與主頁面風格一致。頁面操作要方便用戶使用。輸入項：用戶名、真實姓名、登錄、密碼、角色等輸出項：用戶信息設計方法：添加、修改、刪除成功后都要返回默認列表頁，查詢時根據(jù)角色進行查詢，多種查詢方法（按時間、類型等），查詢所有角色，得到列表頁。限制條件：用戶名、密碼、角色等必須填寫，其中密碼位數(shù)至少為6。流程圖：數(shù)據(jù)庫設計表：用戶管理：tb_user字段名稱字段類型字段要求字段描述idnumber(10)PK,NOTNULL用戶iduserNameVarchar(25)Notnull用戶名realNameVarchar(25)Notnull真實姓名passwordVarchar(25)Notnull登陸密碼roleIdnumber(10)引用tb_role表id所屬角色id4.1.2模塊管理模塊描述：對系統(tǒng)中所有要用到的功能模塊進行管理。功能：對各模塊的增加、刪除、修改、查詢。性能：頁面風格與主頁面風格一致。頁面操作要方便用戶使用。輸入項：名稱、路徑、描述、模塊類型。輸出項：模塊對象設計方法：這是一個自關聯(lián)類，一對多的關系映射，通過制定不同的pid來實現(xiàn)多級分層。限制條件：名稱不能為空，默認狀態(tài)序號為0。流程圖：數(shù)據(jù)庫設計表：模塊管理：tb_moudle字段名稱字段類型字段要求字段描述idInt(11)PK,NOTNULL模塊idnameVarchar(25)Notnull,nuique模塊名稱urlVarchar(100)Notnull路徑descripeVatchar（100）描述faMoudleInt(11)FK,引用tb_moudle模塊類型4.1.3權限管理模塊描述：對登錄此系統(tǒng)后臺的用戶分配操作權限。功能：分配權限，包括添加、刪除。性能：即時生效。輸入項：狀態(tài)選擇。輸出項：用戶組權限表。設計方法：每一條權限記錄對應一個用戶組和一個模塊，可以實現(xiàn)對一個用戶組的權限分配，分配的實質就是讓該用戶組的用戶擁有對指定模塊的操作權限。限制條件：無流程圖：4.1.4數(shù)據(jù)庫備份數(shù)據(jù)庫備份是為了防止由于服務器不可預測的故障而導致的數(shù)據(jù)損壞或丟失的一種補償手段，通過此功能，用戶可以在任何時間對數(shù)據(jù)進行備份，及時阻止數(shù)據(jù)的損害或丟失。本功能主要通過JDBC連接數(shù)據(jù)庫（需要用戶名，密碼和數(shù)據(jù)庫名稱），而后利用數(shù)據(jù)庫mysqldump命令將數(shù)據(jù)庫導出的方式實現(xiàn)，此功能要求用戶輸入的數(shù)據(jù)庫用戶名和密碼全部正確才能進行，另一個限制條件是用戶所輸入的數(shù)據(jù)庫名稱必須存在才可以成功備份。4.1.5網站瀏覽量統(tǒng)計此模塊是網站為統(tǒng)計訪問此系統(tǒng)的次數(shù)而設計的，其中用到了一個表來儲存信息，當此網站的首頁被訪問時，系統(tǒng)便會將用戶生成的session標識號記錄到數(shù)據(jù)庫中，為了防止惡意刷新，系統(tǒng)將會先判斷用戶的sessionID是否跟已存儲的相同，如果有相同的說明則不進行重復插入，若沒有相同的則進行插入操作。后臺管理用戶可以根據(jù)時間段或者sessionid對庫中記錄進行查詢操作。類圖：4.1.6信息采用量統(tǒng)計為了增加系統(tǒng)的互動性，本系統(tǒng)需開發(fā)投稿功能，當所投稿件被系統(tǒng)采用一次，所投信息稿件的采用次數(shù)就會相應增加1，其中設計此模塊所需用到的類如下：4.2在線考試模塊模塊描述：實現(xiàn)系統(tǒng)用戶在線考試的試題管理功能：試題庫的管理、試卷信息管理、試卷內容管理、考試成績管理輸入項：試題庫管理：名稱試卷信息管理：發(fā)布人、考試時間、選擇題數(shù)、每個選擇題分數(shù)、判斷題數(shù)和每個判斷題分數(shù)試卷內容管理：題目、選項A,B,C,D、正確答案考試成績管理：無輸出項：試題庫管理：一個試題庫試卷信息管理：一套試卷試卷內容管理：試卷中一道題目考試成績管理：自動生成考試成績設計方法：按照傳統(tǒng)紙質試卷考試的規(guī)范，設計出試題庫，試卷，內容，答案，考試結果等類，其中一個試題庫中可以有很多套試卷，而一套試卷有可以有很多道題目（目前題目類型為選擇題或判斷題），一道題目可能被很多考生來答，因而就會有很多種答案，一名考生在不同考試時期會考試很多次，所以會有很多種考試結果。限制條件：表中各輸入項均不能為空。類圖：4.3網上簽到模塊網上簽到模塊主要是對員工的考勤狀況施行網上考核的的功能，根據(jù)現(xiàn)有情況，系統(tǒng)設計了三個類，分別是上班時間類，簽到記錄類和請假類?？傮w設計是上班時間類中規(guī)定了每天上下班所應到達單位的時間，包括上午和下午共四個時間點，如果員工沒有按照規(guī)定的時間進行簽到，則被視為遲到或早退；每天用戶在四個時間點進行攝像簽到時，簽到時間和相片都會自動存入數(shù)據(jù)庫中，并根據(jù)簽到時間判斷出簽到是否正常，并一并存入每個時間段記錄中；如果員工有特殊情況請假了，則將請假信息記入請假表中。限制條件：用戶必須有簽到才能進行相應的簽退，若用戶在上午沒有簽到，則不可以進行上午簽退操作，但是可以進行下午的簽到操作；下午情況與上午相同。根據(jù)設計，程序中主要用到的類有如下幾個：4.4下載管理模塊下載管理模塊是為了替訪問本站的用戶提供資料下載而設立的模塊，主要包括兩個子模塊，網上圖書館和下載中心，由于兩個模塊在設計上幾乎是相同的，所以只著重講解其中之一，后者只給出所用到的類圖。4.4.1網上圖書館模塊描述：提供網上圖書下載功能。功能：后臺實現(xiàn)圖書資源分類、上傳功能；前臺實現(xiàn)圖書資源瀏覽、下載功能。性能：后臺上傳附件對于小于1M的附件資源，上傳完成時間不超過5秒鐘，對于大于1M的附件資源，視附件大小而定。輸入項：標題、類型、描述、資源文件、圖片文件。輸出項：一條下載記錄。設計方法：從后臺上傳的資源分為圖書資源和圖片資源，它們不是存儲在數(shù)據(jù)庫中，而是以文件的形式存儲在硬盤空間上，當需要調用時，按照給定的路徑直接從硬盤上讀取供用戶下載。限制條件：標題、類型和所需上傳的文件都不能為空。類圖：4.4.2下載中心本模塊功能與網上圖書館類似，在此不再贅述，只給出相關類圖：4.5專題管理模塊4.5.1熱點專欄模塊描述：為專欄欄目提供管理功能。功能：專欄類型的增加、刪除、修改、查詢；專欄欄目的增加、刪除、修改、查詢；專欄信息的增加、刪除、修改、查詢。性能：后臺添加頁面操作響應時間不大于3秒，前臺一級欄目頁打開時間不大于5秒，二級列表頁不大于3秒，詳細信息顯示不大于2秒。輸入項：【類型名、類型圖片】【專欄名稱、編輯、類型名】【標題、作者、內容、信息圖片、所屬專欄】。輸出項：【一種專欄類型】【一個專欄欄目】【一條專欄信息】設計方法：根據(jù)需求設計說明書，專欄需要分為3級，類似于省、市、縣的分層結構，特設計出了三個互相關聯(lián)的類，用來逐級向下細化來實現(xiàn)。限制條件：專欄類型名、類型圖片、專欄名稱、編輯、標題、作者、所屬專欄均不能為空，在輸入專欄欄目時，要求必須選擇所屬的類型，在輸入專欄信息時，則必須選擇一個已經存在的所屬專欄。類圖：4.5.2科室動態(tài)模塊描述：對科室頻道的信息管理功能：實現(xiàn)科室的增加、刪除、修改、查詢；實現(xiàn)對所屬科室新聞信息的增加、刪除、修改、查詢。性能：后臺錄入完成時間不超過3秒，前臺顯示時間不超過3秒。輸入項：【科室名稱、聯(lián)系電話、職能描述】【標題、來源、所屬科室、內容、信息圖片】。輸出項：【一個科室】【一條科室新聞信息】。設計方法：根據(jù)需求設計說明書，要求先增加科室，然后可以增加科室所屬的信息（也稱為科室工作動態(tài)）。限制條件：科室名稱、標題、來源不能為空。類圖：4.5.3征納互動此模塊用來增加系統(tǒng)和訪客的互動性而設立，除了前面講過的投稿模塊外，還包含有：舉報箱、局長信箱和網上征求意見三個模塊，由于三個模塊實現(xiàn)方法一樣，所以只著重給出舉報箱實現(xiàn)方法，其他只給出類圖。舉報箱模塊：模塊描述：讓訪客對本局工作中的不良之處進行舉報。功能：實現(xiàn)舉報箱信息的增加、刪除和查詢。輸入項：姓名、郵箱、電話、標題、內容輸出項：一條舉報箱信息設計方法：用戶由前臺添加后，管理員可以在后臺對舉報箱中舉報信息進行刪除和查詢。限制條件：標題和姓名不能為空類圖：4.5.4休閑驛站此模塊供訪客休閑娛樂之用，其中包括8個子模塊，分別為攝影作品、攝影天地、音樂天地、文學殿堂、健康在線、影視在線、稅收文化和攝影技巧，由于八個模塊實現(xiàn)方法一樣，所以只著重給出攝影作品實現(xiàn)方法，其它子模塊只給出類圖。攝影作品模塊：模塊描述：攝影作品展示。功能：后臺攝影作品的增加、刪除、修改、查詢，前臺觀賞。輸入項：標題、攝影作者、內容和圖片上傳。輸出項：一條攝影作品記錄。設計方法：對于文字內容，直接存儲在數(shù)據(jù)庫中，對于圖片資源和附件資源，將存儲在硬盤物理空間上，數(shù)據(jù)庫中只存儲相應的路徑，等到需要調用時，根據(jù)路徑去獲取資源文件。限制條件：無類圖：4.5.5信息發(fā)布此模塊包含六個子模塊，分別為稅收進度、圖片新聞、攝影圖片、納稅咨詢、稅收調研和執(zhí)法考核，由于各子模塊與3.5.4節(jié)中各模塊實現(xiàn)方法一樣，所以只給出相關類圖：4.6菜單管理模塊4.6.1本局簡介本模塊是對本局的一個簡要的介紹，主要包括四個子模塊，分別為：全局概況、機構設置、局長寄語和領導介紹。由于此模塊的特點，所以在設計時先對每個模塊初始化一條記錄，系統(tǒng)用戶只有權限進行信息的更新修改，而沒有權限進行增加和刪除。由于此模塊比較簡單，只給出相關的類圖。4.6.2政策法規(guī)本模塊由稅收法規(guī)庫和政策解讀兩個子模塊構成，稅收法規(guī)庫主要是對不同的稅法類型而發(fā)布的稅收法規(guī)信息進行管理，而政策解讀是關于政策的一些常識；主要給出設計政策法規(guī)庫的方法，政策解讀只給出類圖。政策法規(guī)庫：模塊描述：對政策法規(guī)信息進行管理。功能：實現(xiàn)政策法規(guī)信息的增加、刪除、修改、查詢操作。性能：增加、刪除、修改、查詢操作不超過3秒鐘，查詢操作不超過5秒鐘。輸入項：類型、標題、來源、發(fā)字號、內容。輸出項：一條法規(guī)庫信息。設計方法：根據(jù)法規(guī)庫的特點，將法規(guī)庫類型和具體信息分離，分到兩個表中，即類型一個表（用類表示），具體信息一個表（用類表示），兩個表之間是一對多的關聯(lián)。限制條件：除內容輸入項外，其余輸入項均不能為空。類圖：4.6.3辦稅指南本模塊是對一些辦稅方面的知識所做的宣傳，主要包括稅務登記、認定管理、發(fā)票管理、稅收優(yōu)惠管理、申報征收、納稅擔保申請和稅務行政救濟七個子模塊，由于七個子模塊用到的表結構一模一樣，所以只給出稅務登記設計方法，其他只給出相應表名，表結構參考稅務登記即可。稅務登記：模塊描述：稅務登記知識指南。功能：稅務登記知識的增加、刪除、修改、查詢。輸入項：標題、來源、內容。輸出項：一條稅務登記記錄。限制條件：標題不能為空。類圖：以下將給出其他各模塊對應類名：認定管理：CognizanceManager發(fā)票管理：Invoice稅收優(yōu)惠管理：Favour申報征收：DeclareImposition納稅擔保申請：AssureApply稅務行政救濟：RevenueRelieve4.6.4教育培訓除了上文已經介紹過的在線考試模塊外，教育培訓還包括有稅收業(yè)務講座、信息化知識和稅收稽查典型案例三個子模塊，由于這三個子模塊具有相同的存儲結構，以下不再詳述，只給出稅收業(yè)務講座模塊的體系結構和設計思想。稅收業(yè)務講座：模塊描述：稅收業(yè)務講座信息管理。功能：本模塊信息的增加、刪除、修改、查詢。輸入項：標題、內容。輸出項：一條信息記錄。設計方法：用戶輸入標題和內容之后，當向庫中插入數(shù)據(jù)時，系統(tǒng)會提取出登錄當前系統(tǒng)的用戶名一并存入數(shù)據(jù)庫中，作為發(fā)布人。限制條件：標題不能為空。類圖：4.6.5廉政建設此模塊包含三個子模塊，分別為：廉政文化、學習園地和廉政動態(tài)。由于這三個子模塊具有相同的存儲結構，以下不再詳述，只給出廉政文化模塊的體系結構和設計思想。廉政文化：模塊描述：廉政文化信息管理。功能：實現(xiàn)廉政文化信息的增加、刪除、修改、查詢。輸入項：標題、來源、內容。輸出項：一條信息記錄。設計方法：用戶輸入標題和內容以及來源之后，當向庫中插入數(shù)據(jù)時，系統(tǒng)會提取出登錄當前系統(tǒng)的用戶名一并存入數(shù)據(jù)庫中，作為發(fā)布人。類圖：4.6.6資訊中心此模塊涉及的是一些新聞資訊信息的管理，它包含六個子模塊，分別為工作