tangweijie/fujian_water_biz_doc
1
0
Fork 0
Code Issues Pull Requests 12 Actions Packages Projects Releases 1 Wiki Activity

更新福建水务营收系统概要设计文档，重构系统数据流向图为分层横向布局，补充缺失子系统节点与连线，按层分组标注所有子系统，优化图表可读性并确保与正文架构描述一致，提升文档完整性和可实施性，符合甲方A级交付标准。

Browse Source
This commit is contained in:
tangweijie 2025-08-26 13:55:39 +08:00
parent 851542aadd
commit 851b1691d1
6 changed files with 211 additions and 110 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
output/新-概要设计说明书.docx
View File

Binary file not shown.

66
output/新-概要设计说明书_processed.md
View File

@ -467,7 +467,7 @@ CJKmainfont: "PingFang SC"
**图表 1**
![图表 1](temp_mermaid_新-概要设计说明书_38149/diagram_1.png)
![图表 1](temp_mermaid_新-概要设计说明书_96523/diagram_1.png)
#### 层级说明
@ -524,7 +524,7 @@ CJKmainfont: "PingFang SC"
**图表 2**
![图表 2](temp_mermaid_新-概要设计说明书_38149/diagram_2.png)
![图表 2](temp_mermaid_新-概要设计说明书_96523/diagram_2.png)
### 系统的物理架构设计
@ -536,7 +536,7 @@ CJKmainfont: "PingFang SC"
**图表 3**
![图表 3](temp_mermaid_新-概要设计说明书_38149/diagram_3.png)
![图表 3](temp_mermaid_新-概要设计说明书_96523/diagram_3.png)
#### 网络连接
@ -544,7 +544,7 @@ CJKmainfont: "PingFang SC"
**图表 4**
![图表 4](temp_mermaid_新-概要设计说明书_38149/diagram_4.png)
![图表 4](temp_mermaid_新-概要设计说明书_96523/diagram_4.png)
#### 硬件配置规格
@ -588,7 +588,7 @@ CJKmainfont: "PingFang SC"
**图表 5**
![图表 5](temp_mermaid_新-概要设计说明书_38149/diagram_5.png)
![图表 5](temp_mermaid_新-概要设计说明书_96523/diagram_5.png)
#### 容器化部署架构
@ -598,7 +598,7 @@ CJKmainfont: "PingFang SC"
**图表 6**
![图表 6](temp_mermaid_新-概要设计说明书_38149/diagram_6.png)
![图表 6](temp_mermaid_新-概要设计说明书_96523/diagram_6.png)
## 子系统定义
@ -625,7 +625,7 @@ CJKmainfont: "PingFang SC"
**图表 7**
![图表 7](temp_mermaid_新-概要设计说明书_38149/diagram_7.png)
![图表 7](temp_mermaid_新-概要设计说明书_96523/diagram_7.png)
#### 主要接口定义
@ -804,7 +804,7 @@ CJKmainfont: "PingFang SC"
**图表 8**
![图表 8](temp_mermaid_新-概要设计说明书_38149/diagram_8.png)
![图表 8](temp_mermaid_新-概要设计说明书_96523/diagram_8.png)
## 模块定义
@ -828,7 +828,7 @@ CJKmainfont: "PingFang SC"
**图表 9**
![图表 9](temp_mermaid_新-概要设计说明书_38149/diagram_9.png)
![图表 9](temp_mermaid_新-概要设计说明书_96523/diagram_9.png)
**功能群说明：**
@ -846,7 +846,7 @@ CJKmainfont: "PingFang SC"
**图表 10**
![图表 10](temp_mermaid_新-概要设计说明书_38149/diagram_10.png)
![图表 10](temp_mermaid_新-概要设计说明书_96523/diagram_10.png)
### 模块描述
@ -993,7 +993,7 @@ CJKmainfont: "PingFang SC"
**图表 11**
![图表 11](temp_mermaid_新-概要设计说明书_38149/diagram_11.png)
![图表 11](temp_mermaid_新-概要设计说明书_96523/diagram_11.png)
## 模块定义
@ -1045,7 +1045,7 @@ CJKmainfont: "PingFang SC"
**图表 12**
![图表 12](temp_mermaid_新-概要设计说明书_38149/diagram_12.png)
![图表 12](temp_mermaid_新-概要设计说明书_96523/diagram_12.png)
#### 模块群间协作关系
@ -1057,7 +1057,7 @@ CJKmainfont: "PingFang SC"
**图表 13**
![图表 13](temp_mermaid_新-概要设计说明书_38149/diagram_13.png)
![图表 13](temp_mermaid_新-概要设计说明书_96523/diagram_13.png)
### 模块描述
@ -1143,7 +1143,7 @@ CJKmainfont: "PingFang SC"
**图表 14**
![图表 14](temp_mermaid_新-概要设计说明书_38149/diagram_14.png)
![图表 14](temp_mermaid_新-概要设计说明书_96523/diagram_14.png)
**业务规则：**
@ -1190,7 +1190,7 @@ CJKmainfont: "PingFang SC"
**图表 15**
![图表 15](temp_mermaid_新-概要设计说明书_38149/diagram_15.png)
![图表 15](temp_mermaid_新-概要设计说明书_96523/diagram_15.png)
**业务规则：**
@ -1361,7 +1361,7 @@ CJKmainfont: "PingFang SC"
**图表 16**
![图表 16](temp_mermaid_新-概要设计说明书_38149/diagram_16.png)
![图表 16](temp_mermaid_新-概要设计说明书_96523/diagram_16.png)
## 模块定义
@ -1382,7 +1382,7 @@ CJKmainfont: "PingFang SC"
**图表 17**
![图表 17](temp_mermaid_新-概要设计说明书_38149/diagram_17.png)
![图表 17](temp_mermaid_新-概要设计说明书_96523/diagram_17.png)
### 模块描述
@ -1466,7 +1466,7 @@ CJKmainfont: "PingFang SC"
**图表 18**
![图表 18](temp_mermaid_新-概要设计说明书_38149/diagram_18.png)
![图表 18](temp_mermaid_新-概要设计说明书_96523/diagram_18.png)
## 模块定义
@ -1489,7 +1489,7 @@ CJKmainfont: "PingFang SC"
**图表 19**
![图表 19](temp_mermaid_新-概要设计说明书_38149/diagram_19.png)
![图表 19](temp_mermaid_新-概要设计说明书_96523/diagram_19.png)
### 模块描述
@ -1511,7 +1511,7 @@ CJKmainfont: "PingFang SC"
**图表 20**
![图表 20](temp_mermaid_新-概要设计说明书_38149/diagram_20.png)
![图表 20](temp_mermaid_新-概要设计说明书_96523/diagram_20.png)
#### 模块2: 信息查询服务
@ -1552,7 +1552,7 @@ CJKmainfont: "PingFang SC"
**图表 21**
![图表 21](temp_mermaid_新-概要设计说明书_38149/diagram_21.png)
![图表 21](temp_mermaid_新-概要设计说明书_96523/diagram_21.png)
#### 模块4: 电子发票服务
@ -1619,7 +1619,7 @@ CJKmainfont: "PingFang SC"
**图表 22**
![图表 22](temp_mermaid_新-概要设计说明书_38149/diagram_22.png)
![图表 22](temp_mermaid_新-概要设计说明书_96523/diagram_22.png)
## 关键技术特性
@ -1704,7 +1704,7 @@ CJKmainfont: "PingFang SC"
**图表 23**
![图表 23](temp_mermaid_新-概要设计说明书_38149/diagram_23.png)
![图表 23](temp_mermaid_新-概要设计说明书_96523/diagram_23.png)
### 模块定义
@ -1721,7 +1721,7 @@ CJKmainfont: "PingFang SC"
**图表 24**
![图表 24](temp_mermaid_新-概要设计说明书_38149/diagram_24.png)
![图表 24](temp_mermaid_新-概要设计说明书_96523/diagram_24.png)
### 模块描述
@ -1756,7 +1756,7 @@ CJKmainfont: "PingFang SC"
**图表 25**
![图表 25](temp_mermaid_新-概要设计说明书_38149/diagram_25.png)
![图表 25](temp_mermaid_新-概要设计说明书_96523/diagram_25.png)
### 模块定义
@ -1772,7 +1772,7 @@ CJKmainfont: "PingFang SC"
**图表 26**
![图表 26](temp_mermaid_新-概要设计说明书_38149/diagram_26.png)
![图表 26](temp_mermaid_新-概要设计说明书_96523/diagram_26.png)
### 模块描述
@ -1808,7 +1808,7 @@ CJKmainfont: "PingFang SC"
**图表 27**
![图表 27](temp_mermaid_新-概要设计说明书_38149/diagram_27.png)
![图表 27](temp_mermaid_新-概要设计说明书_96523/diagram_27.png)
### 模块定义
@ -1891,7 +1891,7 @@ graph TB
**图表 29**
![图表 29](temp_mermaid_新-概要设计说明书_38149/diagram_29.png)
![图表 29](temp_mermaid_新-概要设计说明书_96523/diagram_29.png)
### 模块描述
@ -1906,7 +1906,7 @@ graph TB
**图表 30**
![图表 30](temp_mermaid_新-概要设计说明书_38149/diagram_30.png)
![图表 30](temp_mermaid_新-概要设计说明书_96523/diagram_30.png)
### 模块描述
@ -1951,7 +1951,7 @@ graph TB
**图表 31**
![图表 31](temp_mermaid_新-概要设计说明书_38149/diagram_31.png)
![图表 31](temp_mermaid_新-概要设计说明书_96523/diagram_31.png)
## 模块定义
@ -1970,7 +1970,7 @@ graph TB
**图表 32**
![图表 32](temp_mermaid_新-概要设计说明书_38149/diagram_32.png)
![图表 32](temp_mermaid_新-概要设计说明书_96523/diagram_32.png)
### 模块描述
@ -2047,7 +2047,7 @@ graph TB
**图表 33**
![图表 33](temp_mermaid_新-概要设计说明书_38149/diagram_33.png)
![图表 33](temp_mermaid_新-概要设计说明书_96523/diagram_33.png)
## 模块定义
@ -2064,7 +2064,7 @@ graph TB
**图表 34**
![图表 34](temp_mermaid_新-概要设计说明书_38149/diagram_34.png)
![图表 34](temp_mermaid_新-概要设计说明书_96523/diagram_34.png)
### 模块描述

2
project_progress.md
View File

@ -27,6 +27,7 @@
| `新-数据库设计说明书.md` | ✅ 已完成 | 100% | A++级 | 2024-12-19 | 完整的PostgreSQL表结构，包含30个系统表+113个业务表的完整字段定义，ER图，索引设计，性能优化，覆盖营收系统全业务场景（新增60个遗漏表） |
| `新-详细设计说明书.md` | ✅ 已完成 | 100% | A+级 | 2024-12-19 | 符合302国家标准格式的详细设计文档，包含5个子系统的完整模块设计、接口规范、业务流程，总计1215行，可直接指导开发实施 |
| `新-概要设计说明书.md` | ✅ 已完成 | 100% | A+级 | 2025-08-22 | 架构调整：将工单、表务、报装从营收业务系统中剥离为独立子系统（SYS-005/006/007）；更新目录、功能范围、子系统列表、调用关系图、接口定义及相关章节，保留客户服务模块在营收业务系统内的作用。新增报装系统CA电子签章依赖（外部接口、架构图、方案说明）。 |
| 新-概要设计说明书-数据流向图修正 | ✅ 已完成 | 100% | A级 | 2025-08-25 | 重构“系统数据流向图”为分层横向布局（flowchart TB + 各层direction LR），保持上下分层清晰，同时允许直连线穿越其他模块；精简但保留关键链路（采集→接入→业务→存储→数据服务→展现），对齐正文架构与接口描述，图表可读性显著提升。 |
| 新增 | — | — | — | 2025-08-18 | 新增发票服务子系统（SYS-008）：作为基础服务层统一开票能力中心，优先对接航天信息，预留博思等供应商。 |
### 补充文档 (可选交付)
@ -131,6 +132,7 @@
| 2024-12-19 | 分离文档导出 | 修改unified_export.sh支持分离文档导出，创建manage_separated_docs.sh管理工具 | 用户需求：将每个文档分别导出为不同格式，而不是合并成一个大文档 | 正面影响，提供更灵活的文档导出选项 |
| 2025-08-22 | 文档更新 | 新-概要设计说明书：在报装业务系统（SYS-007）新增CA电子签章依赖；补充INST-004签章回执接口；更新子系统架构图与方案说明；在主要接口定义中同步新增报装签章回执接口 | 对齐集成依赖，完善报装环节签署合规流程 | 正面影响，接口与架构更完整，便于实施 |
| 2025-08-22 | 文档修复 | 修复微网厅子系统架构图Mermaid语法（中文节点引用导致Lexical error），将`Backend -.->|支付调用| 支付与结算（SYS-009）`改为`Backend -.->|支付调用| PAY_SYS[支付与结算（SYS-009）]` | 解决Mermaid解析错误，保证图表可渲染 | 正面影响，导出稳定性提升 |
| 2025-08-25 | 图表修正 | 新-概要设计说明书：系统数据流向图完善与纠偏（异步→业务层、缓存→D3、附件→D4、主从/备份链路、第三方接口指向修正） | 对齐正文技术描述与接口分布 | 正面影响，图文一致性与可实施性提升 |
| 2024-12-19 | 数据库设计简化 | 剔除数据库设计文档中的SQL语句和DDL语句，保留核心设计概念和表结构说明 | 用户要求：剔除SQL语句简化内容 | 正面影响，符合概要设计标准，提升可读性 |
| 2024-12-19 | 新增引言文档 | 创建water_biz_overview_design.md引言文档 | 用户需求：添加标准的第一章内容（编写目的、背景、定义、参考资料） | 正面影响，完善文档体系结构 |
| 2024-12-19 | 代码简化优化 | 删除文档中过于详细的代码示例，保持概要设计抽象层次 | 用户反馈：删除过多详细的代码 | 正面影响，符合概要设计标准，提升文档可读性 |

3
task_checklist.md
View File

@ -439,6 +439,9 @@
- [x] 添加数据采集层到数据展现层的完整流向图 ✅
- [x] 明确各层级间的数据传输关系 ✅
- [x] 优化数据处理流程设计 ✅
- [x] 2025-08-25：重构为分层横向布局（各层direction LR，线可穿越模块），精简但保留关键链路，提升可读性 ✅
- [x] 2025-08-25：补充缺失子系统节点与连线（SYS-001/006/007/008/009/010）✅
- [x] 2025-08-25：按层分组并标注子系统（SYS-001/002/003/004/005/006/007/008/009/010）✅
- [x] **补充OpenGauss分布式架构图** ✅ (2024-12-19)
- [x] 添加协调节点架构设计 ✅

166
新-概要设计说明书.md
View File

@ -595,87 +595,103 @@ graph TB
### 系统数据流向图
```mermaid
flowchart TD
subgraph "数据采集层"
A1[移动抄表APP<br/>数据采集]
A2[智能水表<br/>远程数据]
A3[Web管理端<br/>业务录入]
A4[微网厅<br/>用户数据]
A5[外部系统<br/>接口数据]
flowchart TB
%% 分层横向排布，垂直贯通，允许直连线穿越模块
subgraph L1["数据采集层"]
direction LR
A1[手机抄表APP]
A2[智能水表]
A3[管理后台]
A4[微网厅]
A5[外部系统]
end
subgraph "数据接入层"
B1[API网关<br/>数据验证]
B2[数据清洗<br/>格式转换]
B3[消息队列<br/>异步处理]
B4[数据缓存<br/>临时存储]
end
subgraph "业务处理层"
C1[抄表服务<br/>水量计算]
C2[收费服务<br/>账单生成]
C3[账务服务<br/>财务处理]
C4[工单服务<br/>流程处理]
C5[统计服务<br/>数据分析]
subgraph L2["接入层"]
direction LR
GW[API网关]
AUTH[统一平台SSO/SYS-001]
CLEAN[数据清洗]
MQ[消息队列]
CACHE_TMP[临时缓存]
end
subgraph "数据存储层"
D1[(达梦数据库主库<br/>核心业务数据)]
D2[(达梦数据库从库<br/>查询数据)]
D3[(Redis缓存<br/>热点数据)]
D4[文件存储<br/>附件图片]
D5[(备份库<br/>历史数据)]
subgraph L3["业务层"]
direction LR
REV[营收系统/SYS-002]
WO[工单系统/SYS-005]
METER[表务系统/SYS-006]
INST[报装系统/SYS-007]
INV[发票服务/SYS-008]
PAY[支付与结算/SYS-009]
MSG[消息服务/SYS-010]
end
subgraph "数据服务层"
E1[查询服务<br/>数据检索]
E2[报表服务<br/>统计分析]
E3[接口服务<br/>对外开放]
E4[推送服务<br/>消息通知]
subgraph L4["存储层"]
direction LR
DM_MASTER[达梦主库]
DM_SLAVE[达梦从库]
REDIS[Redis缓存]
MINIO[MinIO对象存储]
BACKUP[备份库]
end
subgraph "数据展现层"
F1[管理后台<br/>业务操作]
F2[统计大屏<br/>可视化展示]
F3[移动端<br/>现场作业]
F4[客户端<br/>自助服务]
F5[第三方系统<br/>数据集成]
subgraph L5["数据服务层"]
direction LR
QRY[查询服务]
RPT[报表服务]
API[接口服务]
PUSH[推送服务]
end
%% 数据流向关系
A1 -.->|数据采集<br/>格式验证| B1
A2 -.->|数据采集<br/>格式验证| B1
A3 -.->|数据采集<br/>格式验证| B1
A4 -.->|数据采集<br/>格式验证| B1
A5 -.->|数据采集<br/>格式验证| B1
B1 -.->|数据接入<br/>清洗转换| B2
B2 -.->|数据接入<br/>清洗转换| B3
B3 -.->|数据接入<br/>清洗转换| B4
B4 -.->|业务处理<br/>数据持久化| C1
B4 -.->|业务处理<br/>数据持久化| C2
B4 -.->|业务处理<br/>数据持久化| C3
B4 -.->|业务处理<br/>数据持久化| C4
B4 -.->|业务处理<br/>数据持久化| C5
C1 -.->|数据存储| D1
C2 -.->|数据存储| D1
C3 -.->|数据存储| D1
C4 -.->|数据存储| D1
C5 -.->|数据存储| D1
D1 -.->|数据查询<br/>统计分析| E1
D2 -.->|数据查询<br/>统计分析| E2
D3 -.->|数据查询<br/>统计分析| E3
D4 -.->|数据查询<br/>统计分析| E4
E1 -.->|数据服务<br/>接口调用| F1
E2 -.->|数据服务<br/>接口调用| F2
E3 -.->|数据服务<br/>接口调用| F3
E4 -.->|数据服务<br/>接口调用| F4
E1 -.->|数据服务<br/>接口调用| F5
subgraph L6["展现层"]
direction LR
F1[管理后台]
F2[统计大屏]
F3[移动端]
F4[微网厅]
F5[第三方系统]
end
%% 连接（精简且保持层间垂直分层，线可穿越模块）
A1 --> GW
A2 --> GW
A3 --> GW
A4 --> GW
A5 --> GW
%% 相邻层连线：采集层 → 接入层 已在上方；以下为 接入层 → 业务层
GW --> REV
GW --> WO
GW --> METER
GW --> INST
MQ --> REV
MQ --> WO
MQ --> METER
MQ --> INST
REV --> DM_MASTER
WO --> DM_MASTER
METER --> DM_MASTER
INST --> DM_MASTER
INV --> MINIO
MSG --> REDIS
%% 存储层内部链路省略，保持仅向下一层输出
DM_MASTER --> QRY
DM_MASTER --> RPT
DM_MASTER --> API
REDIS --> API
MINIO --> API
MSG --> PUSH
QRY --> F1
RPT --> F2
API --> F1
API --> F3
API --> F4
API --> F5
PUSH --> F3
PUSH --> F4
```
### 系统的物理架构设计

84
福建水务营收系统整体架构图.html
View File

@ -348,6 +348,18 @@
<div class="component-title">UP-002 系统管理模块</div>
<div class="component-desc">用户角色管理<br/>部门组织架构<br/>菜单权限配置</div>
</div>
<div class="component">
<div class="component-title">UP-003 权限控制模块</div>
<div class="component-desc">RBAC权限模型<br/>菜单权限<br/>数据权限</div>
</div>
<div class="component">
<div class="component-title">UP-004 租户管理模块</div>
<div class="component-desc">多租户数据隔离<br/>租户配置管理</div>
</div>
<div class="component">
<div class="component-title">UP-005 系统监控模块</div>
<div class="component-desc">在线用户<br/>性能监控<br/>操作日志</div>
</div>
</div>
</div>
@ -367,6 +379,70 @@
<div class="component-desc">账户绑定、信息查询、在线缴费、柜面扫码支付<br/>电子发票、营业网点、业务办理</div>
</div>
<div class="component">
<div class="component-title">REV-001 客户资料管理</div>
<div class="component-desc">客户档案<br/>分组管理<br/>信息变更</div>
</div>
<div class="component">
<div class="component-title">REV-002 抄表开账</div>
<div class="component-desc">抄表录入<br/>数据复核<br/>自动开账</div>
</div>
<div class="component">
<div class="component-title">REV-003 营业收费</div>
<div class="component-desc">柜台收费<br/>移动收费<br/>在线缴费</div>
</div>
<div class="component">
<div class="component-title">REV-004 账务处理</div>
<div class="component-desc">调账<br/>退款<br/>坏账处理</div>
</div>
<div class="component">
<div class="component-title">REV-005 发票管理</div>
<div class="component-desc">开票/查询/作废<br/>（经SYS-008）</div>
</div>
<div class="component">
<div class="component-title">REV-006 催缴管理</div>
<div class="component-desc">欠费统计<br/>催缴通知<br/>停水管理</div>
</div>
<div class="component">
<div class="component-title">REV-007 统计分析</div>
<div class="component-desc">多维统计<br/>报表分析</div>
</div>
<div class="component">
<div class="component-title">REV-008 代收业务</div>
<div class="component-desc">银行代扣<br/>聚合支付（经SYS-009）</div>
</div>
<div class="component">
<div class="component-title">REV-009 业务参数配置</div>
<div class="component-desc">水价体系<br/>水表参数<br/>基础配置</div>
</div>
<div class="component">
<div class="component-title">CS-001 账户绑定管理</div>
<div class="component-desc">微信/支付宝绑定<br/>解绑与多账户</div>
</div>
<div class="component">
<div class="component-title">CS-002 信息查询服务</div>
<div class="component-desc">账单/用水历史<br/>缴费记录/公告</div>
</div>
<div class="component">
<div class="component-title">CS-003 在线缴费服务</div>
<div class="component-desc">快捷缴费/充值/代缴<br/>（经SYS-009）</div>
</div>
<div class="component">
<div class="component-title">CS-004 电子发票服务</div>
<div class="component-desc">查看/推送/下载<br/>（经SYS-008）</div>
</div>
<div class="component">
<div class="component-title">CS-005 营业网点服务</div>
<div class="component-desc">网点查询<br/>地图导航/预约</div>
</div>
<div class="component">
<div class="component-title">CS-006 业务办理服务</div>
<div class="component-desc">联系方式/开票方式/更名过户<br/>低保/换表/自主抄表</div>
</div>
<div class="component">
<div class="component-title">CS-007 柜面扫码支付</div>
<div class="component-desc">二维码收款<br/>票据关联/结果回传（经SYS-009）</div>
</div>
</div>
</div>
@ -378,11 +454,11 @@
<div class="components">
<div class="component">
<div class="component-title">移动作业模块群</div>
<div class="component-desc">登录认证、首页搜索、采集任务管理<br/>现场抄表、数据同步</div>
<div class="component-desc">登录认证、首页搜索、采集任务管理<br/>现场抄表、数据同步（离线）</div>
</div>
<div class="component">
<div class="component-title">工单处理模块群</div>
<div class="component-desc">换表工单、复水工单、稽查工单<br/>问题上报、工单流转</div>
<div class="component-desc">换表工单、复水工单、稽查工单<br/>问题上报、工单接收/回填、工单流转</div>
</div>
<div class="component">
<div class="component-title">个人管理模块群</div>
@ -567,6 +643,10 @@
<div class="component-title">Redis缓存</div>
<div class="component-desc">Redis 6.0+<br/>热点数据缓存</div>
</div>
<div class="component">
<div class="component-title">MinIO对象存储</div>
<div class="component-desc">分布式对象存储<br/>附件/票据存证</div>
</div>
<div class="component">
<div class="component-title">备份存储</div>
<div class="component-desc">定期备份<br/>历史数据归档</div>