2020水利信息系统软件开发集成规范

水利信息系统软件开发集成规范IIIIII目次范围 1规范性引用文件 1术语和定义 1缩略语 1软件开发基本流程 2适用性说明 2开发前准备工作 2系统架构设计 2界面设计 2软件单项功能模块开发 2软件代码编写、测试及应用整合 2系统试运行与测评 2完善与优化 2文档管理 3软件开发性能及运行环境要求 3软件性能 3软件开发及运行环境 3数据库 4软件开发过程控制 4系统软件架构 4数据库设计 5界面（UI）开发 6单项功能模块开发 7接口设计 7软件测试 8系统部署 8参数设置 9系统集成 9基本要求 9数据集成 9应用集成 10界面集成 12权限控制与管理 12移动应用开发与集成 12移动应用开发 12移动应用集成 13系统安全策略 13权限、策略机制 13认证、授权机制 13编码开发安全控制 13数据存储控制 13数据传输安全 13异地容灾机制 13安全等级保护测评 13质量控制、培训及运维管理 13质量控制 14培训管理 14运维管理 14附录A（资料性附录）水利信息系统软件第三方测评情况说明表 16附录B（资料性附录）水利信息系统软件开发文档 17附录C（资料性附录）水利信息系统软件开发情况说明 18附录D（规范性附录） 接口服务说明文档 20附录E（资料性附录） 软件开发流程图 22附录F（资料性附录）某省级水资源监控管理系统集成样例 23PAGEPAGE11PAGEPAGE10水利信息系统软件开发集成规范范围成、移动应用开发集成、系统安全策略、质量控制、培训及运维管理等重要环节进行了规定。本标准适用于水利信息系统软件开发集成项目的设计、实施和维护升级等。规范性引用文件件。凡是不注日期的引用文件，其最新版本（包括所有的修改单）适用于本文件。SL478水利信息数据库表结构及标识符编制规范SL/Z589 水利信息化业务流程设计方法通用指南SL701水利信息分类SL715水利信息系统运行维护规范术语和定义下列术语和定义适用于本文件。3.1软件开发流程softwaredevelopmentprocess描述完成一项软件开发工作所进行的业务需求分析、架构设计、功能设计、程序编码、应用整合、功能测试等一系列工作的具体环节、步骤和程序。3.2系统集成systemintegration享交换、功能及业务应用可相互调用，使资源达到充分共享，实现集中、高效、便利的管理。缩略语下列缩略语适用于本文件。SSO：单点登录（SingleSignOn）SOA：面向服务的架构(ServiceOrientedArchitecture)JSON：JavaScript对象简谱(JavaScriptObjectNotation)SSL：安全套接层（SecureSocketsLayer）PKI/CA：公钥基础设施（PublicKeyInfrastructure）ESB：企业服务总线（EnterpriseServiceBus）软件开发基本流程适用性说明5.2～5.9提出的基本要求。开发前准备工作符合SL/Z589的规定。系统架构设计根据业务流程与功能需求，确定系统设计架构。界面设计息，形成用户认可的界面设计成果。应对主要功能模块进行单项设计，功能模块划分应科学合理，以便于使用和扩展为原则。软件代码编写、测试及应用整合各项业务应用整合，整合后的系统功能应能充分满足用户使用需要。系统试运行与测评系统试运行系统上线试运行，发布测试版软件供用户试用，并对系统试运行情况以及用户试用意见进行跟踪。软件测评评完成后应形成测评情况说明文档，文档格式可参考附录A。完善与优化软件完善与优化根据软件试运行结果及用户反馈意见对软件进行完善和优化。正式版发布软件经过用户试用、测评和修改完善后达到上线要求，形成正式版软件发布。文档管理开发文档整理料，具体资料目录可参见附录B。编制软件开发情况说明表于系统用户快速掌握软件的核心内容，表格具体设计可参见附录C。操作指南编写编写操作指南，指导用户安装使用，明确硬件配置要求以及注意事项等内容。软件开发性能及运行环境要求软件性能响应时间<1.5时查询业务操作的数据处理时间应<5s。吞吐率软件系统吞吐率（单位时间内网络上传输的数据量）应能满足≥10M/s。并发用户数系统应能够在并发用户数达到300的情况下稳定运行，不会出现数据丢包。系统稳定性应能保证重要数据不丢失并能将故障模块自动隔离。页面加载与数据传输JSON格式进行传输。软件开发及运行环境开发环境宜使用J2EE环境进行系统软件开发，JDK版本可使用当前最新版本的前一个版本号进行环境搭建。Web宜采用weblogic服务进行应用发布，对特殊要求的应用可通过申请采用其他应用服务。内存使用控制及会话保存时间5Session（运行环境WindowsServerLinuxIE、360、Chorme、Safari等主流的浏览器版本。择oracle数据库。软件开发过程控制系统软件架构水利信息系统软件应按照“分层设计、模块构建”的思想，采用多层结构设计，形成可扩展、4应遵循水利相关标准规范体系，依托水利信息安全保障体系。1图1水利信息系统软件组成架构图架构设计要求水利信息系统软件架构设计包含如下基本要求：应按照多层体系结构进行设计；SOA（面向服务架构据接口进行调用；粒度“服务”的可能；安全保障体系中与应用安全相关的信任和授权管理应遵循国家信息安全相关标准。数据库设计信息分类编码与表结构设计信息分类编码与表结构设计应满足如下要求：信息的分类与编码应符合SL701的规定；数据库表结构设计及标识符编制应符合SL478的规定；应充分保证数据结构的合理性，数据元素归类和划分应合理，对数据项应进行合理描述。数据库分类五大类。每一类数据库存储的数据信息如下：基础数据库：各类基础数据信息，应至少包括行政区划、基础对象名录等信息；业务数据库：与软件实现的核心功能相关的各类具体业务数据；监测数据库：各类实时采集、动态更新变化的数据信息；空间数据库：实现各类空间要素对象信息的存储；多媒体数据库：各类图像、视频、音频信息的存储。数据库详细设计数据库详细设计应包括如下五个阶段：以及围绕这些数据的业务处理需求，分析的结果应采用数据流程图进行图形化的描述；E-R（实体-联系图）；E-R式；和存取路径设计，形成数据库内模式；需要进行确认。数据存储与共享数据存储与共享应遵循如下要求：存储方式；应建立数据字典，并确保数据含义的一致性和唯一性，便于数据挖掘和深层次应用；系统数据的整合共享，避免重复建设；管理与灵活应用；应明确数据共享范围、内容、形式、载体、交换方式、权限规则等。数据安全性数据安全性控制包括以下要求：止机密数据泄露；物理安全：保障数据存储介质安全，防治重要数据丢失；11界面（UI）开发布局基本要求系统整体布局应包括LOGO体界面布局宜如下图2所示：图2界面布局样式图开发要求界面设计与开发应满足如下要求：Html5讨论后确定；成查询定位；类柱状图、饼状图、直方图等。单项功能模块开发基本要求5-107.4.2～7.4.9规定的内容。总览模块进行信息展示。采集模块采集各类动态数据信息，在系统页面上进行信息的直观展示并能实现数据动态更新。查询模块查询等方式。统计报表模块导出等功能。数据管理模块实现各类基础数据的增、删、改、查管理，并支持数据批量导入和导出。参数配置模块实现软件各模块功能、界面相关的核心参数配置。地理信息模块实现基于GIS的空间对象信息查询与展示。用户管理模块实现系统相关的各类用户账号、权限、角色信息管理。接口设计接口标准WebServicerest册进入企业服务总线（ESB），所有业务操作应全部抽象出rest接口数据响应接口响应的对象，应统一采用标准规格的JSON数据进行响应，响应对象为RespData；应提供相0、-1为固定返回值。接口服务说明表和响应编码说明表宜参考附录D设计要求接口设计应满足如下要求：共享性：在不需要更改系统业务逻辑的前提下可实现数据的共享；独立性：一个接口服务中产生变化，不会导致关联的接口服务也发生变化；安全性：应实现接口中传送数据的动态和静态加密解密；灵活性和可扩展性：在应用系统有变更的情况下，只需对接口进行配置就可以有效调用数据。软件测试功能测试功能测试应实现对各项业务功能的验证，以确认每个功能是否能正常使用，功能测试应包括：软件各模块在模拟环境和实际运行环境下的功能测试；系统与外部接口的验收测试；数据准确性测试；所有必要的检错、调整和重复性测试。性能测试性能测试是在各种典型的最不利的状态下测试系统运行情况，以证明系统在所有部分的性能参数、效率指标和其它方面达到技术要求的规定值，保证所有部分协调运行，运行无故障且满足技术要求，测试指标内容宜包括6.1.1～6.1.5规定的内容。安全测试在软件正式上线发布前应对软件进行安全测试，测试应包括如下内容：身份鉴别；访问控制；安全审计；应用安全漏洞扫描；数据完整性；代码安全隐患。系统部署生产环境目录规范生产环境内的文件及文件夹应采用清晰明确的命名方式，源项目文件和编译后项目文件独立存放，形成文件夹目录树并对存放文件的文件夹编写说明文件。生产环境部署升级要求生产环境内信息系统部署应提供系统部署升级说明文件，说明系统升级内容、系统文件部署时间、发布程序文件名录及硬盘路径；对于系统升级应额外提供部署回退方案，说明最迟回退时间。参数设置Web管理服务的端口不应使用默认端口，系统涉及的IP、端口以及之间的关系应形成文档表格。WebXms、Xmx、PermSize、MaxPermSize参数应使用统一分配的内存大小。系统集成基本要求5～7集成过程应做好权限控制与管理。图3系统集成架构图数据集成集成方式数据集成是基于数据存储层，通过数据共享交换技术实现水利信息系统之间数据的交换和共享集成，主要集成方式包括数据接口调用、ETL工具（提取、转换、加载）、消息中间件推送三种。针对如下不同的系统结构应采用不同的数据集成方式：ETL（级别划分储本级所需的各类业务数据，只需将上级所需的业务数据提取并推送给上级即可；WebService系统数据库之间的安全隔离。集成要求数据集成应满足如下要求：系统应在开发完成前按照建设要求统一规划开放数据共享通道，便于行业内数据共享使用；扩展性；WebServiceNAS应建立数据库安全审计系统，实现对目标数据库系统的用户操作的监控和审计。集成步骤数据集成应包括如下基本步骤：分析数据来源：分析数据来源，明确需集成数据的数据类型结构、存储方式、数据量等；选择集成方式：根据不同种类系统数据采用不同数据集成方式，可选方式包括接口调用、工具、消息中间件推送等方式；置交换库设计；图4数据集成步骤示意图应用集成集成方式功能数据,并推送至其他软件系统的页面，从而实现业务功能的集成、展现和复用。集成要求应用集成应满足如下基本要求：应将系统各项功能进行组件化封装，对外提供良好的接口服务；接口定义应具有硬件平台、操作系统和编程语言无关性；被封装的功能组件或接口服务应采用统一和通用的方式进行交互；应实现统一用户管理和单点登录功能；7.5.32000支持安徽水利“一张图”集成。集成步骤他业务应用软件的集成和通讯，应包含如下集成步骤：梳理软件各项业务应用功能，完成相应的接口设计和封装；ESB服务协调运作，实现不同服务之间的通信与整合，并可以提供一系列的标准接口；他业务应用系统调取。图5应用集成步骤示意图界面集成集成方式界面集成是在与用户交互的界面层实现集成，主要包含如下三种集成方式：urlFRAMEPortletportalportletportalURLLink，直接将某一系统功能模块通过链接方式链接集成到另一系统，作为另一个系统可引用的功能模块。集成要求界面集成应满足如下集成要求：应具备单点登录功能，用户无需进行多次身份验证；应具备灵活的个性化定制功能，用户可以自定义用户界面的特定部分；不同应用系统界面集成应保证界面色彩风格、菜单样式基本一致。集成步骤界面集成应至少包含如下集成步骤：在业务应用层首先应实现单点登录集成；8.4.1中四种集成方式中的一种或多种完成界面集成开发；完成集成测试，并形成资源集成的相关信息存档。权限控制与管理业务权限区、管理单位数据的统一分配，特殊需求要求支持菜单、按钮级权限分配。数据权限限的用户，支持自动过滤数据的访问。移动应用开发与集成应基于SOA的架构模式进行设计，移动前端通过调用统一数据接口展现后台业务数据。开发模式应遵循WebAPP技术要求，基于统一制式进行开发，可实现在第三方移动应用门户内的集成。鉴权要求移动应用开发应支持对移动门户的自动免登录和自动鉴权功能。移动应用数据与业务系统数据应保持一致性，移动应用数据集成也应基于业务系统数据集成实现，相关集成要求可遵循规范8.2要求的内容。集成方式宜采用接口调用的方式，接口采用restfull形式，对开放的接口服务需进行安全加密和非法请求过滤。息与应用之间的无缝对接。应支持不同移动端分辨率，能够做到自适应布局，同时应满足webkit和Html5技术标准，基于CSS3.0规范定义不少于高中低三种分辨率的布局样式。系统安全策略权限、策略机制系统应基于统一的用户授权策略管理，通过SSO、权限管理、加密管理和审计实现安全功能。认证、授权机制系统应支持认证和授权技术、加密技术和安全管理机制、以及SSL、PKI/CA、SSO、对称和非对称加密技术。编码开发安全控制需特别做好后门预防控制，防止恶意攻击绕过安全性控制而获取对系统资源的访问和控制。数据存储控制需对重要信息加密存储，并建立相应的防控措施。其他数据存储安全策略参见7.2.5。数据传输安全应确保数据通信通道的安全，数据传输采用加密算法，特别需对敏感数据进行加密。异地容灾机制系统宜充分考虑异地容灾备份因素，以应对不可抗力对系统和数据造成的破坏。安全等级保护测评系统应根据国家关于信息系统安全等级保护要求，开展信息系统安全等级保护测评。质量控制、培训及运维管理质量控制PDCA行版本管理和发行管理。培训管理应根据需要对相关用户和技术人员提供关于系统功能和操作方面的培训。安装手册、系统软件硬件使用说明书和故障排除手册等内容。运维管理数据库维护数据库维护宜做到下列几点：定期审核数据库日志，检查数据库账号和角色权限，确认是否有安全异常；实时监控数据库运行资源占用情况，定期释放资源，保障运行效率；实时监控数据库备份计划和复制同步计划，确认是否正常运行；实时监控分布式数据库数据订阅和同步情况，确认是否正常运行；针对存在的问题进行优化；定期通过数据库优化分析引擎或工具，监测数据库性能，并对存在的不足进行优化。代码维护软件代码维护宜做到下列几点：（如异常资源占用导致的系统效率低下码的审查、修改和优化；应对相关代码进行优化或重写；定期对代码产生的数据进行校验，如存在异常数据可反向检查代码，并对代码进行优化；行评审并对相关代码进行优化；功能升级优化应根据用户需求或主动对软件功能进行优化提升，具体宜做到下列几点：BUG（功能升级后不影响现有数据的运行，可保证数据一致性、完整性与安全性；时可对系统进行回退；本或进行系统回退操作。性能监测（参见其他运维管理要求系统运行过程中其他需维护内容、维护过程管理、维护组织体系等可参照SL715的规定执行。附录A（资料性附录）水利信息系统软件第三方测评情况说明表表A.1水利信息系统软件第三方测评情况说明表项目名称系统名称版本号建设单位名称承建单位名称第三方测评机构名称系统开发起止时间系统试运行起止时间第三方测评起止时间第三方测评机构资质CMA证书CNAS第三方测评内容文档审查功能测试可靠性测试可移植性测试性能效率测试填报人姓名填报日期附录B（资料性附录）水利信息系统软件开发文档表B.1水利信息系统软件开发文档资料参照表序号文档类型文档名称1需求文档需求调研报告2需求规格说明书3开发文档系统总体设计方案4系统详细设计方案5输入、输出设计方案6接口设计方案7程序模块说明书8数据字典9数据流程图10项目管理文档项目计划书11项目需求变更单12实施文档实施详细设计方案13项目实施计划14质量保证计划15测试文档测试方案16测试用例17测试报告18用户手册管理员手册19用户手册20系统部署手册21日常运维手册22培训手册培训手册23试运行文档试运行计划24试运行总结报告25用户试运行总结报告26验收文档项目验收方案27监理文档28项目实施总结报告附录C（资料性附录）水利信息系统软件开发情况说明表C.1水利信息系统软件开发情况说明表1.系统概述系统名称开发商布设地点市 县 机构访问地址系统版本系统结构B/S C/S Android IOS运行环境操作系统Windows LinuxUnix 其它浏览器兼容情况是否有兼容要求是 否版本兼容浏览器IE Chorme火狐 Safari360 其它开发语言代码量系统总体应用说明2.开发方式开发方式瀑布式开发 嵌入式开发 组件式开发 模块式开发 其它系统架构SpringMVC-IBatis SpringMVC-MyBatis SpringBoot-MyBatisStructs2-Spring-Hibernate 其它3.技术应用序号名称版本备注12345…4.系统功能功能综述核心功能序号功能名称功能描述是否可供外部调用1234567…表C.1(续)5.数据库信息数据库类型Oracle SQLServer MYSql 人大金仓 本地文件 其它访问方式单机访问 互联网 水利专网 政务网 其它局域网 其它数据库表结构参考规范有：名称 无 自定义库表数量字段属性数量存储过程是否有是 否触发器是否有是 否数量数量表结构文档有：名称 无 自定义关系文档有：名称 无 自定义6.接口说明接口类型WebService-REST WebService-SOAP WebSocket 适配器 其它接口数量文档有：名称 无 自定义附录D（规范性附录）表D.1接口服务基本信息表服务名称接口地址开发厂家开发技术HTTP HTTPS请求方式POST GET返回格式JSON XML接口功能简要说明请求参数参数名参数类型是否必须（是/否）描述返回内容表D.2接口响应编码说明表种类编码描述正常0成功请求异常2消息格式异常，例如必填参数未填，消息编码异常等3无效的路由属性6权限异常9接口请求包大小超过限制101重复请求102请求无效199接口请求方其他异常接口响应方异常8接口响应方超时202接口响应包大小超过限制298接口响应方内部异常299接口响应方其他平台异常4调用的服务未发布5调用的服务已注销7调用的服务已关闭11调用的服务不存在-1调用服务失败398平台内部异常399平台其他异常其他异常999其他异常附录E（资料性附录）软件开发流程图图E.1软件开发流程图附录F（资料性附录）某省级水资源监控管理系统集成样例一个平台下综合管理。集成范围全省各类水资源相关的业务系统的核心业务应用、业务数据。集成对象由于系统集成的对象涉及多个业务应用系统，可分为整体集成和共享集成两类。整体集成级水行政主管部门的取水许可证管理等。管理、节水型社会建设管理