2024软件信息项目概要设计说明书模版

（项目名称）概要设计说明书文件控制☑受控不受控文档编号版本号分册名称第册/共册总页数正文附录编制审批生效日期项目名称概要设计说明书-修改变更记录：更改条款及内容更改人审批人版本更改日期PAGEI目录TOC\o"1-4"\h\z1 引言 41.1 编制目的 41.2 术语表 41.3 参考资料 42 概述 62.1 设计原则 62.2 假定和约束 73 总体设计 93.1 技术路线 93.2 总体架构 93.3 应用架构 113.3.1 与数字化项目应用架构关系 113.3.2 应用架构图 123.3.3 业务模块清单 133.4 总体数据流图 143.5 网络架构 143.6 复用策略 153.7 公共组件设计 153.8 命名及目录设计 163.8.1 前台工程 163.8.2 后台服务 163.9 通用要求 164 业务应用模块设计 184.1 设备管理模块（pas-example-equip） 184.1.1 功能清单 184.1.2 模块目录结构 184.1.3 AD01.01视频远程集中监视 19 数据流程图 20 处理过程 20 功能目录结构 22 界面设计 224.1.4 AD01.02设备缺陷 234.1.5 模块间接口设计清单 234.1.6 外部系统接口设计清单 234.1.7 公共数据项清单 234.1.8 数据库物理模型 234.2 运行管理(pas-example-operation) 245 系统安全性设计 255.1 数据安全 255.2 应用安全 255.3 服务器安全 275.4 网络安全 276 非功能性需求设计 296.1 可管理性设计 296.2 可扩展性设计 296.3 可靠性设计 296.4 性能设计 307 部署设计（生产环境集成） 318 人工处理过程 329 尚未解决的问题 33-PAGE33-编写指南：本模板力图给出系统设计阶段应包括的概要信息，重点在于把需求分析转换为软件系统的实现、描述系统整体情况、模块划分情况、模块之间的关系等等。如果某个章节在项目或当前阶段中无法描述，则可保留其标题，注明“不适用”。如果需要对本模板的个别章节详细描述，也可将其形成单独的文档，成为本文档附件。若文档中的某个章节已经在其他项目文档中加以描述，可保留标题，注明“参见（文档编号）（文档名称）（条款）”。形成正式文档后宜删除斜体字内容。说明书编制要求：这里列出本系统设计说明书编制的经验性要求，须由系统设计人员参照其进行裁剪以确定本次报告编制的相关规定。序号要求1对系统、模块结构图要求采用Visio绘制2各种UML图形要求采用PowerDesigner绘制3数据库结构图要求采用PowerDesigner绘制的概念模型4对数据库结构的描述要求采用图形方式描述，而非采用过多表格5数据库结构图主要包括：表实体、表间关系、主要字段、相关说明四部分6对于平台性产品，要求有系统层次的划分图对应模块目录结构，为方便理解，以下给出目录范例,在项目编制概要设计书时，删除范例就可。（1）前端模块目录结构范例：（2）后端模块目录结构范例：（3）后端模块接口目录结构范例：引言编制目的本说明书全面定义系统的产品特性，是在充分理解需求分析过程输出工件《软件规格说明书》、原型设计等的基础上，为详细设计及编码实现过程确定基础，同时也是与用户交流、交付的工件之一。文档将：1. 确定软件模块组成。2. 确定软件需求的技术解决方案细节。3. 确定各模块的功能和用户接口。本说明书的主要读者为系统用户，软件设计师（详细设计），程序开发员，测试人员，售后技术支持人员等。术语表注：数字项目需统一文档中的术语标准，优先引用《CDT_PM_数字建设项目_名称解释》。1.列出本说明书中用到的专业术语或缩写的解释。2.需求规格说明书中与本说明书相关的术语应引用到下表。例如：序号术语/缩写解释1ATM:AsynchronousTransferMode(异步传输模式)2碳足迹也称碳流，碳足迹，英文为CarbonFootprint，是指企业机构、活动、产品或个人通过交通运输、食品生产和消费以及各类生产过程等引起的温室气体排放的集合。它描述了一个人的能源意识和行为对自然界产生的影响，号召人们从自我做起。已有部分企业开始践行减少碳足迹的环保理念。参考资料注：列出本说明书有关的参考文件，说明能够得到这些文件资料的来源：本文件中各处引用的文件、资料，包括所要用到的软件设计、开发标准；本项目的经核准的计划任务书或合同，上级机关的批文、需求规格说明书；属于本项目的其他已发表的与设计、开发过程相关的文件。序号文件名称文件编号发表日期出版单位或作者GB∕T25070-2019信息安全技术网络安全等级保护安全设计技术要求GB∕T22239-2019信息安全技术网络安全等级保护基本要求GB∕T22239-20192019/5/10国家标准化管理委员会项目全过程技术管理规范DTXY_P_PI000产品集成过程DTXY_P_TS000软件设计编码过程JReap平台开发规范Sonar代码检查流程及操作指南UI设计规范DTXY_RDM003客户需求说明书DTXY_RDM004软件规格说明书DTXY_RDM005需求跟踪矩阵表发电厂监控系统信息安全防护技术规范概述设计原则注：也即重要技术特性，这部分论述整个系统，尤其是架构设计的重要原则，包括规则约束、设计实现、范围界定等方面，以及各类中间件的使用、工作站MMI的设计原则。在随后的文档部分，须解释是怎么来实现这些设计原则的。例如：根据系统的建设目标和实际需求，坚持“需求为导向、应用促发展”的指导思想，遵循以下原则进行系统总体设计。模块化系统应依据智慧电厂总体技术架构设计，模块化实现，并与当前智慧电厂一体化系统相集成2)安全性系统应遵循《信息安全技术网络安全等级保护基本要求》，按照三级要求进行设计，依据XX中XXX条款，XXX。。。3)可扩展系统采用可扩展的技术体系架构，以适应信息化建设和应用系统快速发展的要求。当参与交换的用户数目增加、业务范围拓展以及业务流程调整时，平台应有良好的扩展机制和灵活的调整方案适应其变化，不需要修改程序代码。同时，随着系统规模的不断扩大，当硬件系统需要时，数据系统能够平滑过渡。此外，可扩展性还表现在平台能通过简单开发，实现与其它数据系统的互联互通。4)可管理系统应具有良好的可管理性，提供管理工具帮助管理人员系统全面地监控、管理和配置，并为系统故障的判断、排错和分析提供支撑，可对信息交换流程进行简易、灵活地定制和调整，同时对系统运行情况能够实时的统计分析、报表展示。5)技术选型原则自主可控：系统软、硬件及相关中间件应采用自主可控设计，符合XXX集团的《XXXX》要求。6)松耦合性首先，这种松耦合的关系体现在数据系统与各应用系统之间。数据系统为应用系统服务，并独立于各应用系统，数据系统与各应用系统应保持相互隔离和透明，在业务逻辑上具有明确的界线。数据系统的改变对各应用系统没有影响，扩充增加应用系统也不影响数据系统的基础架构。其次，通过系统连接起来的多个应用系统之间是一种松耦合的关系，其中任何系统出现故障，都不会对其他系统造成直接的危害和影响。交换参与各方的局部软硬件平台、数据结构发生变化时，应只需调整此局部与交换中心间的配置，不能影响其余参与方的连接与交换。7)高可靠性系统应具有良好的可靠性，通过简单配置能实现热备份、负载均衡，任何一台机器发生故障均不影响整个数据系统的正常工作和运行，在交换任务繁忙时可将任务自动分配到其它服务器上运行。当前置交换库出现数据错误时，能够及时发现、规避和处理。支持数据的自动备份，在任何一台服务器发生异常的情况下，保证数据的可访问性；支持容错，硬盘数据错误、心跳检测和重新复制；支持数据完整性，支持元数据的恢复；支持数据存储节点间的数据均衡，按需自动迁移；支持数据自动切片，自动分布到相应节点库。8)弹性部署支持系统的横向扩展；支持按需增加节点而无须改变原有系统，并随着新成员的增加，自动增强整个系统的能力；分布式设计，节点的增加或去除不会影响整体的系统运行及导致数据的丢失；支持节点任务无耦合，节点宕机不影响任务。9)高性能支持分布式并行计算框架，框架跨系统横向扩展；支持任务跨系统的分配，管理与监控；支持海量数据的并行计算数据处理。假定和约束注：描述系统设计中最主要的限制条件，这些是由政策、客户等因素强制要求并在需求规格说明书中写明的，影响实现的因素。本章将简述设计的系统是如何适应这些约束的，部分具体设计将在非功能性约束设计等章节说明。假定中，描述本系统之外的环境中，将严重影响本系统设计及运行的重要条件。如果本系统跟其他外部系统交互或依赖其他外部系统提供一些功能辅助，这时要求描述与本系统有交互的软件类型，以及导致的约束。例如，系统将如何适应第三方的运维自动化系统的可监控性要求。若实现的语言或平台对系统有约束，有特别要求的，同样需给予说明。例如需支持安全可信操作系统，例如必须支持多种语言的API等，需要说明约束，并在后期的如非功能性设计等章节，对约束的适应性进行说明。对因选择的具体设计实现而导致对系统的约束，简要描述设计思路，为什么要采取这样的设计等。例如受用户方提供的报表系统的约束，系统将受何约束...例： 1.本系统假定调控中心数据中台能够以约定的协议提供AGC业务数据；2.系统要求基于SG-UAP平台进行开发，3.应用需使用容器化部署。总体设计技术路线注：说明采用什么样的架构、平台、开发工具、存储、中间件、系统软件、甚至语言等的选型及其原因、用到的主要技术点等。同时也将表述因该技术设计而导致系统具备的技术特点。示例：以先进的开源数据库MySQL作为数据存储MySQL软件采用了双授权政策，它分为社区版和商业版，由于其体积小、速度快、总体拥有成本低并且开放源码的特点。使用HTML5技术，诠释web2.0的技术内涵HTML5技术具有跨平台、适配多终端、提高了用户体验、加强了视觉感受、发展比较平稳等多重特点。GIS技术、空间数据库技术与Internet技术结合GIS技术与Web技术的结合形成的WebGIS技术，使地图数据在网上发布成为可能，用户可以通过浏览器进行地理信息的各种操作。且用户无法直接存取地图资源库，从而真正保证了原始地图数据的应用安全。将数据库进行读写分离，建立独立的业务库，统计库和存档库为了确保数据库产品的稳定性，数据库拥有双机热备功能。第一台数据库服务器，是对外提供增删改业务的生产服务器；第二台数据库服务器，主要进行读的操作。总体架构注：系统总体的业务及技术架构及其简要说明。从系统应用的所有涉众层面的宏观视角。例如：应用架构与数字化项目应用架构关系描述本项目所属的平台及系统，图片和文字方式描述本系统在数字化项目应用架构的对应关系，示例：应用架构图注：应用架构描述了业务应用划分、应用组件构成、业务应用与业务能力、业务流程之间的关系，业务应用间及业务应用内部各部分间的集成关系以及业务应用部署模式，是一种结构化的表达。如：描述系统的分层应用，与其他系统的接口关系，面向的内外部用户等，可以采用图形表示（对存在有使用层级（如果系统功能、基础功能、高级应用等）、不同应用终端（如PC、移动应用、大屏等）、不同使用角色要进行体现）。例如：业务模块清单注：业务应用模块定义：若采用微服务思想，则拆分出来每个微服务列一行，若非微服务模式的应用或服务则可按独立进程拆分。模块标识编码全公司唯一编号，模块标识=应用平台编码+业务线编码+“-”+产品简称（英文）+“-”+模块简称（英文），如pas-example-equip，p即“发电行业智能管控平台”应用平台，as即“安全生产业务线”，example即某个产品，equip即“设备管理”模块。对于非复用的情况，“所属应用平台、所属业务线、所属部门、责任人、来源”可不填写。下表仅列出一级模块，而非功能点。序号模块标识模块名称类型版本号所属应用平台所属业务线所属部门责任人来源说明新增/使用/二次开发/外购产品库/xx客户单位开发库1pas-example-equip设备管理二次开发v19.1.1发电行业智能管控平台安全生产业务线xx客户单位开发库2pas-example-operation运行管理使用v18.2.0发电行业智能管控平台安全生产业务线产品库34总体数据流图注：对系统数据的流程进行描述，采用数据流程图的方式，至少要有系统的顶级数据流图。例如：网络架构注：该章节为可选，说明系统软硬件部署或网络拓扑结构，一般用图形表示。例如：复用策略注：说明系统将复用哪些未在业务模块清单中列出的，现有可用的组件、代码类等。（可选）序号组件ID及名称组件功能功能需求复用程度备注公共组件设计注：说明系统将包含或提炼哪些公共组件，并描述功能和作用。序号组件ID及名称功能或处理概述备注命名及目录设计前台工程注：命名规则依据《命名规范》、《Java编码规范》以及《产品编码规范》和《Javascript编码规范》制订。前台工程包括WEB、WEB的API、移动应用、大屏等项目。示例：前台业务目录，推荐的结构，由JREAP技术规范确定。序号模块英文名相对路径备注后台服务《todo:示例》序号模块英文名相对路径备注通用要求1、下拉选择框除了各子项内容外，还必须有“请选择”子项，代表全部。

2、页面的表格中均要有分页显示控件，分别有首页、下一页、上一页、末页，每页显示X条数据。X默认为20，可设置50、100。放置在表格的右下角。

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

4、在做删除操作前，必须弹出询问窗口，在用户确认后，才能执行删除命令。且要弹出数据是否删除成功的提示。

5、所有前台页面的输入文本框必须在前台页面做长度验证、类型验证。有特定含义的字段还必须做特定的验证（如身份证、车牌号码）。

6、新增数据类按钮放置在页面的右上角（数据表格之外），对已有数据进行操作的按钮放置在表格中。

7、所有的数据传输都要按照HTTPS的方式进行。

8、点击表格中的表头字段，可按该字段进行排序。

9、页面原型作为页面布局的参考，实际开发中以页面的美观、整洁为目标进行控件布局。

10、界面表格中第一列为序号列，均为系统自动生成，翻页时，序号要自动变化。

11、对于文本框均要做前导和后续空格的排除操作。

12、页面中有开始和结束时间段的，都按照大于等于开始时间，小于等于结束时间的逻辑进行查询。如，需要查询6月1、2、3号三天的数据，则开始时间为6月1日，结束时间为6月3日。业务应用模块设计注：对于功能点较多，且归属关系相对固定的，可按系统、模块、功能点三级进行描述。对于功能点较少的，可直接按系统、功能两级进行描述。以下按两级结构示例。对于较复杂的功能点，可再细分到第三级。对于简单的功能点，则可聚合成按功能进行设计。原则上功能清单应与需求矩阵中的设计一列相对应。设备管理模块（pas-example-equip）注：对模块的描述、模块级的处理流程或数据流程进行描述（可选）。功能清单功能标识功能名称功能描述类型AD01.01视频远程集中监视复用AD01.02设备缺陷新增注：如果还有子功能，可在本表中增加列予以扩展，如AD01.01.01，并在下文中的功能章节增加相应层级。模块目录结构模块目录位于项目目录的modules中，允许使用本地的配置及lib。即目录位置为：/dtxytech/projectname/modules/modulename。模块输出的可执行文件位于[modulename]根目录下。模块子目录结构为：[modulename]/lib,[modulename]/config,[modulename]/resources各类型项目目录结构示例如下（实际编写中可根据项目类型任选）：前端模块目录结构后端模块代码目录结构示例：目录：业务通用组件、服务消费、服务提供的文件夹由平台自动生成。如:业务通用组件/java。组件包命名：业务通用组件mons服务消费com.dtxytech.pas.equip.consumer服务提供vider.impl注1：业务通用组件、服务消费、服务提供这种组件的包只能用模块标识命名。注2：pas-example-equip为模块标识即设备管理全公司唯一。注3：因java包命名中不能有中划线符号，故pas-example-equip在命名包时转化为pas.equip。后端模块接口工程代码目录结构示例：目录：src/main/java/接口包命名：服务提供API接口vider数据转换对象com.dtxytech.pas.equip.dto工具类com.dtxytech.pas.equip.util注1：文件夹src位于后端工程的根目录。本目录下com.dtxytech.模块标识.provider（服务提供API接口）、com.dtxytech.模块标识.dto（数据转换对象）、com.dtxytech.模块标识.util（工具类）三个包是每个模块必须包含的，原则上一个模块的所有功能的对外服务统一通过此工程提供接口API。注2：pas-example-equip为模块标识即设备管理全公司唯一。注3：因java包命名中不能有中划线符号，故pas-example-equip在命名包时转化为pas.equip。注4：如项目需要添加功能级接口包，如设备台账功能服务接口，接口命名规则为：com.dtxytech.pas.equip.equipledger.provider），注意提供功能级的接口包也须包含remote、dto、util包，并且位于src/main/java/目录下。AD01.01视频远程集中监视注：对于APP类型的应用，可以“参见XX原型.rp文件，XX模块XX功能”而略过本章下各节。但原型中必须说明：数据源、主要处理过程、业务规则、约束、异常处理等要素。名称视频远程集中监视页面功能点预览、云台控制、回放功能描述注：系统功能的整体描述。复杂度用户交互注：若为后端服务，直接标识为后台服务；若为终端执行，列出终端交互方式及反馈内容类型及示例；若为接口服务，标为“API服务，采用何种规约”左边窗口调用【queryCameraByPerson】接口获取当前用户具有权限的所有摄像头并以树结构显示，右边显示视频窗口及云台控制按钮；窗口数默认显示为1X1；码流默认显示为主码流；数据源*注：此处应根据需要的：资源文件、配置信息、关系数据库、时序数据库等说明依赖的相对静态的资源。例如关系数据库，说明，依赖哪些表的哪些域。时序库，可说明依赖哪些类型或者具体哪些标签。前置条件页面加载之前验证是否已经安装对应版本插件；默认显示（用于前端型项目）要求：提出缺省的数据获取及展示要求；约束*1、根据角色权限显示摄像头的实时视频及云台控制按钮。业务规则异常处理*没有安装插件或插件版本不对，弹出提示安装或下载相应版本插件，并提供下载路径；预览视频失败时弹出“登录失败”或“请检查网络是否连通”。补充说明点击窗口数以设置视频窗口数；数据流程图相应的业务流程图应在需求规格说明中体现。本处绘制最底层的数据流程图，没有的可以标“无”处理过程处理的流程（数据流程）、处理的过程（分步骤实现的过程）注：可采用文字描述实现的过程、对流程化的采用活动图方式对业务处理的过程进行说明（后台服务）示例：主处理过程：下面对各模块（以数字表示）进行功能说明：网络数据接收接受由客户机程序经网络传送到客户机的数据包，它是程序与网络的接口。解开数据解开/解密打包的数据，并将恢复的数据格式化送入3。判断操作由数据判断需要做什么数据库操作，它是一事务处理中心，若为定票操作则将数据送4，若为领票操作则将数据送15。准备数据库查询语句由定票数据准备访问SQLSERVER数据库所需的SQL语句，送入5。数据库操作运行SQL语句，查询并存入数据库，获得相应的定票数据，将数据送入6。它需包括初步对查询的判断。它必须为乘客安排可抵达目的地的有座位的航班。判断查询是否成功利用查询所得的数据判断定票是否成功，它是一事务处理中心，若为定票操作成功则将数据送7，若不成功则将数据送8。准备回送数据准备定票成功后需回送客户机程序的数据，送16。确定原因由查询数据判断定票不成功的原因，送9。准备回送数据根据不成功的原因，准备需送回客户机程序的数据，送入16。准备数据库查询语句由领票数据准备访问SQLSERVER数据库所需的SQL语句，送入11。数据库操作运行SQL语句，查询并存入数据库获得相应的领票数据，将数据送入6。它需包括初步对查询的判断。判断查询是否成功利用查询所得的数据判断领票是否成功，它是一事务处理中心，若为领票操作得到确认则将数据送11，若不成功则将数据送8。准备回送数据准备领票确认后需回送客户机程序的数据，送16。确定原因由查询数据判断领票不能确认的原因，送15。准备回送数据根据不成功的原因，准备需送回客户机程序的数据，送入16。准备网络数据包将数据准备/加密成网络传输数据包。网络数据发送将数据包经网络发送到服务器程序，它是程序与网络的接口。以上显示的各模块数字相同的为同一模块；由于事务流处理上的便利，将有些功能模块，拆分到各事务流中。分支处理过程：功能目录结构注：可能为以下任一种类型的功能，依据功能类型，说明其源代码及输出的组织方式。若功能仅为模块目录下的一个源文件，或者是仅为模块下的一个可执行文件的输出，说明其位于模块目录下，说明其代码或者可执行文件名称即可。前端功能目录结构示例：src/webcontent/web/pas-example-equip/equipledger/注1：文件夹src位于前端工程的根目录，功能文件夹（equipledger）位于模块文件夹（pas-example-equip）的下一层级，如功能下有子功能，可以扩展子功能文件夹。注2：pas-example-equip为模块标识即设备管理全公司唯一、equipledger为设备台账功能起的功能名，建议用英文命名。后端功能目录结构示例：equipledger/注1：具体功能的服务及实现文件夹，如设备管理的文件夹equipledger位于后端工程的根目录。注3：equipledger为设备台账功能起的功能名，建议用英文命名。界面设计注：若无，则可略过。AD01.02设备缺陷编写要求与”4.1.3”章节相同……….。模块间接口设计清单序号接口名称提供者(模块名)使用者（模块名）接口简述类型原有/新增/不建议使用1接口1设备管理新增2接口2设备管理原有3接口3运行管理设备管理原有4接口4运行管理设备管理新增注：概要设计阶段，本表须明确接口的“类型”，即“原有/新增/不建议使用”具体接口设计参看项目的《接口设计表》外部系统接口设计清单序号外部系统名称接口名称接口类型接口通讯方法/接口协议接口描述具体接口设计参看项目的《接口设计表》公共数据项清单注：见《公共数据项清单》附件中说明数据库物理模型注：描述数据库物理模型设计图，可参见数据库设计文件；运行管理(pas-example-operation)编写要求与”4.1”章节相同。系统安全性设计注：对系统涉及的各安全要求的实现方法进行具体描述。《todo：示例》数据安全注：包括数据访问，数据存储，数据传输过程安全性的保证方法，例如对关系数据访问采用证书访问或者本地协议访问等。数据安全属性分析数据类别使用者说明机密性赋值完整性赋值可用性赋值数据流转分析数据流转过程简要说明描述数据的来源，由谁使用，使用过程中途径哪些系统环节是否在用户端呈现是/否是否用户端保存是/否是否在网络中传输是/否是否经过可信与不可信边界传输是/否是否通过无线网络传输是/否是否在应用系统间传输是/否是否保存在应用系统中是/否应用安全注：要求双因子认证，例如限制用户对服务进程的启停，例如对配置文件存储的安全性如何保证等。控制点防护策略设计身份认证设置密码的存储和传输安全；保护身份验证Cookie；同一用户同时只允许登录一个；授权设计资源访问控制方案，验证用户访问权限；限制用户对系统级资源的访问；设计统一的访问控制机制；输入输出验证设计验证所有来源不在可信范围之内的输入数据；应在服务器端和客户端都应进行输入验证；应对输入内容进行规范化处理后再进行验证，如文件路径、URL地址等，需要规范化为标准的格式后再进行验证；应当从服务器端提取关键参数，禁止从客户端输入；配置管理确保配置存储的安全；应使用最少特权进程和服务帐户；应避免应用程序调用支撑系统资源；单独分配管理特权；会话管理设计登录成功使用新的会话；设计会话数据的存储安全；设计会话数据的传输安全；设计会话的安全终止；设计合理的会话存活时间；加密技术不使用自创加密方法；确保加密密钥的安全；参数操作不要信任HTTP头信息；确保用户没有绕过检查；应验证从客户端发送的所有数据；异常管理使用结构化异常处理机制；使用通用错误信息；程序发生异常时，应终止当前业务，并对当前业务进行回滚操作，保证业务的完整性和有效性，必要时可以注销当前用户会话；程序发生异常时，应在日志中记录详细的错误消息；审核和日志日志记录事件应至少包含以下事件：审计功能的启动和关闭；应用系统的启动和停止；配置变化；访问控制信息；用户对数据的异常操作事件服务器安全注：例如包括如何具体为应用创建哪一单独用户，对其进行资源配额管理，限制其在哪些目录的访问权限等。系统主机描述描述本项目中所使用主机的功能。主机安全设计根据等级保护和智能电网安全防护方案的要求从主机访问控制、主机安全加固、主机入侵检测、主机内容安全、病毒防范、主机身份鉴别、数据加密、主机监控审计、备份恢复、资源控制、剩余信息保护这几个方面给出主机安全详细