DB34∕T 4322-2022 水利业务移动端门户开发与应用接入规范

ICS01.120

CCSA00

34

安徽省地方标准

DB34/T4322—2022

水利业务移动端门户开发与应用接入规范

Specificationfordevelopmentandapplicationaccessofwaterconservancymobile

terminal

2022-10-26发布2022-11-26实施

安徽省市场监督管理局发布

DB34/T4322—2022

前言

本文件按照GB/T1.1—2020《标准化工作导则第1部分：标准化文件的结构和起草规则》的规定

起草。

请注意本文件的某些内容可能涉及专利。本文件的发布机构不承担识别专利的责任。

本文件由安徽省水利厅提出并归口。

本文件起草单位：安徽省（水利部淮河水利委员会）水利科学研究院、讯飞智元信息科技有限公司、

安徽省响洪甸水库管理处。

本文件主要起草人：马顺、刘超、王铭铭、程习华、刘怀利、马浩、王砚海、沈超、贾飞、赵辉、

丁晓磊、方婧、秦平、吴秋明、赵亮、李水兵、孙骁磊、管菁菁、方洋。

I

DB34/T4322—2022

水利业务移动端门户开发与应用接入规范

1范围

本文件规定了水利业务移动端的门户开发、应用接入和安全。

本文件适用于水利业务移动端的门户开发和应用接入。

2规范性引用文件

下列文件中的内容通过文中的规范性引用而构成本文件必不可少的条款。其中，注日期的引用文件，

仅该日期对应的版本适用于本文件；不注日期的引用文件，其最新版本（包括所有的修改单）适用于本

文件。

GB/T25000（所有部分）系统与软件工程系统与软件质量要求和评价（SQuaRE）

GB/T25068（所有部分）信息技术安全技术网络安全

3术语和定义

下列术语和定义适用于本文件。

单点登录singlesignon

在多个应用系统中，用户只需要登录一次即可访问所有相互信任的应用系统。

应用上架applicationadded

一种往应用门户中新增应用软件的操作。

应用下架applicationremoved

一种从应用门户中删除应用软件的操作。

H5应用H5application

基于HTML5标准开发的一种适配手机端的web应用。

4门户开发

基本流程

4.1.1业务需求分析

开发前应开展需求调研，完成业务需求分析和业务流程分析报告。

4.1.2系统架构设计

应根据业务流程与功能需求确定软件设计架构。

1

DB34/T4322—2022

4.1.3界面设计

根据业务特点对主要界面进行布局设计，应体现主要功能菜单布置、色彩搭配、界面层次级别等信

息。

4.1.4功能模块设计

应对主要功能模块进行单项设计，功能模块应具备扩展性。

4.1.5代码编写、测试及集成

应编写软件各功能模块代码，并进行单模块测试和多模块组合测试，最终完成软件各项应用集成。

4.1.6试运行与测评

会同用户开展不少于1个月试运行，并对软件试运行情况以及用户试用意见进行跟踪完善。

试运行结束后，应委托具有相应资质的第三方测评机构按GB/T25000（所有部分）的规定进

行软件测评。

4.1.7发布与上线

经测试合格后可发布、上线。

技术要求

4.2.1开发架构

应基于微服务的架构模式进行设计，前后端应分离，后端业务逻辑采用接口方式进行开发，前端通

过调用统一数据接口展现后台业务数据。

4.2.2接口开发

接口设计

接口设计应满足以下要求：

a)兼容性：在不需要更改软件业务逻辑的前提下可实现数据的共享；

b)独立性：一个接口服务中产生变化，不会导致关联接口服务发生变化；

c)安全性：应实现接口中传送数据的动态和静态加密解密；

d)灵活性和可扩展性：在应用系统有变更的情况下，只需对接口进行配置就可以有效调用数据。

接口标准

接口应统一使用WebService接口标准进行设计，并采用REST风格，服务应能够注册进入企业

服务总线，所有业务操作应全部抽象出REST接口进行开放。接口设计应考虑版本兼容性，保持向下兼

容。

注1：Webservice即web服务，是一种跨编程语言和跨操作系统平台的远程调用技术。

注2：REST即表征性状态转移（RepresentationalStateTransfer），是通过创造一种资源的定义与描述原则，形

成一种标准化规范，从而减少技术人员在开发与沟通时候的成本。

接口数据响应

2

DB34/T4322—2022

应采用统一标准规格的JSON数据进行响应，响应对象为RespData；应提供相应的接口说明、编码说

明文档，每个接口对应一个接口说明表，每个业务模块对应一个响应编码说明表，编码说明表中的0、

1为固定返回值，接口服务说明文档参考附录A。

注：JSON即JavaScript对象简谱（JavaScriptObjectNotation），是一种轻量级的数据交换格式采用完全独立

于编程语言的文本格式来存储和表示数据，易于人阅读和编写，同时也易于机器解析和生成，并有效地提升网

络传输效率。

性能要求

4.3.1响应时间

系统应具有快速响应的特性，用户打开界面和提交事务的平均响应时间应不大于1.5s，用户进行

在线实时查询业务操作的数据处理时间应不大于5秒。

4.3.2吞吐率

软件系统吞吐率应达到不小于10M/s的要求。

4.3.3并发用户数

系统应能够在并发用户数达到600的情况下稳定运行，且不会出现数据丢包。

4.3.4系统稳定性

系统应能保证稳定运行，且应具备故障检测、故障诊断、故障恢复等故障自检功能。在故障发生时

应能保证重要数据不丢失并能将故障模块自动隔离。

4.3.5页面加载与数据传输

页面数据的加载、修改、增加等操作应采用异步的方式操作，数据宜统一采用JSON格式进行传

输。

界面开发要求

4.4.1页面规范

页面布局、页面尺寸比例、主色调色彩、重要行间距等页面布局应合理、规范。

4.4.2文字规范

同一层级的字体、字号、字色搭配应该保持一致。工作（主）界面、组织机构列表、通讯录页面、

应用市场页面及更多页面文字规范要求见表1。

表1文字规范要求

界面/页面文字规范要求

PingFangSC-Regular[15px]#333333：用于标题文字；

PingFangSC-Regular[14px]#333333：用于Icon图标应用文字；

工作（主）界面

PingFangSC-Regular[11px]#A9A9A9：用于Tab页签文字；

PingFangSC-Medium[13px]#FFFFFF：用于搜索提示文字。

PingFangSC-Medium[17px]#333333：用于列表标题文字；

PingFangSC-Medium[18px]#FFFFFF：用于顶部标题文字；

组织机构列表

PingFangSC-Medium[15px]#FFFFFF：用于返回按钮文字；

PingFangSC-Medium[15px]#B1B1B1：用于搜索提示文字。

3

DB34/T4322—2022

表1（续）

界面/页面文字规范要求

PingFangSC-Medium[17px]#333333：用于列表标题文字；

PingFangSC-Medium[18px]#FFFFFF：用于顶部标题文字；

通讯录页面

PingFangSC-Medium[14px]#A9A9A9：用于备注文字；

PingFangSC-Medium[15px]#B1B1B1：用于搜索提示文字。

PingFangSC-Medium[17px]#333333：用于列表标题文字；

PingFangSC-Medium[18px]#FFFFFF：用于顶部标题文字；

应用市场页面PingFangSC-Medium[15px]#FFFFFF：用于返回按钮文字；

PingFangSC-Medium[14px]#808080：用于备注文字；

PingFangSC-Medium[15px]#B1B1B1：用于搜索提示文字。

PingFangSC-Medium[17px]#333333：用于列表标题文字；

PingFangSC-Medium[18px]#FFFFFF：用于顶部标题文字；

更多页面PingFangSC-Medium[15px]#FFFFFF：用于返回按钮文字；

PingFangSC-Medium[14px]#808080：用于备注文字；

PingFangSC-Medium[15px]#B1B1B1：用于搜索提示文字。

4.4.3图标

应用图标尺寸大小宜控制在80×80像素以内，分辨率应不低于72dpi；

标签栏图标尺寸大小宜控制在46×46像素以内，图标要有选中、未选中两种状态，分辨率

应不低于72dpi。

资料要求

4.5.1开发文档整理

应及时整理系统开发实施各阶段的技术文件、图表资料、测试报告、验收报告等，形成完整的开发

文档资料，具体开发文档表参见附录B。

4.5.2编制开发情况说明表

应提取软件设计开发过程中的关键技术指标并形成软件开发情况说明表，具体情况说明表参见附

录C。

4.5.3操作指南编写

应编写操作指南用于指导用户安装使用，明确硬件配置要求以及注意事项等内容。

5应用接入

接入

支持H5应用和APP应用接入，在接入应用时应在门户后台注册，注册信息应至少包括应用名称、

应用说明、标识、入口调用方式等。

上架、下架

应用可进行上架操作，上架后应用就可以发布到移动门户APP供用户使用。上架后的应用也可以

被下架，下架后移动门户APP中用户将无法再使用该应用。

4

DB34/T4322—2022

权限

用户权限应分为按组织、按标签、按用户三个维度，权限控制支持分级管理模式，可按组织架构分

级设置管理员，可分级授权。

认证与授权

5.4.1方式

用户接入认证应采用OAuth方式。

注：OAuth方式是一种授权机制，它是在客户端和资源所有者之间的授权层，用来分离两种不同的角色。在资源所有

者同意并向客户端颁发令牌后，客户端携带令牌可以访问资源所有者的资源。

5.4.2流程

用户采用OAuth方式接入后通过usertoken来完成不同移动应用之间的单点登录和用户认证与

授权，用户认证与授权流程图见图1。

图1移动门户认证与授权流程图

6安全

网络安全应符合GB/T25068（所有部分）的规定。

5

DB34/T4322—2022

附录A

（资料性）

接口服务说明文档

见表A.1和表A.2。

表A.1接口服务基本信息表

服务名称接口地址

开发厂家传输协议□HTTP□HTTPS

请求方式□POST□GET返回格式□JSON□XML

接口功能简要说明

是否必须

参数名参数类型描述

（是/否）

请求参数

返回内容

表A.2接口响应编码说明表

种类编码描述

正常0成功

2消息格式异常，例如必填参数未填，消息编码异常等

3无效的路由属性

6权限异常

请求异常9接口请求包大小超过限制

101重复请求

102请求无效

199接口请求方其他异常

8接口响应方超时

202接口响应包大小超过限制

接口响应方异常

298接口响应方内部异常

299接口响应方其他

6

DB34/T4322—2022

表A.2（续）

种类编码描述

4调用的服务未发布

5调用的服务已注销

7调用的服务已关闭

平台异常11调用的服务不存在

-1调用服务失败

398平台内部异常

399平台其他异常

其他异常999其他异常

7

DB34/T4322—2022

附录B

（资料性）

水利业务移动端软件开发文档表

见表B.1。

表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项目实施总结报告

8

DB34/T4322—2022

附录C

（资料性）

水利业务移动端软件开发情况说明

见表C.1。

表C.1水利业务移动端软件开发情况说明表

系统名称开发商

布设地点市县机构访问地址

□B/S□C/S□Android□iOS

系统版本系统结构

□HarmonyOS□其他

操作系□Windows□Linux是否有兼容

□是□否

1.系统统□Unix□其它要求

浏览器兼

概述运行环境□IE□Chorme

容情况

版本兼容浏览器□火狐□Safari

□360□其它

开发语言代码量

系统总体应

用说明

开发方式□嵌入式开发□组件式开发□模块式开发□其它

2.开发

□SpringMVC-IBatis□SpringMVC-MyBatis□SpringBoot-MyBatis

方式系统架构

□Structs2-Spring-Hibernate□其它

序号名称版本备注

1

2

3.技术

3

应用

4

5

…

功能综述

是否可供外

序号功能名称功能描述

部调用

1

2

4.系统

3

功能核心功能

4

5