2024軟件信息項(xiàng)目概要設(shè)計(jì)說明書模版_第1頁
2024軟件信息項(xiàng)目概要設(shè)計(jì)說明書模版_第2頁
2024軟件信息項(xiàng)目概要設(shè)計(jì)說明書模版_第3頁
2024軟件信息項(xiàng)目概要設(shè)計(jì)說明書模版_第4頁
2024軟件信息項(xiàng)目概要設(shè)計(jì)說明書模版_第5頁
已閱讀5頁,還剩31頁未讀, 繼續(xù)免費(fèi)閱讀

下載本文檔

版權(quán)說明:本文檔由用戶提供并上傳,收益歸屬內(nèi)容提供方,若內(nèi)容存在侵權(quán),請(qǐng)進(jìn)行舉報(bào)或認(rèn)領(lǐng)

文檔簡(jiǎn)介

(項(xiàng)目名稱)概要設(shè)計(jì)說明書文件控制?受控不受控文檔編號(hào)版本號(hào)分冊(cè)名稱第冊(cè)/共冊(cè)總頁數(shù)正文附錄編制審批生效日期項(xiàng)目名稱概要設(shè)計(jì)說明書-修改變更記錄:更改條款及內(nèi)容更改人審批人版本更改日期PAGEI目錄TOC\o"1-4"\h\z1 引言 41.1 編制目的 41.2 術(shù)語表 41.3 參考資料 42 概述 62.1 設(shè)計(jì)原則 62.2 假定和約束 73 總體設(shè)計(jì) 93.1 技術(shù)路線 93.2 總體架構(gòu) 93.3 應(yīng)用架構(gòu) 113.3.1 與數(shù)字化項(xiàng)目應(yīng)用架構(gòu)關(guān)系 113.3.2 應(yīng)用架構(gòu)圖 123.3.3 業(yè)務(wù)模塊清單 133.4 總體數(shù)據(jù)流圖 143.5 網(wǎng)絡(luò)架構(gòu) 143.6 復(fù)用策略 153.7 公共組件設(shè)計(jì) 153.8 命名及目錄設(shè)計(jì) 163.8.1 前臺(tái)工程 163.8.2 后臺(tái)服務(wù) 163.9 通用要求 164 業(yè)務(wù)應(yīng)用模塊設(shè)計(jì) 184.1 設(shè)備管理模塊(pas-example-equip) 184.1.1 功能清單 184.1.2 模塊目錄結(jié)構(gòu) 184.1.3 AD01.01視頻遠(yuǎn)程集中監(jiān)視 19 數(shù)據(jù)流程圖 20 處理過程 20 功能目錄結(jié)構(gòu) 22 界面設(shè)計(jì) 224.1.4 AD01.02設(shè)備缺陷 234.1.5 模塊間接口設(shè)計(jì)清單 234.1.6 外部系統(tǒng)接口設(shè)計(jì)清單 234.1.7 公共數(shù)據(jù)項(xiàng)清單 234.1.8 數(shù)據(jù)庫物理模型 234.2 運(yùn)行管理(pas-example-operation) 245 系統(tǒng)安全性設(shè)計(jì) 255.1 數(shù)據(jù)安全 255.2 應(yīng)用安全 255.3 服務(wù)器安全 275.4 網(wǎng)絡(luò)安全 276 非功能性需求設(shè)計(jì) 296.1 可管理性設(shè)計(jì) 296.2 可擴(kuò)展性設(shè)計(jì) 296.3 可靠性設(shè)計(jì) 296.4 性能設(shè)計(jì) 307 部署設(shè)計(jì)(生產(chǎn)環(huán)境集成) 318 人工處理過程 329 尚未解決的問題 33-PAGE33-編寫指南:本模板力圖給出系統(tǒng)設(shè)計(jì)階段應(yīng)包括的概要信息,重點(diǎn)在于把需求分析轉(zhuǎn)換為軟件系統(tǒng)的實(shí)現(xiàn)、描述系統(tǒng)整體情況、模塊劃分情況、模塊之間的關(guān)系等等。如果某個(gè)章節(jié)在項(xiàng)目或當(dāng)前階段中無法描述,則可保留其標(biāo)題,注明“不適用”。如果需要對(duì)本模板的個(gè)別章節(jié)詳細(xì)描述,也可將其形成單獨(dú)的文檔,成為本文檔附件。若文檔中的某個(gè)章節(jié)已經(jīng)在其他項(xiàng)目文檔中加以描述,可保留標(biāo)題,注明“參見(文檔編號(hào))(文檔名稱)(條款)”。形成正式文檔后宜刪除斜體字內(nèi)容。說明書編制要求:這里列出本系統(tǒng)設(shè)計(jì)說明書編制的經(jīng)驗(yàn)性要求,須由系統(tǒng)設(shè)計(jì)人員參照其進(jìn)行裁剪以確定本次報(bào)告編制的相關(guān)規(guī)定。序號(hào)要求1對(duì)系統(tǒng)、模塊結(jié)構(gòu)圖要求采用Visio繪制2各種UML圖形要求采用PowerDesigner繪制3數(shù)據(jù)庫結(jié)構(gòu)圖要求采用PowerDesigner繪制的概念模型4對(duì)數(shù)據(jù)庫結(jié)構(gòu)的描述要求采用圖形方式描述,而非采用過多表格5數(shù)據(jù)庫結(jié)構(gòu)圖主要包括:表實(shí)體、表間關(guān)系、主要字段、相關(guān)說明四部分6對(duì)于平臺(tái)性產(chǎn)品,要求有系統(tǒng)層次的劃分圖對(duì)應(yīng)模塊目錄結(jié)構(gòu),為方便理解,以下給出目錄范例,在項(xiàng)目編制概要設(shè)計(jì)書時(shí),刪除范例就可。(1)前端模塊目錄結(jié)構(gòu)范例:(2)后端模塊目錄結(jié)構(gòu)范例:(3)后端模塊接口目錄結(jié)構(gòu)范例:引言編制目的本說明書全面定義系統(tǒng)的產(chǎn)品特性,是在充分理解需求分析過程輸出工件《軟件規(guī)格說明書》、原型設(shè)計(jì)等的基礎(chǔ)上,為詳細(xì)設(shè)計(jì)及編碼實(shí)現(xiàn)過程確定基礎(chǔ),同時(shí)也是與用戶交流、交付的工件之一。文檔將:1. 確定軟件模塊組成。2. 確定軟件需求的技術(shù)解決方案細(xì)節(jié)。3. 確定各模塊的功能和用戶接口。本說明書的主要讀者為系統(tǒng)用戶,軟件設(shè)計(jì)師(詳細(xì)設(shè)計(jì)),程序開發(fā)員,測(cè)試人員,售后技術(shù)支持人員等。術(shù)語表注:數(shù)字項(xiàng)目需統(tǒng)一文檔中的術(shù)語標(biāo)準(zhǔn),優(yōu)先引用《CDT_PM_數(shù)字建設(shè)項(xiàng)目_名稱解釋》。1.列出本說明書中用到的專業(yè)術(shù)語或縮寫的解釋。2.需求規(guī)格說明書中與本說明書相關(guān)的術(shù)語應(yīng)引用到下表。例如:序號(hào)術(shù)語/縮寫解釋1ATM:AsynchronousTransferMode(異步傳輸模式)2碳足跡也稱碳流,碳足跡,英文為CarbonFootprint,是指企業(yè)機(jī)構(gòu)、活動(dòng)、產(chǎn)品或個(gè)人通過交通運(yùn)輸、食品生產(chǎn)和消費(fèi)以及各類生產(chǎn)過程等引起的溫室氣體排放的集合。它描述了一個(gè)人的能源意識(shí)和行為對(duì)自然界產(chǎn)生的影響,號(hào)召人們從自我做起。已有部分企業(yè)開始踐行減少碳足跡的環(huán)保理念。參考資料注:列出本說明書有關(guān)的參考文件,說明能夠得到這些文件資料的來源:本文件中各處引用的文件、資料,包括所要用到的軟件設(shè)計(jì)、開發(fā)標(biāo)準(zhǔn);本項(xiàng)目的經(jīng)核準(zhǔn)的計(jì)劃任務(wù)書或合同,上級(jí)機(jī)關(guān)的批文、需求規(guī)格說明書;屬于本項(xiàng)目的其他已發(fā)表的與設(shè)計(jì)、開發(fā)過程相關(guān)的文件。序號(hào)文件名稱文件編號(hào)發(fā)表日期出版單位或作者GB∕T25070-2019信息安全技術(shù)網(wǎng)絡(luò)安全等級(jí)保護(hù)安全設(shè)計(jì)技術(shù)要求GB∕T22239-2019信息安全技術(shù)網(wǎng)絡(luò)安全等級(jí)保護(hù)基本要求GB∕T22239-20192019/5/10國家標(biāo)準(zhǔn)化管理委員會(huì)項(xiàng)目全過程技術(shù)管理規(guī)范DTXY_P_PI000產(chǎn)品集成過程DTXY_P_TS000軟件設(shè)計(jì)編碼過程JReap平臺(tái)開發(fā)規(guī)范Sonar代碼檢查流程及操作指南UI設(shè)計(jì)規(guī)范DTXY_RDM003客戶需求說明書DTXY_RDM004軟件規(guī)格說明書DTXY_RDM005需求跟蹤矩陣表發(fā)電廠監(jiān)控系統(tǒng)信息安全防護(hù)技術(shù)規(guī)范概述設(shè)計(jì)原則注:也即重要技術(shù)特性,這部分論述整個(gè)系統(tǒng),尤其是架構(gòu)設(shè)計(jì)的重要原則,包括規(guī)則約束、設(shè)計(jì)實(shí)現(xiàn)、范圍界定等方面,以及各類中間件的使用、工作站MMI的設(shè)計(jì)原則。在隨后的文檔部分,須解釋是怎么來實(shí)現(xiàn)這些設(shè)計(jì)原則的。例如:根據(jù)系統(tǒng)的建設(shè)目標(biāo)和實(shí)際需求,堅(jiān)持“需求為導(dǎo)向、應(yīng)用促發(fā)展”的指導(dǎo)思想,遵循以下原則進(jìn)行系統(tǒng)總體設(shè)計(jì)。模塊化系統(tǒng)應(yīng)依據(jù)智慧電廠總體技術(shù)架構(gòu)設(shè)計(jì),模塊化實(shí)現(xiàn),并與當(dāng)前智慧電廠一體化系統(tǒng)相集成2)安全性系統(tǒng)應(yīng)遵循《信息安全技術(shù)網(wǎng)絡(luò)安全等級(jí)保護(hù)基本要求》,按照三級(jí)要求進(jìn)行設(shè)計(jì),依據(jù)XX中XXX條款,XXX。。。3)可擴(kuò)展系統(tǒng)采用可擴(kuò)展的技術(shù)體系架構(gòu),以適應(yīng)信息化建設(shè)和應(yīng)用系統(tǒng)快速發(fā)展的要求。當(dāng)參與交換的用戶數(shù)目增加、業(yè)務(wù)范圍拓展以及業(yè)務(wù)流程調(diào)整時(shí),平臺(tái)應(yīng)有良好的擴(kuò)展機(jī)制和靈活的調(diào)整方案適應(yīng)其變化,不需要修改程序代碼。同時(shí),隨著系統(tǒng)規(guī)模的不斷擴(kuò)大,當(dāng)硬件系統(tǒng)需要時(shí),數(shù)據(jù)系統(tǒng)能夠平滑過渡。此外,可擴(kuò)展性還表現(xiàn)在平臺(tái)能通過簡(jiǎn)單開發(fā),實(shí)現(xiàn)與其它數(shù)據(jù)系統(tǒng)的互聯(lián)互通。4)可管理系統(tǒng)應(yīng)具有良好的可管理性,提供管理工具幫助管理人員系統(tǒng)全面地監(jiān)控、管理和配置,并為系統(tǒng)故障的判斷、排錯(cuò)和分析提供支撐,可對(duì)信息交換流程進(jìn)行簡(jiǎn)易、靈活地定制和調(diào)整,同時(shí)對(duì)系統(tǒng)運(yùn)行情況能夠?qū)崟r(shí)的統(tǒng)計(jì)分析、報(bào)表展示。5)技術(shù)選型原則自主可控:系統(tǒng)軟、硬件及相關(guān)中間件應(yīng)采用自主可控設(shè)計(jì),符合XXX集團(tuán)的《XXXX》要求。6)松耦合性首先,這種松耦合的關(guān)系體現(xiàn)在數(shù)據(jù)系統(tǒng)與各應(yīng)用系統(tǒng)之間。數(shù)據(jù)系統(tǒng)為應(yīng)用系統(tǒng)服務(wù),并獨(dú)立于各應(yīng)用系統(tǒng),數(shù)據(jù)系統(tǒng)與各應(yīng)用系統(tǒng)應(yīng)保持相互隔離和透明,在業(yè)務(wù)邏輯上具有明確的界線。數(shù)據(jù)系統(tǒng)的改變對(duì)各應(yīng)用系統(tǒng)沒有影響,擴(kuò)充增加應(yīng)用系統(tǒng)也不影響數(shù)據(jù)系統(tǒng)的基礎(chǔ)架構(gòu)。其次,通過系統(tǒng)連接起來的多個(gè)應(yīng)用系統(tǒng)之間是一種松耦合的關(guān)系,其中任何系統(tǒng)出現(xiàn)故障,都不會(huì)對(duì)其他系統(tǒng)造成直接的危害和影響。交換參與各方的局部軟硬件平臺(tái)、數(shù)據(jù)結(jié)構(gòu)發(fā)生變化時(shí),應(yīng)只需調(diào)整此局部與交換中心間的配置,不能影響其余參與方的連接與交換。7)高可靠性系統(tǒng)應(yīng)具有良好的可靠性,通過簡(jiǎn)單配置能實(shí)現(xiàn)熱備份、負(fù)載均衡,任何一臺(tái)機(jī)器發(fā)生故障均不影響整個(gè)數(shù)據(jù)系統(tǒng)的正常工作和運(yùn)行,在交換任務(wù)繁忙時(shí)可將任務(wù)自動(dòng)分配到其它服務(wù)器上運(yùn)行。當(dāng)前置交換庫出現(xiàn)數(shù)據(jù)錯(cuò)誤時(shí),能夠及時(shí)發(fā)現(xiàn)、規(guī)避和處理。支持?jǐn)?shù)據(jù)的自動(dòng)備份,在任何一臺(tái)服務(wù)器發(fā)生異常的情況下,保證數(shù)據(jù)的可訪問性;支持容錯(cuò),硬盤數(shù)據(jù)錯(cuò)誤、心跳檢測(cè)和重新復(fù)制;支持?jǐn)?shù)據(jù)完整性,支持元數(shù)據(jù)的恢復(fù);支持?jǐn)?shù)據(jù)存儲(chǔ)節(jié)點(diǎn)間的數(shù)據(jù)均衡,按需自動(dòng)遷移;支持?jǐn)?shù)據(jù)自動(dòng)切片,自動(dòng)分布到相應(yīng)節(jié)點(diǎn)庫。8)彈性部署支持系統(tǒng)的橫向擴(kuò)展;支持按需增加節(jié)點(diǎn)而無須改變?cè)邢到y(tǒng),并隨著新成員的增加,自動(dòng)增強(qiáng)整個(gè)系統(tǒng)的能力;分布式設(shè)計(jì),節(jié)點(diǎn)的增加或去除不會(huì)影響整體的系統(tǒng)運(yùn)行及導(dǎo)致數(shù)據(jù)的丟失;支持節(jié)點(diǎn)任務(wù)無耦合,節(jié)點(diǎn)宕機(jī)不影響任務(wù)。9)高性能支持分布式并行計(jì)算框架,框架跨系統(tǒng)橫向擴(kuò)展;支持任務(wù)跨系統(tǒng)的分配,管理與監(jiān)控;支持海量數(shù)據(jù)的并行計(jì)算數(shù)據(jù)處理。假定和約束注:描述系統(tǒng)設(shè)計(jì)中最主要的限制條件,這些是由政策、客戶等因素強(qiáng)制要求并在需求規(guī)格說明書中寫明的,影響實(shí)現(xiàn)的因素。本章將簡(jiǎn)述設(shè)計(jì)的系統(tǒng)是如何適應(yīng)這些約束的,部分具體設(shè)計(jì)將在非功能性約束設(shè)計(jì)等章節(jié)說明。假定中,描述本系統(tǒng)之外的環(huán)境中,將嚴(yán)重影響本系統(tǒng)設(shè)計(jì)及運(yùn)行的重要條件。如果本系統(tǒng)跟其他外部系統(tǒng)交互或依賴其他外部系統(tǒng)提供一些功能輔助,這時(shí)要求描述與本系統(tǒng)有交互的軟件類型,以及導(dǎo)致的約束。例如,系統(tǒng)將如何適應(yīng)第三方的運(yùn)維自動(dòng)化系統(tǒng)的可監(jiān)控性要求。若實(shí)現(xiàn)的語言或平臺(tái)對(duì)系統(tǒng)有約束,有特別要求的,同樣需給予說明。例如需支持安全可信操作系統(tǒng),例如必須支持多種語言的API等,需要說明約束,并在后期的如非功能性設(shè)計(jì)等章節(jié),對(duì)約束的適應(yīng)性進(jìn)行說明。對(duì)因選擇的具體設(shè)計(jì)實(shí)現(xiàn)而導(dǎo)致對(duì)系統(tǒng)的約束,簡(jiǎn)要描述設(shè)計(jì)思路,為什么要采取這樣的設(shè)計(jì)等。例如受用戶方提供的報(bào)表系統(tǒng)的約束,系統(tǒng)將受何約束...例: 1.本系統(tǒng)假定調(diào)控中心數(shù)據(jù)中臺(tái)能夠以約定的協(xié)議提供AGC業(yè)務(wù)數(shù)據(jù);2.系統(tǒng)要求基于SG-UAP平臺(tái)進(jìn)行開發(fā),3.應(yīng)用需使用容器化部署??傮w設(shè)計(jì)技術(shù)路線注:說明采用什么樣的架構(gòu)、平臺(tái)、開發(fā)工具、存儲(chǔ)、中間件、系統(tǒng)軟件、甚至語言等的選型及其原因、用到的主要技術(shù)點(diǎn)等。同時(shí)也將表述因該技術(shù)設(shè)計(jì)而導(dǎo)致系統(tǒng)具備的技術(shù)特點(diǎn)。示例:以先進(jìn)的開源數(shù)據(jù)庫MySQL作為數(shù)據(jù)存儲(chǔ)MySQL軟件采用了雙授權(quán)政策,它分為社區(qū)版和商業(yè)版,由于其體積小、速度快、總體擁有成本低并且開放源碼的特點(diǎn)。使用HTML5技術(shù),詮釋web2.0的技術(shù)內(nèi)涵HTML5技術(shù)具有跨平臺(tái)、適配多終端、提高了用戶體驗(yàn)、加強(qiáng)了視覺感受、發(fā)展比較平穩(wěn)等多重特點(diǎn)。GIS技術(shù)、空間數(shù)據(jù)庫技術(shù)與Internet技術(shù)結(jié)合GIS技術(shù)與Web技術(shù)的結(jié)合形成的WebGIS技術(shù),使地圖數(shù)據(jù)在網(wǎng)上發(fā)布成為可能,用戶可以通過瀏覽器進(jìn)行地理信息的各種操作。且用戶無法直接存取地圖資源庫,從而真正保證了原始地圖數(shù)據(jù)的應(yīng)用安全。將數(shù)據(jù)庫進(jìn)行讀寫分離,建立獨(dú)立的業(yè)務(wù)庫,統(tǒng)計(jì)庫和存檔庫為了確保數(shù)據(jù)庫產(chǎn)品的穩(wěn)定性,數(shù)據(jù)庫擁有雙機(jī)熱備功能。第一臺(tái)數(shù)據(jù)庫服務(wù)器,是對(duì)外提供增刪改業(yè)務(wù)的生產(chǎn)服務(wù)器;第二臺(tái)數(shù)據(jù)庫服務(wù)器,主要進(jìn)行讀的操作??傮w架構(gòu)注:系統(tǒng)總體的業(yè)務(wù)及技術(shù)架構(gòu)及其簡(jiǎn)要說明。從系統(tǒng)應(yīng)用的所有涉眾層面的宏觀視角。例如:應(yīng)用架構(gòu)與數(shù)字化項(xiàng)目應(yīng)用架構(gòu)關(guān)系描述本項(xiàng)目所屬的平臺(tái)及系統(tǒng),圖片和文字方式描述本系統(tǒng)在數(shù)字化項(xiàng)目應(yīng)用架構(gòu)的對(duì)應(yīng)關(guān)系,示例:應(yīng)用架構(gòu)圖注:應(yīng)用架構(gòu)描述了業(yè)務(wù)應(yīng)用劃分、應(yīng)用組件構(gòu)成、業(yè)務(wù)應(yīng)用與業(yè)務(wù)能力、業(yè)務(wù)流程之間的關(guān)系,業(yè)務(wù)應(yīng)用間及業(yè)務(wù)應(yīng)用內(nèi)部各部分間的集成關(guān)系以及業(yè)務(wù)應(yīng)用部署模式,是一種結(jié)構(gòu)化的表達(dá)。如:描述系統(tǒng)的分層應(yīng)用,與其他系統(tǒng)的接口關(guān)系,面向的內(nèi)外部用戶等,可以采用圖形表示(對(duì)存在有使用層級(jí)(如果系統(tǒng)功能、基礎(chǔ)功能、高級(jí)應(yīng)用等)、不同應(yīng)用終端(如PC、移動(dòng)應(yīng)用、大屏等)、不同使用角色要進(jìn)行體現(xiàn))。例如:業(yè)務(wù)模塊清單注:業(yè)務(wù)應(yīng)用模塊定義:若采用微服務(wù)思想,則拆分出來每個(gè)微服務(wù)列一行,若非微服務(wù)模式的應(yīng)用或服務(wù)則可按獨(dú)立進(jìn)程拆分。模塊標(biāo)識(shí)編碼全公司唯一編號(hào),模塊標(biāo)識(shí)=應(yīng)用平臺(tái)編碼+業(yè)務(wù)線編碼+“-”+產(chǎn)品簡(jiǎn)稱(英文)+“-”+模塊簡(jiǎn)稱(英文),如pas-example-equip,p即“發(fā)電行業(yè)智能管控平臺(tái)”應(yīng)用平臺(tái),as即“安全生產(chǎn)業(yè)務(wù)線”,example即某個(gè)產(chǎn)品,equip即“設(shè)備管理”模塊。對(duì)于非復(fù)用的情況,“所屬應(yīng)用平臺(tái)、所屬業(yè)務(wù)線、所屬部門、責(zé)任人、來源”可不填寫。下表僅列出一級(jí)模塊,而非功能點(diǎn)。序號(hào)模塊標(biāo)識(shí)模塊名稱類型版本號(hào)所屬應(yīng)用平臺(tái)所屬業(yè)務(wù)線所屬部門責(zé)任人來源說明新增/使用/二次開發(fā)/外購產(chǎn)品庫/xx客戶單位開發(fā)庫1pas-example-equip設(shè)備管理二次開發(fā)v19.1.1發(fā)電行業(yè)智能管控平臺(tái)安全生產(chǎn)業(yè)務(wù)線xx客戶單位開發(fā)庫2pas-example-operation運(yùn)行管理使用v18.2.0發(fā)電行業(yè)智能管控平臺(tái)安全生產(chǎn)業(yè)務(wù)線產(chǎn)品庫34總體數(shù)據(jù)流圖注:對(duì)系統(tǒng)數(shù)據(jù)的流程進(jìn)行描述,采用數(shù)據(jù)流程圖的方式,至少要有系統(tǒng)的頂級(jí)數(shù)據(jù)流圖。例如:網(wǎng)絡(luò)架構(gòu)注:該章節(jié)為可選,說明系統(tǒng)軟硬件部署或網(wǎng)絡(luò)拓?fù)浣Y(jié)構(gòu),一般用圖形表示。例如:復(fù)用策略注:說明系統(tǒng)將復(fù)用哪些未在業(yè)務(wù)模塊清單中列出的,現(xiàn)有可用的組件、代碼類等。(可選)序號(hào)組件ID及名稱組件功能功能需求復(fù)用程度備注公共組件設(shè)計(jì)注:說明系統(tǒng)將包含或提煉哪些公共組件,并描述功能和作用。序號(hào)組件ID及名稱功能或處理概述備注命名及目錄設(shè)計(jì)前臺(tái)工程注:命名規(guī)則依據(jù)《命名規(guī)范》、《Java編碼規(guī)范》以及《產(chǎn)品編碼規(guī)范》和《Javascript編碼規(guī)范》制訂。前臺(tái)工程包括WEB、WEB的API、移動(dòng)應(yīng)用、大屏等項(xiàng)目。示例:前臺(tái)業(yè)務(wù)目錄,推薦的結(jié)構(gòu),由JREAP技術(shù)規(guī)范確定。序號(hào)模塊英文名相對(duì)路徑備注后臺(tái)服務(wù)《todo:示例》序號(hào)模塊英文名相對(duì)路徑備注通用要求1、下拉選擇框除了各子項(xiàng)內(nèi)容外,還必須有“請(qǐng)選擇”子項(xiàng),代表全部。

2、頁面的表格中均要有分頁顯示控件,分別有首頁、下一頁、上一頁、末頁,每頁顯示X條數(shù)據(jù)。X默認(rèn)為20,可設(shè)置50、100。放置在表格的右下角。

3、存在多選的表格或有特殊要求的表格不能分頁。

4、在做刪除操作前,必須彈出詢問窗口,在用戶確認(rèn)后,才能執(zhí)行刪除命令。且要彈出數(shù)據(jù)是否刪除成功的提示。

5、所有前臺(tái)頁面的輸入文本框必須在前臺(tái)頁面做長度驗(yàn)證、類型驗(yàn)證。有特定含義的字段還必須做特定的驗(yàn)證(如身份證、車牌號(hào)碼)。

6、新增數(shù)據(jù)類按鈕放置在頁面的右上角(數(shù)據(jù)表格之外),對(duì)已有數(shù)據(jù)進(jìn)行操作的按鈕放置在表格中。

7、所有的數(shù)據(jù)傳輸都要按照HTTPS的方式進(jìn)行。

8、點(diǎn)擊表格中的表頭字段,可按該字段進(jìn)行排序。

9、頁面原型作為頁面布局的參考,實(shí)際開發(fā)中以頁面的美觀、整潔為目標(biāo)進(jìn)行控件布局。

10、界面表格中第一列為序號(hào)列,均為系統(tǒng)自動(dòng)生成,翻頁時(shí),序號(hào)要自動(dòng)變化。

11、對(duì)于文本框均要做前導(dǎo)和后續(xù)空格的排除操作。

12、頁面中有開始和結(jié)束時(shí)間段的,都按照大于等于開始時(shí)間,小于等于結(jié)束時(shí)間的邏輯進(jìn)行查詢。如,需要查詢6月1、2、3號(hào)三天的數(shù)據(jù),則開始時(shí)間為6月1日,結(jié)束時(shí)間為6月3日。業(yè)務(wù)應(yīng)用模塊設(shè)計(jì)注:對(duì)于功能點(diǎn)較多,且歸屬關(guān)系相對(duì)固定的,可按系統(tǒng)、模塊、功能點(diǎn)三級(jí)進(jìn)行描述。對(duì)于功能點(diǎn)較少的,可直接按系統(tǒng)、功能兩級(jí)進(jìn)行描述。以下按兩級(jí)結(jié)構(gòu)示例。對(duì)于較復(fù)雜的功能點(diǎn),可再細(xì)分到第三級(jí)。對(duì)于簡(jiǎn)單的功能點(diǎn),則可聚合成按功能進(jìn)行設(shè)計(jì)。原則上功能清單應(yīng)與需求矩陣中的設(shè)計(jì)一列相對(duì)應(yīng)。設(shè)備管理模塊(pas-example-equip)注:對(duì)模塊的描述、模塊級(jí)的處理流程或數(shù)據(jù)流程進(jìn)行描述(可選)。功能清單功能標(biāo)識(shí)功能名稱功能描述類型AD01.01視頻遠(yuǎn)程集中監(jiān)視復(fù)用AD01.02設(shè)備缺陷新增注:如果還有子功能,可在本表中增加列予以擴(kuò)展,如AD01.01.01,并在下文中的功能章節(jié)增加相應(yīng)層級(jí)。模塊目錄結(jié)構(gòu)模塊目錄位于項(xiàng)目目錄的modules中,允許使用本地的配置及l(fā)ib。即目錄位置為:/dtxytech/projectname/modules/modulename。模塊輸出的可執(zhí)行文件位于[modulename]根目錄下。模塊子目錄結(jié)構(gòu)為:[modulename]/lib,[modulename]/config,[modulename]/resources各類型項(xiàng)目目錄結(jié)構(gòu)示例如下(實(shí)際編寫中可根據(jù)項(xiàng)目類型任選):前端模塊目錄結(jié)構(gòu)后端模塊代碼目錄結(jié)構(gòu)示例:目錄:業(yè)務(wù)通用組件、服務(wù)消費(fèi)、服務(wù)提供的文件夾由平臺(tái)自動(dòng)生成。如:業(yè)務(wù)通用組件/java。組件包命名:業(yè)務(wù)通用組件mons服務(wù)消費(fèi)com.dtxytech.pas.equip.consumer服務(wù)提供vider.impl注1:業(yè)務(wù)通用組件、服務(wù)消費(fèi)、服務(wù)提供這種組件的包只能用模塊標(biāo)識(shí)命名。注2:pas-example-equip為模塊標(biāo)識(shí)即設(shè)備管理全公司唯一。注3:因java包命名中不能有中劃線符號(hào),故pas-example-equip在命名包時(shí)轉(zhuǎn)化為pas.equip。后端模塊接口工程代碼目錄結(jié)構(gòu)示例:目錄:src/main/java/接口包命名:服務(wù)提供API接口vider數(shù)據(jù)轉(zhuǎn)換對(duì)象com.dtxytech.pas.equip.dto工具類com.dtxytech.pas.equip.util注1:文件夾src位于后端工程的根目錄。本目錄下com.dtxytech.模塊標(biāo)識(shí).provider(服務(wù)提供API接口)、com.dtxytech.模塊標(biāo)識(shí).dto(數(shù)據(jù)轉(zhuǎn)換對(duì)象)、com.dtxytech.模塊標(biāo)識(shí).util(工具類)三個(gè)包是每個(gè)模塊必須包含的,原則上一個(gè)模塊的所有功能的對(duì)外服務(wù)統(tǒng)一通過此工程提供接口API。注2:pas-example-equip為模塊標(biāo)識(shí)即設(shè)備管理全公司唯一。注3:因java包命名中不能有中劃線符號(hào),故pas-example-equip在命名包時(shí)轉(zhuǎn)化為pas.equip。注4:如項(xiàng)目需要添加功能級(jí)接口包,如設(shè)備臺(tái)賬功能服務(wù)接口,接口命名規(guī)則為:com.dtxytech.pas.equip.equipledger.provider),注意提供功能級(jí)的接口包也須包含remote、dto、util包,并且位于src/main/java/目錄下。AD01.01視頻遠(yuǎn)程集中監(jiān)視注:對(duì)于APP類型的應(yīng)用,可以“參見XX原型.rp文件,XX模塊XX功能”而略過本章下各節(jié)。但原型中必須說明:數(shù)據(jù)源、主要處理過程、業(yè)務(wù)規(guī)則、約束、異常處理等要素。名稱視頻遠(yuǎn)程集中監(jiān)視頁面功能點(diǎn)預(yù)覽、云臺(tái)控制、回放功能描述注:系統(tǒng)功能的整體描述。復(fù)雜度用戶交互注:若為后端服務(wù),直接標(biāo)識(shí)為后臺(tái)服務(wù);若為終端執(zhí)行,列出終端交互方式及反饋內(nèi)容類型及示例;若為接口服務(wù),標(biāo)為“API服務(wù),采用何種規(guī)約”左邊窗口調(diào)用【queryCameraByPerson】接口獲取當(dāng)前用戶具有權(quán)限的所有攝像頭并以樹結(jié)構(gòu)顯示,右邊顯示視頻窗口及云臺(tái)控制按鈕;窗口數(shù)默認(rèn)顯示為1X1;碼流默認(rèn)顯示為主碼流;數(shù)據(jù)源*注:此處應(yīng)根據(jù)需要的:資源文件、配置信息、關(guān)系數(shù)據(jù)庫、時(shí)序數(shù)據(jù)庫等說明依賴的相對(duì)靜態(tài)的資源。例如關(guān)系數(shù)據(jù)庫,說明,依賴哪些表的哪些域。時(shí)序庫,可說明依賴哪些類型或者具體哪些標(biāo)簽。前置條件頁面加載之前驗(yàn)證是否已經(jīng)安裝對(duì)應(yīng)版本插件;默認(rèn)顯示(用于前端型項(xiàng)目)要求:提出缺省的數(shù)據(jù)獲取及展示要求;約束*1、根據(jù)角色權(quán)限顯示攝像頭的實(shí)時(shí)視頻及云臺(tái)控制按鈕。業(yè)務(wù)規(guī)則異常處理*沒有安裝插件或插件版本不對(duì),彈出提示安裝或下載相應(yīng)版本插件,并提供下載路徑;預(yù)覽視頻失敗時(shí)彈出“登錄失敗”或“請(qǐng)檢查網(wǎng)絡(luò)是否連通”。補(bǔ)充說明點(diǎn)擊窗口數(shù)以設(shè)置視頻窗口數(shù);數(shù)據(jù)流程圖相應(yīng)的業(yè)務(wù)流程圖應(yīng)在需求規(guī)格說明中體現(xiàn)。本處繪制最底層的數(shù)據(jù)流程圖,沒有的可以標(biāo)“無”處理過程處理的流程(數(shù)據(jù)流程)、處理的過程(分步驟實(shí)現(xiàn)的過程)注:可采用文字描述實(shí)現(xiàn)的過程、對(duì)流程化的采用活動(dòng)圖方式對(duì)業(yè)務(wù)處理的過程進(jìn)行說明(后臺(tái)服務(wù))示例:主處理過程:下面對(duì)各模塊(以數(shù)字表示)進(jìn)行功能說明:網(wǎng)絡(luò)數(shù)據(jù)接收接受由客戶機(jī)程序經(jīng)網(wǎng)絡(luò)傳送到客戶機(jī)的數(shù)據(jù)包,它是程序與網(wǎng)絡(luò)的接口。解開數(shù)據(jù)解開/解密打包的數(shù)據(jù),并將恢復(fù)的數(shù)據(jù)格式化送入3。判斷操作由數(shù)據(jù)判斷需要做什么數(shù)據(jù)庫操作,它是一事務(wù)處理中心,若為定票操作則將數(shù)據(jù)送4,若為領(lǐng)票操作則將數(shù)據(jù)送15。準(zhǔn)備數(shù)據(jù)庫查詢語句由定票數(shù)據(jù)準(zhǔn)備訪問SQLSERVER數(shù)據(jù)庫所需的SQL語句,送入5。數(shù)據(jù)庫操作運(yùn)行SQL語句,查詢并存入數(shù)據(jù)庫,獲得相應(yīng)的定票數(shù)據(jù),將數(shù)據(jù)送入6。它需包括初步對(duì)查詢的判斷。它必須為乘客安排可抵達(dá)目的地的有座位的航班。判斷查詢是否成功利用查詢所得的數(shù)據(jù)判斷定票是否成功,它是一事務(wù)處理中心,若為定票操作成功則將數(shù)據(jù)送7,若不成功則將數(shù)據(jù)送8。準(zhǔn)備回送數(shù)據(jù)準(zhǔn)備定票成功后需回送客戶機(jī)程序的數(shù)據(jù),送16。確定原因由查詢數(shù)據(jù)判斷定票不成功的原因,送9。準(zhǔn)備回送數(shù)據(jù)根據(jù)不成功的原因,準(zhǔn)備需送回客戶機(jī)程序的數(shù)據(jù),送入16。準(zhǔn)備數(shù)據(jù)庫查詢語句由領(lǐng)票數(shù)據(jù)準(zhǔn)備訪問SQLSERVER數(shù)據(jù)庫所需的SQL語句,送入11。數(shù)據(jù)庫操作運(yùn)行SQL語句,查詢并存入數(shù)據(jù)庫獲得相應(yīng)的領(lǐng)票數(shù)據(jù),將數(shù)據(jù)送入6。它需包括初步對(duì)查詢的判斷。判斷查詢是否成功利用查詢所得的數(shù)據(jù)判斷領(lǐng)票是否成功,它是一事務(wù)處理中心,若為領(lǐng)票操作得到確認(rèn)則將數(shù)據(jù)送11,若不成功則將數(shù)據(jù)送8。準(zhǔn)備回送數(shù)據(jù)準(zhǔn)備領(lǐng)票確認(rèn)后需回送客戶機(jī)程序的數(shù)據(jù),送16。確定原因由查詢數(shù)據(jù)判斷領(lǐng)票不能確認(rèn)的原因,送15。準(zhǔn)備回送數(shù)據(jù)根據(jù)不成功的原因,準(zhǔn)備需送回客戶機(jī)程序的數(shù)據(jù),送入16。準(zhǔn)備網(wǎng)絡(luò)數(shù)據(jù)包將數(shù)據(jù)準(zhǔn)備/加密成網(wǎng)絡(luò)傳輸數(shù)據(jù)包。網(wǎng)絡(luò)數(shù)據(jù)發(fā)送將數(shù)據(jù)包經(jīng)網(wǎng)絡(luò)發(fā)送到服務(wù)器程序,它是程序與網(wǎng)絡(luò)的接口。以上顯示的各模塊數(shù)字相同的為同一模塊;由于事務(wù)流處理上的便利,將有些功能模塊,拆分到各事務(wù)流中。分支處理過程:功能目錄結(jié)構(gòu)注:可能為以下任一種類型的功能,依據(jù)功能類型,說明其源代碼及輸出的組織方式。若功能僅為模塊目錄下的一個(gè)源文件,或者是僅為模塊下的一個(gè)可執(zhí)行文件的輸出,說明其位于模塊目錄下,說明其代碼或者可執(zhí)行文件名稱即可。前端功能目錄結(jié)構(gòu)示例:src/webcontent/web/pas-example-equip/equipledger/注1:文件夾src位于前端工程的根目錄,功能文件夾(equipledger)位于模塊文件夾(pas-example-equip)的下一層級(jí),如功能下有子功能,可以擴(kuò)展子功能文件夾。注2:pas-example-equip為模塊標(biāo)識(shí)即設(shè)備管理全公司唯一、equipledger為設(shè)備臺(tái)賬功能起的功能名,建議用英文命名。后端功能目錄結(jié)構(gòu)示例:equipledger/注1:具體功能的服務(wù)及實(shí)現(xiàn)文件夾,如設(shè)備管理的文件夾equipledger位于后端工程的根目錄。注3:equipledger為設(shè)備臺(tái)賬功能起的功能名,建議用英文命名。界面設(shè)計(jì)注:若無,則可略過。AD01.02設(shè)備缺陷編寫要求與”4.1.3”章節(jié)相同……….。模塊間接口設(shè)計(jì)清單序號(hào)接口名稱提供者(模塊名)使用者(模塊名)接口簡(jiǎn)述類型原有/新增/不建議使用1接口1設(shè)備管理新增2接口2設(shè)備管理原有3接口3運(yùn)行管理設(shè)備管理原有4接口4運(yùn)行管理設(shè)備管理新增注:概要設(shè)計(jì)階段,本表須明確接口的“類型”,即“原有/新增/不建議使用”具體接口設(shè)計(jì)參看項(xiàng)目的《接口設(shè)計(jì)表》外部系統(tǒng)接口設(shè)計(jì)清單序號(hào)外部系統(tǒng)名稱接口名稱接口類型接口通訊方法/接口協(xié)議接口描述具體接口設(shè)計(jì)參看項(xiàng)目的《接口設(shè)計(jì)表》公共數(shù)據(jù)項(xiàng)清單注:見《公共數(shù)據(jù)項(xiàng)清單》附件中說明數(shù)據(jù)庫物理模型注:描述數(shù)據(jù)庫物理模型設(shè)計(jì)圖,可參見數(shù)據(jù)庫設(shè)計(jì)文件;運(yùn)行管理(pas-example-operation)編寫要求與”4.1”章節(jié)相同。系統(tǒng)安全性設(shè)計(jì)注:對(duì)系統(tǒng)涉及的各安全要求的實(shí)現(xiàn)方法進(jìn)行具體描述?!秚odo:示例》數(shù)據(jù)安全注:包括數(shù)據(jù)訪問,數(shù)據(jù)存儲(chǔ),數(shù)據(jù)傳輸過程安全性的保證方法,例如對(duì)關(guān)系數(shù)據(jù)訪問采用證書訪問或者本地協(xié)議訪問等。數(shù)據(jù)安全屬性分析數(shù)據(jù)類別使用者說明機(jī)密性賦值完整性賦值可用性賦值數(shù)據(jù)流轉(zhuǎn)分析數(shù)據(jù)流轉(zhuǎn)過程簡(jiǎn)要說明描述數(shù)據(jù)的來源,由誰使用,使用過程中途徑哪些系統(tǒng)環(huán)節(jié)是否在用戶端呈現(xiàn)是/否是否用戶端保存是/否是否在網(wǎng)絡(luò)中傳輸是/否是否經(jīng)過可信與不可信邊界傳輸是/否是否通過無線網(wǎng)絡(luò)傳輸是/否是否在應(yīng)用系統(tǒng)間傳輸是/否是否保存在應(yīng)用系統(tǒng)中是/否應(yīng)用安全注:要求雙因子認(rèn)證,例如限制用戶對(duì)服務(wù)進(jìn)程的啟停,例如對(duì)配置文件存儲(chǔ)的安全性如何保證等。控制點(diǎn)防護(hù)策略設(shè)計(jì)身份認(rèn)證設(shè)置密碼的存儲(chǔ)和傳輸安全;保護(hù)身份驗(yàn)證Cookie;同一用戶同時(shí)只允許登錄一個(gè);授權(quán)設(shè)計(jì)資源訪問控制方案,驗(yàn)證用戶訪問權(quán)限;限制用戶對(duì)系統(tǒng)級(jí)資源的訪問;設(shè)計(jì)統(tǒng)一的訪問控制機(jī)制;輸入輸出驗(yàn)證設(shè)計(jì)驗(yàn)證所有來源不在可信范圍之內(nèi)的輸入數(shù)據(jù);應(yīng)在服務(wù)器端和客戶端都應(yīng)進(jìn)行輸入驗(yàn)證;應(yīng)對(duì)輸入內(nèi)容進(jìn)行規(guī)范化處理后再進(jìn)行驗(yàn)證,如文件路徑、URL地址等,需要規(guī)范化為標(biāo)準(zhǔn)的格式后再進(jìn)行驗(yàn)證;應(yīng)當(dāng)從服務(wù)器端提取關(guān)鍵參數(shù),禁止從客戶端輸入;配置管理確保配置存儲(chǔ)的安全;應(yīng)使用最少特權(quán)進(jìn)程和服務(wù)帳戶;應(yīng)避免應(yīng)用程序調(diào)用支撐系統(tǒng)資源;單獨(dú)分配管理特權(quán);會(huì)話管理設(shè)計(jì)登錄成功使用新的會(huì)話;設(shè)計(jì)會(huì)話數(shù)據(jù)的存儲(chǔ)安全;設(shè)計(jì)會(huì)話數(shù)據(jù)的傳輸安全;設(shè)計(jì)會(huì)話的安全終止;設(shè)計(jì)合理的會(huì)話存活時(shí)間;加密技術(shù)不使用自創(chuàng)加密方法;確保加密密鑰的安全;參數(shù)操作不要信任HTTP頭信息;確保用戶沒有繞過檢查;應(yīng)驗(yàn)證從客戶端發(fā)送的所有數(shù)據(jù);異常管理使用結(jié)構(gòu)化異常處理機(jī)制;使用通用錯(cuò)誤信息;程序發(fā)生異常時(shí),應(yīng)終止當(dāng)前業(yè)務(wù),并對(duì)當(dāng)前業(yè)務(wù)進(jìn)行回滾操作,保證業(yè)務(wù)的完整性和有效性,必要時(shí)可以注銷當(dāng)前用戶會(huì)話;程序發(fā)生異常時(shí),應(yīng)在日志中記錄詳細(xì)的錯(cuò)誤消息;審核和日志日志記錄事件應(yīng)至少包含以下事件:審計(jì)功能的啟動(dòng)和關(guān)閉;應(yīng)用系統(tǒng)的啟動(dòng)和停止;配置變化;訪問控制信息;用戶對(duì)數(shù)據(jù)的異常操作事件服務(wù)器安全注:例如包括如何具體為應(yīng)用創(chuàng)建哪一單獨(dú)用戶,對(duì)其進(jìn)行資源配額管理,限制其在哪些目錄的訪問權(quán)限等。系統(tǒng)主機(jī)描述描述本項(xiàng)目中所使用主機(jī)的功能。主機(jī)安全設(shè)計(jì)根據(jù)等級(jí)保護(hù)和智能電網(wǎng)安全防護(hù)方案的要求從主機(jī)訪問控制、主機(jī)安全加固、主機(jī)入侵檢測(cè)、主機(jī)內(nèi)容安全、病毒防范、主機(jī)身份鑒別、數(shù)據(jù)加密、主機(jī)監(jiān)控審計(jì)、備份恢復(fù)、資源控制、剩余信息保護(hù)這幾個(gè)方面給出主機(jī)安全詳細(xì)

溫馨提示

  • 1. 本站所有資源如無特殊說明,都需要本地電腦安裝OFFICE2007和PDF閱讀器。圖紙軟件為CAD,CAXA,PROE,UG,SolidWorks等.壓縮文件請(qǐng)下載最新的WinRAR軟件解壓。
  • 2. 本站的文檔不包含任何第三方提供的附件圖紙等,如果需要附件,請(qǐng)聯(lián)系上傳者。文件的所有權(quán)益歸上傳用戶所有。
  • 3. 本站RAR壓縮包中若帶圖紙,網(wǎng)頁內(nèi)容里面會(huì)有圖紙預(yù)覽,若沒有圖紙預(yù)覽就沒有圖紙。
  • 4. 未經(jīng)權(quán)益所有人同意不得將文件中的內(nèi)容挪作商業(yè)或盈利用途。
  • 5. 人人文庫網(wǎng)僅提供信息存儲(chǔ)空間,僅對(duì)用戶上傳內(nèi)容的表現(xiàn)方式做保護(hù)處理,對(duì)用戶上傳分享的文檔內(nèi)容本身不做任何修改或編輯,并不能對(duì)任何下載內(nèi)容負(fù)責(zé)。
  • 6. 下載文件中如有侵權(quán)或不適當(dāng)內(nèi)容,請(qǐng)與我們聯(lián)系,我們立即糾正。
  • 7. 本站不保證下載資源的準(zhǔn)確性、安全性和完整性, 同時(shí)也不承擔(dān)用戶因使用這些下載資源對(duì)自己和他人造成任何形式的傷害或損失。

最新文檔

評(píng)論

0/150

提交評(píng)論