ICS01.120

CCSA00

34

安徽省地方標(biāo)準(zhǔn)

DB34/T4322—2022

水利業(yè)務(wù)移動(dòng)端門戶開發(fā)與應(yīng)用接入規(guī)范

Specificationfordevelopmentandapplicationaccessofwaterconservancymobile

terminal

2022-10-26發(fā)布2022-11-26實(shí)施

安徽省市場(chǎng)監(jiān)督管理局發(fā)布

DB34/T4322—2022

前言

本文件按照GB/T1.1—2020《標(biāo)準(zhǔn)化工作導(dǎo)則第1部分：標(biāo)準(zhǔn)化文件的結(jié)構(gòu)和起草規(guī)則》的規(guī)定

起草。

請(qǐng)注意本文件的某些內(nèi)容可能涉及專利。本文件的發(fā)布機(jī)構(gòu)不承擔(dān)識(shí)別專利的責(zé)任。

本文件由安徽省水利廳提出并歸口。

本文件起草單位：安徽省（水利部淮河水利委員會(huì)）水利科學(xué)研究院、訊飛智元信息科技有限公司、

安徽省響洪甸水庫管理處。

本文件主要起草人：馬順、劉超、王銘銘、程習(xí)華、劉懷利、馬浩、王硯海、沈超、賈飛、趙輝、

丁曉磊、方婧、秦平、吳秋明、趙亮、李水兵、孫驍磊、管菁菁、方洋。

I

DB34/T4322—2022

水利業(yè)務(wù)移動(dòng)端門戶開發(fā)與應(yīng)用接入規(guī)范

1范圍

本文件規(guī)定了水利業(yè)務(wù)移動(dòng)端的門戶開發(fā)、應(yīng)用接入和安全。

本文件適用于水利業(yè)務(wù)移動(dòng)端的門戶開發(fā)和應(yīng)用接入。

2規(guī)范性引用文件

下列文件中的內(nèi)容通過文中的規(guī)范性引用而構(gòu)成本文件必不可少的條款。其中，注日期的引用文件，

僅該日期對(duì)應(yīng)的版本適用于本文件；不注日期的引用文件，其最新版本（包括所有的修改單）適用于本

文件。

GB/T25000（所有部分）系統(tǒng)與軟件工程系統(tǒng)與軟件質(zhì)量要求和評(píng)價(jià)（SQuaRE）

GB/T25068（所有部分）信息技術(shù)安全技術(shù)網(wǎng)絡(luò)安全

3術(shù)語和定義

下列術(shù)語和定義適用于本文件。

單點(diǎn)登錄singlesignon

在多個(gè)應(yīng)用系統(tǒng)中，用戶只需要登錄一次即可訪問所有相互信任的應(yīng)用系統(tǒng)。

應(yīng)用上架applicationadded

一種往應(yīng)用門戶中新增應(yīng)用軟件的操作。

應(yīng)用下架applicationremoved

一種從應(yīng)用門戶中刪除應(yīng)用軟件的操作。

H5應(yīng)用H5application

基于HTML5標(biāo)準(zhǔn)開發(fā)的一種適配手機(jī)端的web應(yīng)用。

4門戶開發(fā)

基本流程

4.1.1業(yè)務(wù)需求分析

開發(fā)前應(yīng)開展需求調(diào)研，完成業(yè)務(wù)需求分析和業(yè)務(wù)流程分析報(bào)告。

4.1.2系統(tǒng)架構(gòu)設(shè)計(jì)

應(yīng)根據(jù)業(yè)務(wù)流程與功能需求確定軟件設(shè)計(jì)架構(gòu)。

1

DB34/T4322—2022

4.1.3界面設(shè)計(jì)

根據(jù)業(yè)務(wù)特點(diǎn)對(duì)主要界面進(jìn)行布局設(shè)計(jì)，應(yīng)體現(xiàn)主要功能菜單布置、色彩搭配、界面層次級(jí)別等信

息。

4.1.4功能模塊設(shè)計(jì)

應(yīng)對(duì)主要功能模塊進(jìn)行單項(xiàng)設(shè)計(jì)，功能模塊應(yīng)具備擴(kuò)展性。

4.1.5代碼編寫、測(cè)試及集成

應(yīng)編寫軟件各功能模塊代碼，并進(jìn)行單模塊測(cè)試和多模塊組合測(cè)試，最終完成軟件各項(xiàng)應(yīng)用集成。

4.1.6試運(yùn)行與測(cè)評(píng)

會(huì)同用戶開展不少于1個(gè)月試運(yùn)行，并對(duì)軟件試運(yùn)行情況以及用戶試用意見進(jìn)行跟蹤完善。

試運(yùn)行結(jié)束后，應(yīng)委托具有相應(yīng)資質(zhì)的第三方測(cè)評(píng)機(jī)構(gòu)按GB/T25000（所有部分）的規(guī)定進(jìn)

行軟件測(cè)評(píng)。

4.1.7發(fā)布與上線

經(jīng)測(cè)試合格后可發(fā)布、上線。

技術(shù)要求

4.2.1開發(fā)架構(gòu)

應(yīng)基于微服務(wù)的架構(gòu)模式進(jìn)行設(shè)計(jì)，前后端應(yīng)分離，后端業(yè)務(wù)邏輯采用接口方式進(jìn)行開發(fā)，前端通

過調(diào)用統(tǒng)一數(shù)據(jù)接口展現(xiàn)后臺(tái)業(yè)務(wù)數(shù)據(jù)。

4.2.2接口開發(fā)

接口設(shè)計(jì)

接口設(shè)計(jì)應(yīng)滿足以下要求：

a)兼容性：在不需要更改軟件業(yè)務(wù)邏輯的前提下可實(shí)現(xiàn)數(shù)據(jù)的共享；

b)獨(dú)立性：一個(gè)接口服務(wù)中產(chǎn)生變化，不會(huì)導(dǎo)致關(guān)聯(lián)接口服務(wù)發(fā)生變化；

c)安全性：應(yīng)實(shí)現(xiàn)接口中傳送數(shù)據(jù)的動(dòng)態(tài)和靜態(tài)加密解密；

d)靈活性和可擴(kuò)展性：在應(yīng)用系統(tǒng)有變更的情況下，只需對(duì)接口進(jìn)行配置就可以有效調(diào)用數(shù)據(jù)。

接口標(biāo)準(zhǔn)

接口應(yīng)統(tǒng)一使用WebService接口標(biāo)準(zhǔn)進(jìn)行設(shè)計(jì)，并采用REST風(fēng)格，服務(wù)應(yīng)能夠注冊(cè)進(jìn)入企業(yè)

服務(wù)總線，所有業(yè)務(wù)操作應(yīng)全部抽象出REST接口進(jìn)行開放。接口設(shè)計(jì)應(yīng)考慮版本兼容性，保持向下兼

容。

注1：Webservice即web服務(wù)，是一種跨編程語言和跨操作系統(tǒng)平臺(tái)的遠(yuǎn)程調(diào)用技術(shù)。

注2：REST即表征性狀態(tài)轉(zhuǎn)移（RepresentationalStateTransfer），是通過創(chuàng)造一種資源的定義與描述原則，形

成一種標(biāo)準(zhǔn)化規(guī)范，從而減少技術(shù)人員在開發(fā)與溝通時(shí)候的成本。

接口數(shù)據(jù)響應(yīng)

2

DB34/T4322—2022

應(yīng)采用統(tǒng)一標(biāo)準(zhǔn)規(guī)格的JSON數(shù)據(jù)進(jìn)行響應(yīng)，響應(yīng)對(duì)象為RespData；應(yīng)提供相應(yīng)的接口說明、編碼說

明文檔，每個(gè)接口對(duì)應(yīng)一個(gè)接口說明表，每個(gè)業(yè)務(wù)模塊對(duì)應(yīng)一個(gè)響應(yīng)編碼說明表，編碼說明表中的0、

1為固定返回值，接口服務(wù)說明文檔參考附錄A。

注：JSON即JavaScript對(duì)象簡譜（JavaScriptObjectNotation），是一種輕量級(jí)的數(shù)據(jù)交換格式采用完全獨(dú)立

于編程語言的文本格式來存儲(chǔ)和表示數(shù)據(jù)，易于人閱讀和編寫，同時(shí)也易于機(jī)器解析和生成，并有效地提升網(wǎng)

絡(luò)傳輸效率。

性能要求

4.3.1響應(yīng)時(shí)間

系統(tǒng)應(yīng)具有快速響應(yīng)的特性，用戶打開界面和提交事務(wù)的平均響應(yīng)時(shí)間應(yīng)不大于1.5s，用戶進(jìn)行

在線實(shí)時(shí)查詢業(yè)務(wù)操作的數(shù)據(jù)處理時(shí)間應(yīng)不大于5秒。

4.3.2吞吐率

軟件系統(tǒng)吞吐率應(yīng)達(dá)到不小于10M/s的要求。

4.3.3并發(fā)用戶數(shù)

系統(tǒng)應(yīng)能夠在并發(fā)用戶數(shù)達(dá)到600的情況下穩(wěn)定運(yùn)行，且不會(huì)出現(xiàn)數(shù)據(jù)丟包。

4.3.4系統(tǒng)穩(wěn)定性

系統(tǒng)應(yīng)能保證穩(wěn)定運(yùn)行，且應(yīng)具備故障檢測(cè)、故障診斷、故障恢復(fù)等故障自檢功能。在故障發(fā)生時(shí)

應(yīng)能保證重要數(shù)據(jù)不丟失并能將故障模塊自動(dòng)隔離。

4.3.5頁面加載與數(shù)據(jù)傳輸

頁面數(shù)據(jù)的加載、修改、增加等操作應(yīng)采用異步的方式操作，數(shù)據(jù)宜統(tǒng)一采用JSON格式進(jìn)行傳

輸。

界面開發(fā)要求

4.4.1頁面規(guī)范

頁面布局、頁面尺寸比例、主色調(diào)色彩、重要行間距等頁面布局應(yīng)合理、規(guī)范。

4.4.2文字規(guī)范

同一層級(jí)的字體、字號(hào)、字色搭配應(yīng)該保持一致。工作（主）界面、組織機(jī)構(gòu)列表、通訊錄頁面、

應(yīng)用市場(chǎng)頁面及更多頁面文字規(guī)范要求見表1。

表1文字規(guī)范要求

界面/頁面文字規(guī)范要求

PingFangSC-Regular[15px]#333333：用于標(biāo)題文字；

PingFangSC-Regular[14px]#333333：用于Icon圖標(biāo)應(yīng)用文字；

工作（主）界面

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

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

PingFangSC-Medium[17px]#333333：用于列表標(biāo)題文字；

PingFangSC-Medium[18px]#FFFFFF：用于頂部標(biāo)題文字；

組織機(jī)構(gòu)列表

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

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

3

DB34/T4322—2022

表1（續(xù)）

界面/頁面文字規(guī)范要求

PingFangSC-Medium[17px]#333333：用于列表標(biāo)題文字；

PingFangSC-Medium[18px]#FFFFFF：用于頂部標(biāo)題文字；

通訊錄頁面

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

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

PingFangSC-Medium[17px]#333333：用于列表標(biāo)題文字；

PingFangSC-Medium[18px]#FFFFFF：用于頂部標(biāo)題文字；

應(yīng)用市場(chǎng)頁面PingFangSC-Medium[15px]#FFFFFF：用于返回按鈕文字；

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

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

PingFangSC-Medium[17px]#333333：用于列表標(biāo)題文字；

PingFangSC-Medium[18px]#FFFFFF：用于頂部標(biāo)題文字；

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

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

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

4.4.3圖標(biāo)

應(yīng)用圖標(biāo)尺寸大小宜控制在80×80像素以內(nèi)，分辨率應(yīng)不低于72dpi；

標(biāo)簽欄圖標(biāo)尺寸大小宜控制在46×46像素以內(nèi)，圖標(biāo)要有選中、未選中兩種狀態(tài)，分辨率

應(yīng)不低于72dpi。

資料要求

4.5.1開發(fā)文檔整理

應(yīng)及時(shí)整理系統(tǒng)開發(fā)實(shí)施各階段的技術(shù)文件、圖表資料、測(cè)試報(bào)告、驗(yàn)收?qǐng)?bào)告等，形成完整的開發(fā)

文檔資料，具體開發(fā)文檔表參見附錄B。

4.5.2編制開發(fā)情況說明表

應(yīng)提取軟件設(shè)計(jì)開發(fā)過程中的關(guān)鍵技術(shù)指標(biāo)并形成軟件開發(fā)情況說明表，具體情況說明表參見附

錄C。

4.5.3操作指南編寫

應(yīng)編寫操作指南用于指導(dǎo)用戶安裝使用，明確硬件配置要求以及注意事項(xiàng)等內(nèi)容。

5應(yīng)用接入

接入

支持H5應(yīng)用和APP應(yīng)用接入，在接入應(yīng)用時(shí)應(yīng)在門戶后臺(tái)注冊(cè)，注冊(cè)信息應(yīng)至少包括應(yīng)用名稱、

應(yīng)用說明、標(biāo)識(shí)、入口調(diào)用方式等。

上架、下架

應(yīng)用可進(jìn)行上架操作，上架后應(yīng)用就可以發(fā)布到移動(dòng)門戶APP供用戶使用。上架后的應(yīng)用也可以

被下架，下架后移動(dòng)門戶APP中用戶將無法再使用該應(yīng)用。

4

DB34/T4322—2022

權(quán)限

用戶權(quán)限應(yīng)分為按組織、按標(biāo)簽、按用戶三個(gè)維度，權(quán)限控制支持分級(jí)管理模式，可按組織架構(gòu)分

級(jí)設(shè)置管理員，可分級(jí)授權(quán)。

認(rèn)證與授權(quán)

5.4.1方式

用戶接入認(rèn)證應(yīng)采用OAuth方式。

注：OAuth方式是一種授權(quán)機(jī)制，它是在客戶端和資源所有者之間的授權(quán)層，用來分離兩種不同的角色。在資源所有

者同意并向客戶端頒發(fā)令牌后，客戶端攜帶令牌可以訪問資源所有者的資源。

5.4.2流程

用戶采用OAuth方式接入后通過usertoken來完成不同移動(dòng)應(yīng)用之間的單點(diǎn)登錄和用戶認(rèn)證與

授權(quán)，用戶認(rèn)證與授權(quán)流程圖見圖1。

圖1移動(dòng)門戶認(rèn)證與授權(quán)流程圖

6安全

網(wǎng)絡(luò)安全應(yīng)符合GB/T25068（所有部分）的規(guī)定。

5

DB34/T4322—2022

附錄A

（資料性）

接口服務(wù)說明文檔

見表A.1和表A.2。

表A.1接口服務(wù)基本信息表

服務(wù)名稱接口地址

開發(fā)廠家傳輸協(xié)議□HTTP□HTTPS

請(qǐng)求方式□POST□GET返回格式□JSON□XML

接口功能簡要說明

是否必須

參數(shù)名參數(shù)類型描述

（是/否）

請(qǐng)求參數(shù)

返回內(nèi)容

表A.2接口響應(yīng)編碼說明表

種類編碼描述

正常0成功

2消息格式異常，例如必填參數(shù)未填，消息編碼異常等

3無效的路由屬性

6權(quán)限異常

請(qǐng)求異常9接口請(qǐng)求包大小超過限制

101重復(fù)請(qǐng)求

102請(qǐng)求無效

199接口請(qǐng)求方其他異常

8接口響應(yīng)方超時(shí)

202接口響應(yīng)包大小超過限制

接口響應(yīng)方異常

298接口響應(yīng)方內(nèi)部異常

299接口響應(yīng)方其他

6

DB34/T4322—2022

表A.2（續(xù)）

種類編碼描述

4調(diào)用的服務(wù)未發(fā)布

5調(diào)用的服務(wù)已注銷

7調(diào)用的服務(wù)已關(guān)閉

平臺(tái)異常11調(diào)用的服務(wù)不存在

-1調(diào)用服務(wù)失敗

398平臺(tái)內(nèi)部異常

399平臺(tái)其他異常

其他異常999其他異常

7

DB34/T4322—2022

附錄B

（資料性）

水利業(yè)務(wù)移動(dòng)端軟件開發(fā)文檔表

見表B.1。

表B.1水利業(yè)務(wù)移動(dòng)端軟件開發(fā)文檔資料參照表

序號(hào)文檔類型文檔名稱

1需求調(diào)研報(bào)告

需求文檔

2需求規(guī)格說明書

3系統(tǒng)總體設(shè)計(jì)方案

4系統(tǒng)詳細(xì)設(shè)計(jì)方案

5輸入、輸出設(shè)計(jì)方案

6開發(fā)文檔接口設(shè)計(jì)方案

7程序模塊說明書

8數(shù)據(jù)字典

9數(shù)據(jù)流程圖

10項(xiàng)目計(jì)劃書

項(xiàng)目管理文檔

11項(xiàng)目需求變更單

12實(shí)施詳細(xì)設(shè)計(jì)方案

13實(shí)施文檔項(xiàng)目實(shí)施計(jì)劃

14質(zhì)量保證計(jì)劃

15測(cè)試方案

16測(cè)試文檔測(cè)試用例

17測(cè)試報(bào)告

18管理員手冊(cè)

19用戶手冊(cè)

用戶手冊(cè)

20系統(tǒng)部署手冊(cè)

21日常運(yùn)維手冊(cè)

22培訓(xùn)手冊(cè)培訓(xùn)手冊(cè)

23試運(yùn)行計(jì)劃及方案

24試運(yùn)行文檔試運(yùn)行總結(jié)報(bào)告

25用戶試運(yùn)行總結(jié)報(bào)告

26項(xiàng)目驗(yàn)收方案

27驗(yàn)收文檔監(jiān)理文檔

28項(xiàng)目實(shí)施總結(jié)報(bào)告

8

DB34/T4322—2022

附錄C

（資料性）

水利業(yè)務(wù)移動(dòng)端軟件開發(fā)情況說明

見表C.1。

表C.1水利業(yè)務(wù)移動(dòng)端軟件開發(fā)情況說明表

系統(tǒng)名稱開發(fā)商

布設(shè)地點(diǎn)市縣機(jī)構(gòu)訪問地址

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

系統(tǒng)版本系統(tǒng)結(jié)構(gòu)

□HarmonyOS□其他

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

□是□否

1.系統(tǒng)統(tǒng)□Unix□其它要求

瀏覽器兼

概述運(yùn)行環(huán)境□IE□Chorme

容情況

版本兼容瀏覽器□火狐□Safari

□360□其它

開發(fā)語言代碼量

系統(tǒng)總體應(yīng)

用說明

開發(fā)方式□嵌入式開發(fā)□組件式開發(fā)□模塊式開發(fā)□其它

2.開發(fā)

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

方式系統(tǒng)架構(gòu)

□Structs2-Spring-Hibernate□其它

序號(hào)名稱版本備注

1

2

3.技術(shù)

3

應(yīng)用

4

5

…

功能綜述

是否可供外

序號(hào)功能名稱功能描述

部調(diào)用

1

2

4.系統(tǒng)

3

功能核心功能

4

5