日志系統(tǒng)用概要設(shè)計說明書

案卷號日期日志系統(tǒng)概要設(shè)計說明書作者：曾琦，楊興，龔錫寒完成日期：待定簽收人：簽收日期：修改情況記錄：版本號修改批準(zhǔn)人修改人安裝日期簽收人

目錄TOC\o"1-4"1引言 11.1編寫目的 11.2范圍 11.3定義 11.4參考資料 22總體設(shè)計 22.1需求規(guī)定 22.1.1根本功能 22.1.2根本需求 32.2運行環(huán)境 41硬件環(huán)境 42軟件環(huán)境 42.3根本設(shè)計概念和處理流程 52.3.1業(yè)務(wù)流程設(shè)計 62.3.2數(shù)據(jù)流程設(shè)計 112.4結(jié)構(gòu) 122.5功能需求與程序的關(guān)系 122.6人工處理過程 132.7尚未解決的問題 133接口設(shè)計 133.1用戶接口 133.2外部接口 133.3內(nèi)部接口 134運行設(shè)計 134.1運行模塊組合 134.2運行控制 144.3運行時間 145系統(tǒng)數(shù)據(jù)結(jié)構(gòu)設(shè)計 145.1邏輯結(jié)構(gòu)設(shè)計要點 145.2物理結(jié)構(gòu)設(shè)計要點 145.3數(shù)據(jù)結(jié)構(gòu)與程序的關(guān)系 146系統(tǒng)出錯處理設(shè)計 156.1出錯信息 156.2補救措施 156.3系統(tǒng)維護設(shè)計 151引言1.1編寫目的本文檔系統(tǒng)描述了日志系統(tǒng)的設(shè)計，主要閱讀對象為日志系統(tǒng)的工程經(jīng)理及軟件開發(fā)人員，測試日志系統(tǒng)的測試人員，需求分析師等。工程經(jīng)理：閱讀本文檔的全部描述信息，開發(fā)人員：重點閱讀是外部接口和內(nèi)部接口局部。需求分析師以及測試人員：重點閱讀是需求概述局部。1.2范圍軟件系統(tǒng)名稱：日志系統(tǒng)1.3定義列出本文件中用到的專門術(shù)語的定義和縮寫詞的原詞組。1.4參考資料2總體設(shè)計2.1需求規(guī)定2.1.1根本功能日志系統(tǒng)無論是作為一個獨立的系統(tǒng)還是作為其他系統(tǒng)的子系統(tǒng)都應(yīng)具備2個根本的功能2.1.1.1日志來源日志來源可以是使用日志系統(tǒng)的用戶自己或者其他調(diào)用日志系統(tǒng)的人，又或是其他需要記錄軟件日志的使用者。2.1.1.2日志輸出作為一個日志系統(tǒng)，需要有提供日志顯示的功能。當(dāng)日志系統(tǒng)記錄了日志時就應(yīng)當(dāng)提供日志顯示的功能給使用者查看這些日志，這樣才能提現(xiàn)這些日志的價值。當(dāng)然日志系統(tǒng)還可以根據(jù)用戶的需要增加一些自定義的功能：比方：日志的導(dǎo)出和日志的打印，以便用戶在需要對有價值的信息進行特定格式的保存或者打印成文檔的時候使用。2.1.2根本需求2.1.2.1記錄日志功能日志系統(tǒng)提供記錄日志的功能，記錄的日志可以有軟件的運行、用戶的操作行為。軟件的運行包括：軟件的運行狀態(tài)，用戶的操作行為包括：用戶使用軟件提供的功能時的行為。記 錄的日志信息包括：操作類型、操作結(jié)果、操作時間、操作者、操作目標(biāo)、操作者的IP地址。2.1.2.2查詢?nèi)罩竟δ?日志系統(tǒng)提供用戶日志、物流配送日志、員工信息日志、教務(wù)管理系統(tǒng)日志供用戶查詢，使用者可以根據(jù) 日志系統(tǒng)提供的查詢條件自行指定的條件進行查詢。 用戶日志可以根據(jù)：用戶ID、IP地址、用戶級別、開始時間、結(jié)束時間5個條件來查詢 需要的日志； 物流配送日志可以依據(jù)：子系統(tǒng)、操作類型、操作結(jié)果、用戶ID、源文件、目的文件、開始 時間、結(jié)束時間等9個條件來查詢；員工信息管理系統(tǒng)日志可以根據(jù)：子系統(tǒng)、操作類型、操作結(jié)果、用戶ID、預(yù)置點編號、目標(biāo)地址、開始時間、結(jié)束時間等9個條件來查詢；教務(wù)管理系統(tǒng)日志那么可以根據(jù)：子系統(tǒng)、用戶ID、操作類型、操作目標(biāo)、操作結(jié)果、開始時間、結(jié)束時間 等6個條件查詢。使用者可以自行決定搜索條件來查詢所需要的日志，日志系統(tǒng)將符合搜索條件的日志顯示到界面供用戶查看。2.1.2.3日志的導(dǎo)出功能當(dāng)使用者通過日志查詢查詢出日志后，可以選中某些需要保存的日志使用日志導(dǎo)出功能將這些日志保存為TXT或是WORD格式的文件。如果要保存為WORD格式的文件，必須保證使用者的電腦已經(jīng)安裝了OFFICE軟件，否那么會導(dǎo)出失敗。2.1.2.4日志的打印功能當(dāng)使用者通過日志查詢查詢出日志時，可以將對選中的日志信息進行打印操作。使用打印操作之前必須保證電腦已經(jīng)連接上了打印機，否那么將無法打印。2.2運行環(huán)境1硬件環(huán)境處理器：Pentium3或性能更好的處理器。內(nèi)存：512MB或以上。硬盤空間：500MB或以上的剩余空間。本系統(tǒng)對于硬件的要求不算太高，選擇計算機主要是本著經(jīng)濟、運行穩(wěn)定的原那么。目前主流的PC機就可以滿足本系統(tǒng)的運行要求。2軟件環(huán)境系統(tǒng)環(huán)境：只支持Microsoft(微軟)操作系統(tǒng)。版本代號為XPSP2或者比次版本更高的系統(tǒng)，如：Windows2003，WindowsVista，Windows7。數(shù)據(jù)庫：MYSQL5.5數(shù)據(jù)庫或更高版本的MYSQL。Windows操作系統(tǒng)以其友好的圖形界面，以及簡單的操作要求，深受用戶的青睞，另外他對使用者要求相對其他系統(tǒng)簡單，所以一般用戶都能直接上手。基于上述的考慮，選擇Windows系統(tǒng)作為軟件的運行環(huán)境，方便使用者的操作。2.3根本設(shè)計概念和處理流程業(yè)務(wù)流程設(shè)計2.3.1.1初始化用戶界面流程2.3.1.2寫入軟件運行日志流程2.3.1.3讀出軟件運行日志流程2.3.1.4搜索日志流程子流程或分支處理流程設(shè)計2.3.1.5.1數(shù)據(jù)庫操作模塊流程圖處理設(shè)計日志系統(tǒng)用戶界面模塊流程圖處理設(shè)計數(shù)據(jù)流程設(shè)計2.3.2.1寫入日志信息2.3.2.2讀出日志信息2.3.2.3搜索用戶日志2.4結(jié)構(gòu)用一覽表及框圖的形式說明本系統(tǒng)的系統(tǒng)元素〔各層模塊、子程序、公用程序等〕的劃分，扼要說明每個系統(tǒng)元素的標(biāo)識符和功能，分層次地給出各元素之間的控制與被控制關(guān)系。2.5功能需求與程序的關(guān)系數(shù)據(jù)庫操作模塊日志系統(tǒng)用戶界面模塊外部接口連接數(shù)據(jù)庫√執(zhí)行SQL語句√獲取行√獲取值√獲取字段長度√釋放數(shù)據(jù)指針√關(guān)閉數(shù)據(jù)庫√初始化界面√選擇日志類型√讀取日志√寫入日志√√搜索日志√退出客戶端√2.6人工處理過程說明在本軟件系統(tǒng)的工作過程中不得不包含的人工處理過程〔如果有的話〕。2.7尚未解決的問題說明在概要設(shè)計過程中尚未解決而設(shè)計者認(rèn)為在系統(tǒng)完成之前必須解決的各個問題。3接口設(shè)計3.1外部接口接口數(shù)據(jù)類型說明：Char*字符指針Const常量BOOL布爾型VOID空返回值函數(shù)功能需求對應(yīng)1BOOLWriteLog(char*pLogInfo,intnLogType)根據(jù)nLogtype的類型寫入對應(yīng)的日志1.11.21.31.42VOIDShowLogSysDlg〔〕顯示日志系統(tǒng)用戶界面，便于用戶查詢?nèi)罩竞蛯?dǎo)出、打印日志2.12.22.32.434BOOLWriteLog(char*pLogInfo,intnLogType)功能：寫入日志，根據(jù)nLogType的值寫入對應(yīng)的日志。nLogType的取值詳見參數(shù)說明參數(shù)：第一個參數(shù)以結(jié)構(gòu)體字符串常量形式傳入，第二個為一個整形變量，可選值為其下面其中之一：USERLOG：用戶日志;LogisticsLog:物流配送日志 EmployeeLog：員工信息日志 EducationalLog：教務(wù)系統(tǒng)日志；返回值：假設(shè)寫入成功，返回TRUE，否那么返回FALSE。無返回值ShowLogSysDlg〔〕功能：顯示日志系統(tǒng)用戶界面。參數(shù)：無。返回值：無。3.2內(nèi)部接口接口列表如下：返回值函數(shù)功能1BOOLInitAccessDB()初始化數(shù)據(jù)庫2BOOLCloseAccessDB()關(guān)閉數(shù)據(jù)庫3BOOLStoreIPAddr()將登錄過主系統(tǒng)的用戶的IP寫入下拉列表4BOOLStoreUserID()將登錄過主系統(tǒng)的用戶的ID寫入下拉列表5BOOLGetSoftwareLogChoices()當(dāng)用戶對軟件運行日志進行搜索時，獲取用戶選擇的篩選條件6BOOLGetUserLogChoices()當(dāng)用戶對用戶日志進行搜索時，獲取用戶選擇的篩選條件7BOOLInitComboBox()對除用戶ID及用戶IP以外的下拉列表框進行初始化8BOOLInitColumn()對列表控件進行初始化9BOOLReadSoftwareLogFromDB(constchar*szSql)將軟件運行日志從數(shù)據(jù)庫中讀出10BOOLReadUserLogFromDB()將用戶日志從數(shù)據(jù)庫中讀出11BOOLInitImageList()初始化圖標(biāo)列表12BOOLGetLastUser()取得數(shù)據(jù)庫中最后一個用戶記錄，作為當(dāng)前系統(tǒng)的使用者13BOOLOnSoftwareLogSearch()搜索軟件運行日志14BOOLOnUserLogSearch()搜索用戶日志BOOLInitAccessDB()功能：初始化數(shù)據(jù)庫。參數(shù)：無。返回值：假設(shè)成功返回TRUE，否那么返回FALSE。BOOLCloseAccessDB()功能：關(guān)閉數(shù)據(jù)庫。參數(shù)：無。返回值：假設(shè)成功返回TRUE，否那么返回FALSE。 BOOLStoreIPAddr()功能：將登錄過主系統(tǒng)的用戶的IP寫入下拉列表。參數(shù)：無。返回值：假設(shè)成功返回TRUE，否那么返回FALSE。 BOOLStoreUserID()功能：將登錄過主系統(tǒng)的用戶的ID寫入下拉列表。參數(shù)：無。返回值：假設(shè)成功返回TRUE，否那么返回FALSE。 BOOLGetSoftwareLogChoices()功能：當(dāng)用戶對軟件運行日志進行搜索時，獲取用戶選擇的篩選條件。參數(shù)：無。返回值：假設(shè)成功返回TRUE，否那么返回FALSE。 BOOLGetUserLogChoices()功能：當(dāng)用戶對用戶日志進行搜索時，獲取用戶選擇的篩選條件。參數(shù)：無。返回值：假設(shè)成功返回TRUE，否那么返回FALSE。 BOOLInitComboBox()功能：對除用戶ID及用戶IP以外的下拉列表框進行初始化。參數(shù)：無。返回值：假設(shè)成功返回TRUE，否那么返回FALSE。 BOOLInitColumn()功能：對列表控件進行初始化。參數(shù)：無。返回值：假設(shè)成功返回TRUE，否那么返回FALSE。 BOOLReadSoftwareLogFromDB(constchar*) 功能：將軟件運行日志從數(shù)據(jù)庫中讀出。參數(shù)：假設(shè)需要讀取存儲系統(tǒng)，傳入”StoreLog”，假設(shè)需要讀取云臺系統(tǒng)，傳入”CloudLog”，大小寫不透明。返回值：假設(shè)成功返回TRUE，否那么返回FALSE。 BOOLReadUserLogFromDB()功能：將用戶日志從數(shù)據(jù)庫中讀出。參數(shù)：無。返回值：假設(shè)成功返回TRUE，否那么返回FALSE。BOOLInitImageList()功能：初始化圖標(biāo)列表。參數(shù)：無。返回值：假設(shè)成功返回TRUE，否那么返回FALSE。BOOLGetLastUser()功能：取得數(shù)據(jù)庫中最后一個用戶記錄，作為當(dāng)前系統(tǒng)的使用者。參數(shù)：無。返回值：假設(shè)成功返回TRUE，否那么返回FALSE。BOOLOnSoftwareLogSearch()功能：搜索軟件運行日志。參數(shù)：無返回值：假設(shè)成功返回TRUE，否那么返回FALSE。BOOLOnUserLogSearch()功能：搜索用戶日志。參數(shù)：無返回值：假設(shè)成功返回TRUE，否那么返回FALSE。4運行設(shè)計4.1運行模塊組合說明對系統(tǒng)施加不同的外界運行控制時所引起的各種不同的運行模塊組合，說明每種運行所歷經(jīng)的內(nèi)部模塊和支持軟件。4.2運行控制第一階段實例化對象并初始化。 m_DB=newCDBAccess();實例化數(shù)據(jù)庫對象：m_DB。調(diào)用函數(shù)布爾值Init()，初始化數(shù)據(jù)庫m_DB對象。布爾值Connect(constTCHAR*Host,constTCHAR*User,constTCHAR*Password,constTCHAR*Database,DWORDPort)，連接數(shù)據(jù)庫。如果成功，第二階段。布爾值initComboBox(),初始化下拉列表 字符串GetChoices()，獲取用戶在篩選區(qū)中說要獲取日志信息的條件。布爾值ReadUserLog(CStringstrSQL)，從數(shù)據(jù)庫中獲取用戶所需要的用戶日志 布爾值ReadLogisticsLog(CStringstrSQL)，從數(shù)據(jù)庫中獲取用戶所需要的物流配送日志布爾值ReadEmployeeLog(CStringstrSQL)，從數(shù)據(jù)庫中獲取用戶所需要的員工信息日志布爾值ReadEducationalLog(CStringstrSQL)，從數(shù)據(jù)庫中獲取用戶所需要的教務(wù)系統(tǒng)信息日志布爾值Close〔〕，關(guān)閉數(shù)據(jù)庫第三階段： 當(dāng)整個系統(tǒng)退出時，調(diào)用布爾值ReleaseDB()釋放資源，退出系統(tǒng)。讀取日志程序調(diào)用流程如下圖：讀取日志程序調(diào)用流程圖寫入日志程序調(diào)用流程如圖4.3運行時間日志系統(tǒng)可以作為一個系統(tǒng)獨立運行，也可以作為其他工程的子系統(tǒng)。當(dāng)作為其他系統(tǒng)的子系統(tǒng)時，其生命周期從日志系統(tǒng)被初始化開始到其他子系統(tǒng)停止工作時結(jié)束。本系統(tǒng)主要是作為整個軟件的一局部，并為其他的子系統(tǒng)提供效勞的，所以他的運行時間主要取決于其他幾個子系統(tǒng)的運行時間，如果其他子系統(tǒng)〔物流配送，員工信息，教務(wù)管理系統(tǒng)等〕一直沒有退出或是關(guān)閉