---
title: "福建水务营收系统概要设计文档"
author: "系统设计团队"
date: "2025年06月09日"
---


---

# 福建水务营收系统概要设计文档编写计划

## 一、项目背景与概述

福建水务营收系统是基于RuoYi-Vue-Pro和yudao-ui-admin-vue3框架开发的一套现代化水务营收管理系统，旨在满足原有系统的所有功能需求，并通过技术升级提升系统的性能、安全性和用户体验。

## 二、系统设计总体规划

### 1. 设计依据

- 原系统《营收系统_详细设计说明书》
- 原系统《营收系统_需求规格说明书》
- 原系统《营收系统_用户操作手册》
- RuoYi-Vue-Pro框架开发文档
- yudao-ui-admin-vue3框架开发文档

### 2. 设计原则

- **继承性原则**：确保新系统覆盖原有系统的所有功能
- **先进性原则**：采用当前主流技术架构和开发框架
- **扩展性原则**：设计良好的扩展接口，支持未来功能扩展
- **安全性原则**：符合国家相关安全规范，确保系统安全可靠
- **易用性原则**：优化用户界面，提升用户体验

## 三、编写工作步骤与时间规划

### 第一阶段：需求分析（2周）

1. **原系统功能梳理**
   - 研读原系统文档，提取核心功能点
   - 整理功能清单与功能描述
   - 确认需保留的功能与新增功能

2. **业务流程梳理**
   - 梳理现有业务流程
   - 设计优化后的业务流程图
   - 与业务部门确认流程优化点

### 第二阶段：系统架构设计（2周）

1. **技术架构设计**
   - 前端技术架构设计：基于yudao-ui-admin-vue3框架，使用Vue 3.x + TypeScript + Element Plus
   - 后端技术架构设计：基于RuoYi-Vue-Pro框架，使用Spring Boot 3.x + MyBatis Plus + Spring Security
   - 数据库架构设计：基于MySQL/MariaDB，配合MyBatis Plus实现高效数据访问
   - 集成方案设计：与支付系统、短信系统、工作流引擎等第三方服务集成

2. **系统功能模块划分**
   - 基于RuoYi-Vue-Pro的模块化设计：yudao-module-xxx形式组织代码
   - 采用前后端分离架构，定义清晰的API接口
   - 复用框架基础功能，包括权限管理、租户管理、系统管理等

### 第三阶段：详细设计（3周）

1. **系统功能模块详细设计**
   - 用户管理模块
   - 水表管理模块
   - 抄表管理模块
   - 收费管理模块
   - 账务管理模块
   - 票据管理模块
   - 营业网点管理模块
   - 报表管理模块
   - 系统管理模块

2. **数据库设计**
   - 实体关系图设计
   - 数据表结构设计
   - 数据字典编制

3. **接口设计**
   - 内部模块接口设计
   - 外部系统接口设计
   - API文档编制

### 第四阶段：非功能性设计（1周）

1. **性能设计**
   - 并发处理设计
   - 数据库优化设计
   - 缓存策略设计

2. **安全设计**
   - 用户认证与授权设计
   - 数据安全设计
   - 审计日志设计

3. **部署设计**
   - 系统部署架构
   - 服务器配置要求
   - 备份恢复方案

### 第五阶段：文档整合与评审（2周）

1. **文档整合**
   - 汇总各模块设计文档
   - 统一文档格式与风格
   - 完善文档引用与附录

2. **文档评审**
   - 内部技术评审
   - 与业务部门确认
   - 根据反馈修改文档

## 四、人员分工建议

对于多人协作编写文档，建议按照以下方式进行分工：

### 1. 按模块分工

- **架构师**：负责系统总体架构设计、技术选型、非功能性设计
- **业务分析师**：负责需求分析、业务流程梳理、功能规划
- **前端设计师**：负责前端架构设计、UI/UX设计、前端模块设计
- **后端开发负责人**：负责后端架构设计、核心模块设计、安全设计
- **数据库设计师**：负责数据库设计、数据模型设计、性能优化设计

### 2. 按系统功能分工

- **基础模块组**：负责用户管理、权限管理、系统管理等基础功能设计
- **业务核心组**：负责水表管理、抄表管理、收费管理等核心业务功能设计
- **财务模块组**：负责账务管理、票据管理等财务相关功能设计
- **报表分析组**：负责报表管理、数据分析等统计分析功能设计
- **集成对接组**：负责与外部系统的接口设计、数据同步设计

## 五、文档规范与模板

### 1. 文档格式规范

- 使用Markdown格式编写
- 章节层级不超过4级
- 图表统一使用PlantUML或Mermaid格式
- 术语表达保持一致性

### 2. 设计文档模板

每个功能模块的设计文档应包含以下内容：

```markdown
# [模块名称]设计说明

## 1. 功能概述
[简要描述该模块的主要功能和目标]

## 2. 功能列表
[列出该模块包含的所有功能点]

## 3. 业务流程
[使用流程图描述主要业务流程]

## 4. 数据模型
[描述该模块涉及的主要数据实体及关系]

## 5. 接口设计
[描述该模块提供的接口，包括参数、返回值等]

## 6. 界面设计
[提供界面原型或描述，说明界面交互逻辑]

## 7. 安全考虑
[描述该模块的安全控制措施]

## 8. 特殊说明
[其他需要说明的事项]
```

## 六、Cursor Rules配置

为了使用Cursor更高效地完成概要设计文档，建议配置以下规则：

1. **文档结构检查**：确保文档结构符合预定义的模板
2. **术语一致性检查**：确保整个文档中术语使用的一致性
3. **图表格式化**：自动格式化PlantUML或Mermaid图表代码
4. **引用链接检查**：确保文档内的交叉引用有效
5. **中文标点规范**：确保使用规范的中文标点符号

## 七、协作工具与流程

1. **版本控制**：使用Git进行文档版本控制
2. **协作平台**：使用GitLab/GitHub进行协作
3. **评审工具**：使用MR/PR进行文档评审
4. **任务管理**：使用项目管理工具（如JIRA）跟踪文档编写进度

## 八、成果交付物

最终交付物应包括：

1. 系统概要设计说明书（主文档）
2. 各功能模块详细设计说明
3. 数据库设计说明书
4. 接口设计说明书
5. 部署运维设计说明书 
---

# 福建水务营收系统概要设计文档总结

## 一、文档构成

福建水务营收系统概要设计文档包含以下几个主要部分：

1. **设计计划文档**：描述文档编写计划、分工和规范
2. **系统架构设计**：描述系统总体架构和技术选型
3. **模块功能设计**：描述各功能模块的详细设计
4. **数据库设计**：描述数据库结构和优化策略
5. **接口设计**：描述系统内部和外部接口设计
6. **部署运维设计**：描述系统部署架构和运维方案

## 二、主要内容概述

### 1. 设计计划文档

设计计划文档明确了概要设计文档的编写计划、时间规划、人员分工和文档规范，为后续设计工作提供了指导框架。主要内容包括：

- 项目背景与概述
- 系统设计总体规划
- 编写工作步骤与时间规划
- 人员分工建议
- 文档规范与模板
- Cursor Rules配置
- 协作工具与流程
- 成果交付物

### 2. 系统架构设计

系统架构设计描述了福建水务营收系统的总体架构、技术框架和实现方案，为系统开发提供了技术指导。主要内容包括：

- 系统架构概述
- 总体架构设计
- 系统分层设计
- 核心模块设计
- 数据库设计
- 接口设计
- 安全设计
- 高可用设计
- 扩展性设计
- 部署架构

### 3. 模块功能设计

模块功能设计详细描述了系统各个功能模块的设计，包括功能需求、业务流程、实现方式等。主要内容包括：

- 用户管理模块
- 水表管理模块
- 抄表管理模块
- 收费管理模块
- 账务管理模块
- 票据管理模块
- 营业网点管理模块
- 报表管理模块
- 系统管理模块
- 集成接口模块

### 4. 数据库设计

数据库设计描述了系统的数据模型、表结构和数据库优化策略，为数据存储和管理提供了技术方案。主要内容包括：

- 数据库设计概述
- 数据库架构设计
- 数据模型设计
- 数据库表结构设计
- 数据库优化设计
- 数据库安全设计
- 数据备份与恢复
- 数据库监控与维护

### 5. 接口设计

接口设计描述了系统内部模块间的接口和与外部系统的集成接口，为系统集成提供了技术方案。主要内容包括：

- 接口设计概述
- 接口设计原则
- 内部模块接口
- 外部系统接口
- 接口安全设计
- 接口测试策略
- 接口文档管理

### 6. 部署运维设计

部署运维设计描述了系统的部署架构、运维方案和灾备策略，为系统运行维护提供了技术支持。主要内容包括：

- 部署架构设计
- 软件部署方案
- 容器化部署方案
- 系统运维方案
- 持续集成与部署
- 灾备方案
- 运维工具链
- 运维管理规范

## 三、编写建议

### 1. 编写前的准备

- **充分理解原系统**：详细阅读原有系统的需求和设计文档，理解系统功能和业务流程
- **熟悉技术框架**：深入了解RuoYi-Vue-Pro和yudao-ui-admin-vue3框架的功能和架构
  - 学习RuoYi-Vue-Pro的核心模块结构与扩展机制
  - 掌握基于MyBatis Plus的数据访问层设计
  - 理解Spring Security的认证授权体系
  - 熟悉多租户的实现原理
  - 学习Vue 3和Element Plus组件库的使用
  - 了解前端路由和状态管理机制
- **明确编写范围**：根据项目实际需求，确定概要设计文档的详细程度和范围
- **收集参考资料**：收集相关技术资料、业界最佳实践和类似系统的设计文档作为参考

### 2. 编写过程中的注意事项

- **保持一致性**：确保文档风格、术语使用和格式保持一致
- **关注重点**：重点描述系统架构、核心模块和关键技术方案
- **图文结合**：使用图表辅助说明，提高文档可读性
- **适当详细**：在关键部分提供足够详细的说明，确保开发人员能够理解设计意图
- **考虑全面**：除功能需求外，也要考虑非功能性需求，如性能、安全、可靠性等
- **保持更新**：随着设计的深入，及时更新文档内容

### 3. 多人协作编写策略

- **明确分工**：按模块或专业领域划分编写任务，明确每人负责的部分
- **统一模板**：使用统一的文档模板和编写规范
- **定期评审**：定期组织文档评审会议，确保文档质量和一致性
- **版本控制**：使用Git等工具进行文档版本控制，跟踪文档变更
- **集中整合**：指定专人负责整合各部分文档，确保文档的完整性和一致性

### 4. 编写工具使用建议

- **使用Markdown**：采用Markdown格式编写文档，便于版本控制和协作
- **使用Cursor**：利用Cursor的智能提示和规则检查功能，提高编写效率
- **使用PlantUML/Mermaid**：使用PlantUML或Mermaid绘制架构图、流程图等
- **使用Git**：使用Git进行文档版本控制和协作管理
- **使用自动化工具**：使用自动化工具检查文档格式、拼写和一致性

## 四、后续工作建议

### 1. 文档评审与完善

- 组织技术评审会议，邀请架构师、技术负责人和关键开发人员参与
- 收集评审意见，针对性地修改和完善文档
- 进行文档质量检查，确保文档的完整性、准确性和一致性

### 2. 详细设计与开发

- 基于概要设计文档，进行详细设计，包括具体的类设计、算法设计等
- 按照设计文档指导开发工作，确保实现与设计保持一致
- 在开发过程中，根据实际情况适当调整设计，并更新文档

### 3. 文档维护与更新

- 建立文档变更管理机制，记录文档变更历史
- 根据系统演进情况，定期更新设计文档
- 将设计文档与代码库关联，确保文档与代码的一致性

## 五、常见问题与解决方案

### 1. 文档过于庞大，难以管理

- 采用模块化的文档结构，将文档分为多个独立的部分
- 建立文档索引，便于查找和导航
- 使用自动化工具生成目录和交叉引用

### 2. 文档与实际实现不一致

- 建立设计与开发的反馈机制，及时发现并解决不一致问题
- 在开发过程中，同步更新设计文档
- 定期进行文档审核，确保与实际实现保持一致

### 3. 多人协作导致风格不一致

- 制定统一的文档编写规范和模板
- 使用Cursor Rules自动检查文档风格和格式
- 指定专人负责文档的最终审核和整合

### 4. 文档内容难以理解

- 增加图表和示例，提高文档可读性
- 采用简洁明了的语言，避免晦涩难懂的技术术语
- 对关键概念和术语提供清晰的定义和解释

# 福建水务业务系统概述

## 目录
- [1. 系统背景](#1-系统背景)
- [2. 系统目标](#2-系统目标)
- [3. 系统范围](#3-系统范围)
- [4. 系统用户](#4-系统用户)
- [5. 系统特点](#5-系统特点)
- [6. 系统价值](#6-系统价值)

## 1. 系统背景

福建水投集团注册资本46亿元，经营范围为水利项目投资及管理，水利工程建筑设计与施工及相关技术服务；水资源开发与利用，水的生产与供应、污水处理及其再生利用，水生态产业投资、运营及相关配套服务；水利设施周边配套土地等资源综合开发利用等。

在全省40多个县市区投资重大水利项目超过450亿元，实现全省全覆盖，大幅控制我省岛屿、沿海经济发达以及经济发展潜力大、后劲足的地区水资源、水务市场。目前，集团公司总资产超173亿元，净资产超70亿元，拥有全级次子公司超过67家，职工人数超3500人。

当前，福建水投集团针对营收、新装、表务等核心业务系统，在集团下属各水务公司中，在用的业务系统均来自不同的系统集成商，存在业务不统一、软件功能不完善、自动化数据处理水平低、升级维护工作量大、自建硬件环境导致运营成本过高等弊端，加上由于业务、数据过度分散，不利于集团化的集中管理、统一资源管理理念。

随着互联网技术的飞速发展，以及市场竞争日益激烈的今天，集中企业优势、发展企业已成社会共识。通过应用系统集中部署，可以在此基础上实现先进的集团化管理理念。目前集团已经搭建起私有云，需要在信息系统建设方面，统一构建SaaS模式服务平台，服务于集团、各分公司、营业网点，以便于实现集中式生产控制、集中式财务控制、集中物资管理、公司领导对下属各水务公司的集中管理和综合报表上报、分析的功能。

## 2. 系统目标

福建水务业务系统是以客户关系数据库为核心和基础的综合管理平台，包含客户完整的资料和数据，实现客户全生命周期管理。系统建设的主要目标包括：

1. **统一资源服务**：在集团现有基础上，建设统一的数字水务系统运行资源环境，为集团下属各分公司提供日常业务的IT运营环境服务。

2. **统一平台应用**：根据业务需要，在集团所属分公司在用的营收、新装、表务系统基础上进行全面改造升级，统一业务，集中汇集数据，形成统一、多租户管理模式的营业收费系统。集团所属各分公司不再独立建设业务系统基础设施和开发应用系统，实现"一个业务平台、一网通平台"的建设目标。

3. **统一业务平台功能**：建设平台具备集团、分公司、分公司所属业务站点多租户管理模式，实现对用水客户的营收业务、新装业务、表务业务管理功能；各租户之间独立，数据统一汇总到集团数据中心。

4. **统一对外接口**：整合统一用户资源，与相关业务系统对接提供标准的接口和能力。

5. **统一对外服务**：统一对外服务标准，为百姓提供便民服务，做到从"群众跑路"到"数据跑腿"的转变，简化百姓办事流程、提高办事效率、提升百姓的获得感，塑造良好的企业形象。

通过系统的建设，实现福建省水投数字科技有限公司客户服务管理领域的业务流程梳理再造、组织架构的优化、管理制度的建设、绩效考核标准的建设。构建以客户为中心的客户服务平台，将客户的所有信息进行有机的关联，方便企业对客户信息进行综合分析和管理，为客户提供更多、更便捷、更主动的个性化服务，提高客户服务的质量和客户满意度。

## 3. 系统范围

福建水务业务系统的功能范围涵盖客户服务全生命周期，主要包括以下功能模块：

1. **统一平台**：员工管理、权限管理、组织机构、系统菜单配置、角色配置、水表厂家、水表型号、水表量程等。

2. **营收系统**：
   - 价格管理：调价、历史价格查询
   - 用户档案管理：客户信息、表卡信息、账户信息、联系人信息、更名过户、注销报停
   - 抄表开账：册本管理、新卡入册、册本调动、抄表录入、抄表数据审核、追加抄表
   - 收费管理：柜台收费、柜台结账、预付款管理、凭证收费、结账记录查询、缴费记录查询
   - 账务处理：未销调整、违约金减免、特殊开账、账务退款、销账调正、预付款退款、违约金退款、待处理管理、账务处理日志查询
   - 发票管理：库存管理、发票打印、发票查询、发票调整
   - 综合查询：用户综合查询、报表查询、欠费查询

3. **表务系统**：
   - 表务工单：换表计划、换表工单、移表工单、拆表工单、复装工单、校表工单
   - 表务仓库：新表入库、水表领用、水表出库、水表退库、水表生命周期查询

4. **报装系统**：
   - 报装立户：一户一表
   - 报装流程管理

5. **客户服务**：
   - 微信、支付宝服务窗
   - 历史账单查询
   - 电子发票
   - 营业网点查询
   - 账户流水查询
   - 微网厅

6. **外部接口**：
   - 银行接口
   - 支付宝/微信接口
   - 短信接口
   - 系统对外查询接口

## 4. 系统用户

福建水务业务系统的用户主要包括以下几类：

1. **集团管理人员**：负责对全集团业务数据进行统计分析、监督管理。

2. **分公司管理人员**：负责分公司业务管理、数据统计分析。

3. **营业网点工作人员**：负责日常营业收费、客户服务等工作。

4. **抄表员**：负责水表抄读、录入等工作。

5. **表务人员**：负责水表安装、更换、维修等工作。

6. **报装人员**：负责新用户报装、立户等工作。

7. **系统管理员**：负责系统参数配置、用户权限管理等工作。

8. **最终用户**：通过微信、支付宝服务窗、微网厅等渠道使用系统服务的水务客户。

## 5. 系统特点

福建水务业务系统具有以下特点：

1. **多租户架构**：支持集团、分公司、营业站点多层级租户管理模式，各租户数据相互隔离，同时数据可统一汇总到集团数据中心。

2. **一体化设计**：将营收、表务、报装等业务系统集成为一体，实现业务流程的无缝衔接。

3. **全渠道服务**：支持营业厅柜台、自助终端、移动APP、微信小程序、支付宝服务窗等多种服务渠道。

4. **智能化应用**：引入智能抄表、智能分析等功能，提高业务处理效率和准确性。

5. **标准化接口**：提供标准化的接口，支持与银行、支付平台、短信平台等外部系统的集成。

6. **安全可靠**：系统满足安全等保三级要求，确保系统和数据的安全性。

7. **高性能扩展**：系统支持100万客户规模，满足企业未来3-5年的业务发展需求。

## 6. 系统价值

福建水务业务系统的建设将为企业带来以下价值：

1. **降低IT成本**：通过统一平台建设，减少重复投资，降低硬件采购、系统运维等成本。

2. **提高管理效率**：实现业务流程优化再造，提高业务处理效率，降低人力成本。

3. **增强数据价值**：实现数据的集中管理和统一分析，为管理决策提供有力支持。

4. **提升服务质量**：为客户提供便捷、多渠道的服务方式，提高客户满意度。

5. **支持业务创新**：为业务创新提供灵活的技术支持，增强企业市场竞争力。

6. **促进企业发展**：支持企业规模扩张，为福建水投集团打造成水利行业龙头企业提供信息化支撑。 
---

# 福建水务业务系统架构设计

## 目录
- [1. 系统架构概述](#1-系统架构概述)
- [2. 技术架构](#2-技术架构)
- [3. 应用架构](#3-应用架构)
- [4. 数据架构](#4-数据架构)
- [5. 安全架构](#5-安全架构)
- [6. 部署架构](#6-部署架构)
- [7. 接口架构](#7-接口架构)

## 1. 系统架构概述

福建水务业务系统采用多层架构设计，旨在支持集团化的集中管理、统一资源管理的业务需求。系统架构的设计目标是实现"一个业务平台、一网通平台"的建设目标，为集团及下属各分公司提供统一的营业收费系统。

系统架构主要包括以下核心特点：
- 多租户架构：支持集团、分公司、营业站点的多层级租户管理模式
- 统一资源服务：统一的数字水务系统运行资源环境
- 统一平台应用：统一业务流程，集中汇集数据
- 统一对外接口：提供标准的接口和能力

### 1.1 系统架构图

系统整体架构如下图所示：

![系统架构图](images/architecture_diagram.png)


## 2. 技术架构

系统采用B/S和M/S相结合的架构模式，具体技术栈如下：

### 2.1 服务端
- 操作系统：国产 Linux 操作系统
- 数据库：MySQL/MariaDB数据库，支持国产OpenGauss数据库
- 应用框架：基于RuoYi-Vue-Pro框架定制开发
  - 核心框架：Spring Boot 3.x，支持JDK 17/21
  - ORM框架：MyBatis Plus，增强的MyBatis
  - 权限框架：Spring Security，基于RBAC的权限管理
  - 数据缓存：Redis + Redisson，高性能缓存和分布式锁
  - 工作流引擎：Flowable，灵活的工作流处理
  - 任务调度：基于Quartz的CRON任务调度
  - 服务监控：Spring Boot Admin、SkyWalking APM
  - 消息队列：基于Redis的轻量级消息队列
  - 文档生成：Knife4j，基于Swagger的API文档生成
  - 代码生成：自动化CRUD和表单代码生成器
  - 多租户：基于字段隔离的SaaS多租户设计

### 2.2 客户端
- 前端框架：基于yudao-ui-admin-vue3框架定制开发
  - 核心框架：Vue 3.x + TypeScript
  - 组件库：Element Plus，现代化UI组件
  - 状态管理：Pinia，新一代的Vue状态管理库
  - 路由管理：Vue Router
  - HTTP工具：Axios，请求拦截与统一处理
  - CSS框架：Tailwind CSS / UnoCSS，原子化CSS
  - 图表组件：ECharts，强大的可视化图表库
  - 富文本编辑器：WangEditor
  - 文件上传：基于Element Plus的上传组件
  - 权限控制：细粒度的按钮级权限控制
  - 动态表格：支持拖拽、排序、筛选
  - 代码规范：ESLint + Prettier，标准化代码风格
- 移动端：
  - 核心框架：uni-app（跨平台）
  - 组件库：uview-ui
  - 小程序支持：微信小程序、支付宝小程序等
  - 移动端地图：高德地图SDK（用于抄表轨迹和导航）
  - 设备接入：NFC、扫码、相机等硬件设备接口

### 2.3 技术特性
- 单点登录：OAuth2 + JWT实现统一认证
- 数据交换：基于RESTful API的系统内部数据交换与共享
- 统一报表平台：集成JimuReport，支持自定义报表设计与生成
- 大屏设计：集成GoView，支持可视化大屏设计
- 安全保障：满足安全等保三级要求
  - 密码加密：BCrypt加密算法
  - 防XSS攻击：表单数据过滤
  - 防SQL注入：参数化查询
  - 防CSRF攻击：Token验证
- 性能规格：支持200并发用户，50并发移动设备，系统响应时间不超过3秒
- 扩展容量：支持100万客户的业务量，满足企业3-5年的业务发展需求
- 支持功能：
  - 支付管理：微信支付、支付宝支付等
  - 短信服务：阿里云、腾讯云等多家短信服务商
  - AI能力：
    - 智能抄表：基于图像识别的水表读数
    - 异常分析：基于AI的用水异常分析
  - API网关：支持API权限管理、限流熔断、白名单控制

## 3. 应用架构

系统应用架构基于业务域划分，主要包括以下核心应用模块：

### 3.1 统一平台
- 单点登录：统一认证入口，支持多种登录方式
- 系统管理：组织机构、员工管理、角色权限管理、菜单配置等
- 流程节点提醒：工作流节点到期和状态变更提醒

### 3.2 营收系统
- 系统管理：水价管理、用户档案管理、更名过户管理等
- 抄表开账：册本管理、抄表录入、复核开账等
- 收费管理：柜台收费、特殊开账、柜台结账、批量缴费等
- 账务处理：预存调整、未销调整、已销调整、分账调整等
- 发票管理：发票查询、发票开具、电子发票等
- 代收业务：实时收费、银行代扣、银行托收等
- 环卫系统：计费核定、计费退补、计费减免等
- 业务工单：业务清单、上报清单、稽查工单、移表工单等

### 3.3 客户服务
- 微信、支付宝服务窗：账户绑定、用水查询、在线缴费等
- 历史账单：账单查询、用水分析、账单推送等
- 电子发票：发票申请、发票查询、发票下载等
- 营业网点：网点查询、网点导航、业务指南等
- 账户流水：流水查询、明细下载、交易统计等
- 微网厅：用户注册、信息查询、业务办理等

### 3.4 表务系统
- 表务工单：换表工单、移表工单、拆表工单、复装工单等
- 表务仓库：新表入库、水表检定、水表领用、水表出库等
- 水表参数与基础信息：水表厂家管理、水表型号管理等
- 物联网对接与数据同步：厂家设备信息管理、远程抄表数据同步等

### 3.5 报装管理
- 报装流程：报装申请、方案设计、合同签订、施工管理等
- 一户一表管理：改造计划、改造实施、用户转换等

### 3.6 统计分析
- 报表查询：标准报表、自定义报表、报表导出打印等
- 欠费查询：欠费情况统计、欠费用户明细、欠费分析等
- 缴费记录：缴费情况统计、缴费明细查询、缴费趋势分析等
- 用水分析：用水量统计、用水趋势分析、异常用水分析等

### 3.7 工程管理
- 工程申请：工程立项、材料提交、前期勘察等
- 工程施工：施工计划、施工派工、施工记录等
- 工程验收：验收申请、验收检查、验收记录等
- 工程查询：工程进度查询、工程资料查询、工程统计等

### 3.8 抄表APP
- 首页功能：首页展示、个人信息、快捷查询等
- 抄表功能：抄表任务、NFC抄表、扫码抄表、AI录入等
- 工单管理：问题上报、问题回填、代办工单、稽查工单等

### 3.9 接口服务
- API市场：API展示、API使用说明、API测试等
- API管理：API申请、API调度看板、接口服务配置管理等
- 接口权限管理：授权管理、白名单管理、安全策略等
- 系统对外接口：查询接口、业务处理接口、状态同步接口等

### 3.10 系统配置
- 水表参数：水表厂家、水表型号、水表量程等
- 地址参数：行政区划、地址编码、地址库等
- 价格体系：用水性质、水价标准、阶梯水价等
- 基本配置：系统参数、业务规则、打印模板等
- 催缴管理：催缴计划、催缴任务、催缴执行等
- 用户权限：菜单权限、功能权限、数据权限等
- 定时任务：任务配置、任务监控、任务日志等

## 4. 数据架构

系统数据架构基于客户关系数据库为核心和基础，实现客户全生命周期管理。

### 4.1 数据分层
- 数据采集层：负责从各业务系统和物联网设备采集原始数据
- 数据存储层：统一数据存储，实现分布式数据管理
- 数据服务层：提供数据服务接口
- 数据展现层：提供数据分析和可视化功能

### 4.2 数据模型
- 客户信息模型：包含客户基础信息、表卡信息、账户信息、联系人信息等
- 业务数据模型：抄表数据、收费数据、账务数据、发票数据等
- 工单数据模型：表务工单、报装工单、业务工单等
- 配置数据模型：系统参数、水表参数、价格体系等
- 报表数据模型：统计数据、分析数据、预测数据等
- 物联网数据模型：设备信息、状态信息、实时数据等

### 4.3 数据集成与共享
- 统一数据标准：定义统一的数据标准和数据字典
- 数据集成机制：采用ESB实现系统间的数据集成
- 数据共享机制：基于统一的数据服务接口实现数据共享
- 数据同步策略：实时同步、定时同步、批量同步等

## 5. 安全架构

系统安全架构满足等保三级要求，主要包括以下安全措施：

### 5.1 网络安全
- 边界防护：防火墙、入侵检测/防御系统
- 访问控制：基于角色的访问控制
- 通信安全：SSL/TLS加密传输
- 安全监控：实时监控网络安全状态

### 5.2 数据安全
- 数据加密：敏感数据加密存储
- 数据备份：定期数据备份和恢复机制
- 数据审计：关键操作的审计日志
- 数据脱敏：敏感数据的显示脱敏和处理脱敏
- 数据权限：基于多租户的数据隔离和访问控制

### 5.3 应用安全
- 身份认证：多因素认证
- 授权管理：细粒度的权限控制
- 安全审计：用户操作审计
- 密码策略：密码复杂度、定期更换、失败锁定等
- 会话管理：会话超时、并发限制等

### 5.4 接口安全
- 接口认证：基于Token的接口认证
- 接口授权：基于角色的接口授权
- 接口加密：敏感数据的加密传输
- 接口防护：防重放、防篡改等安全措施
- 接口限流：基于IP、用户、应用的限流策略

## 6. 部署架构

系统采用集中部署的模式，基于集团私有云环境进行部署。

### 6.1 物理部署
- 生产环境：高可用集群部署
  - 应用服务器：2台或以上服务器，负载均衡
  - 数据库服务器：主从架构，实时同步
  - 缓存服务器：Redis集群
  - 文件服务器：冗余存储
- 灾备环境：异地灾备，定期数据同步
- 测试环境：用于系统测试和验证
- 开发环境：用于系统开发和集成测试

### 6.2 逻辑部署
- 应用服务器集群：负责业务逻辑处理
- 数据库服务器集群：负责数据存储和管理
- 文件服务器：负责文档和附件存储
- 缓存服务器：提高系统性能
- 负载均衡服务器：实现请求分发和负载均衡
- 移动应用服务：提供移动端API服务
- API网关：统一的接口管理和控制

### 6.3 容器部署
- 基于Docker容器技术实现微服务部署
- 使用Kubernetes进行容器编排和管理
- 支持容器的自动扩缩容和故障转移
- 实现服务的灰度发布和版本控制

## 7. 接口架构

系统提供标准化的接口，实现与外部系统的集成和数据交换。

### 7.1 外部接口
- 银行接口：实现与银行系统的对接，支持代扣、托收等功能
- 支付宝/微信接口：支持在线支付功能
- 短信接口：支持短信通知和验证码功能
- 集抄系统接口：实现与智能水表集中抄表系统的对接
- 政务系统接口：实现与地方政务平台和政务APP的对接
- 消火栓系统接口：实现与消火栓系统的对接
- 环卫系统接口：实现与环卫系统的对接
- OA系统接口：实现与OA系统的工作流对接

### 7.2 内部接口
- ESB服务接口：系统内部模块间的数据交换
- 报表接口：提供报表数据查询和生成功能
- 查询接口：提供数据查询功能
- 业务处理接口：提供业务处理功能
- 消息通知接口：提供消息推送和通知功能
- 工作流接口：提供工作流处理和状态查询功能

### 7.3 接口标准
- 接口协议：RESTful API、WebService、消息队列等
- 数据格式：JSON、XML等
- 接口安全：身份认证、授权、加密传输等
- 接口文档：统一的接口文档和示例代码
- 接口测试：提供接口测试工具和环境

### 7.4 接口服务管理
- API网关：统一的接口入口和管理
- 服务注册与发现：服务的自动注册和发现
- 服务路由：根据请求参数进行服务路由
- 服务降级：在服务不可用时提供降级策略
- 服务监控：实时监控服务的可用性和性能 
---

# 福建水务业务系统概要设计

## 目录
- [福建水务业务系统概要设计](#福建水务业务系统概要设计)
  - [目录](#目录)
  - [1. 统一平台](#1-统一平台)
    - [1.1 单点登录](#11-单点登录)
    - [1.2 系统管理](#12-系统管理)
  - [2. 营收系统](#2-营收系统)
    - [2.1 系统管理](#21-系统管理)
    - [2.2 抄表开账](#22-抄表开账)
    - [2.3 收费管理](#23-收费管理)
    - [2.4 账务处理](#24-账务处理)
    - [2.5 发票管理](#25-发票管理)
    - [2.6 代收业务](#26-代收业务)
    - [2.7 环卫系统](#27-环卫系统)
    - [2.8 业务工单](#28-业务工单)
  - [3. 表务系统](#3-表务系统)
    - [3.1 表务工单](#31-表务工单)
    - [3.2 表务仓库](#32-表务仓库)
    - [3.3 水表参数与基础信息](#33-水表参数与基础信息)
    - [3.4 物联网对接与数据同步](#34-物联网对接与数据同步)
  - [4. 报装系统](#4-报装系统)
    - [4.1 报装流程](#41-报装流程)
    - [4.2 一户一表管理](#42-一户一表管理)
  - [5. 客户服务](#5-客户服务)
    - [5.1 微信、支付宝服务窗](#51-微信支付宝服务窗)
    - [5.2 历史账单](#52-历史账单)
    - [5.3 电子发票](#53-电子发票)
    - [5.4 营业网点](#54-营业网点)
    - [5.5 账户流水](#55-账户流水)
    - [5.6 微网厅](#56-微网厅)
  - [6. 系统配置](#6-系统配置)
    - [6.1 水表参数](#61-水表参数)
    - [6.2 地址参数](#62-地址参数)
    - [6.3 价格体系](#63-价格体系)
    - [6.4 基本配置](#64-基本配置)
    - [6.5 催缴管理](#65-催缴管理)
    - [6.6 用户权限](#66-用户权限)
    - [6.7 定时任务](#67-定时任务)
  - [7. 系统接口](#7-系统接口)
    - [7.1 银行接口](#71-银行接口)
    - [7.2 支付宝/微信接口](#72-支付宝微信接口)
    - [7.3 短信接口](#73-短信接口)
    - [7.4 集抄系统接口](#74-集抄系统接口)
    - [7.5 政务系统接口](#75-政务系统接口)
    - [7.6 消火栓系统接口](#76-消火栓系统接口)
    - [7.7 其他系统对接](#77-其他系统对接)
  - [8. 统计分析](#8-统计分析)
    - [8.1 报表查询](#81-报表查询)
    - [8.2 欠费查询](#82-欠费查询)
    - [8.3 缴费记录](#83-缴费记录)
    - [8.4 用水分析](#84-用水分析)
  - [9. 工程管理](#9-工程管理)
    - [9.1 工程申请](#91-工程申请)
    - [9.2 工程施工](#92-工程施工)
    - [9.3 工程验收](#93-工程验收)
    - [9.4 工程查询](#94-工程查询)
  - [10. 抄表APP](#10-抄表app)
    - [10.1 首页功能](#101-首页功能)
    - [10.2 抄表功能](#102-抄表功能)
    - [10.3 工单管理](#103-工单管理)
  - [11. 接口服务](#11-接口服务)
    - [11.1 API市场](#111-api市场)
    - [11.2 API管理](#112-api管理)
    - [11.3 接口权限管理](#113-接口权限管理)
    - [11.4 系统对外接口](#114-系统对外接口)

## 1. 统一平台

统一平台是客户服务平台的综合展示平台，基于RuoYi-Vue-Pro和yudao-ui-admin-vue3框架构建，包含日常工作功能和客户全部的信息，是系统的基础功能模块。

### 1.1 单点登录

单点登录模块基于Spring Security和JWT实现用户一次登录即可访问系统中所有应用的功能，主要特点包括：

- 支持通过用户名、密码进行身份认证
- 支持OAuth2.0授权码+PKCE模式的第三方登录
- 支持手机号+短信验证码登录方式
- 支持多因素认证（MFA）增强安全性
- 根据登录人员所在公司的不同，显示不同的系统名称和界面风格
- 提供流程节点到期提醒功能
- Token自动刷新机制，提升用户体验

### 1.2 系统管理

系统管理模块基于RuoYi-Vue-Pro框架的现成功能，提供对系统基础参数的配置管理功能，主要包括：

- 组织机构管理：
  - 支持多级组织结构的管理
  - 支持组织机构导入导出
  - 组织关系树形展示
  - 组织数据权限控制
- 员工管理：
  - 系统操作人员的基本信息管理
  - 用户分配角色与权限
  - 用户状态管理（启用/禁用）
  - 用户密码安全策略
  - 用户操作日志记录
- 角色权限管理：
  - 基于RBAC模型的权限控制
  - 支持数据权限精细化控制
  - 支持多租户的权限隔离
  - 基于菜单、按钮级别的权限管理
- 系统菜单配置：
  - 支持自定义系统菜单和功能模块
  - 菜单多级分类管理
  - 动态路由生成
  - 菜单权限配置
- 数据字典管理：
  - 维护系统使用的各类基础代码数据
  - 支持字典项多级管理
  - 支持字典缓存，提高访问性能
- 系统监控：
  - 在线用户监控与管理
  - 服务器性能监控
  - 定时任务执行状态监控
  - 系统缓存监控与管理
- 系统日志管理：
  - 记录用户登录日志
  - 记录操作日志，支持操作回溯
  - 记录系统异常日志，便于问题排查
- 短信管理：
  - 支持阿里云、腾讯云等多家短信渠道
  - 短信模板配置管理
  - 短信发送日志记录
- 租户管理：
  - 支持SaaS多租户
  - 租户套餐配置
  - 租户数据隔离
  - 租户资源管理
- 配置管理：
  - 系统参数配置
  - 通知公告管理
  - 定时任务配置

## 2. 营收系统

营收系统是水务业务系统的核心组成部分，负责抄表、收费、账务处理等关键业务功能。

### 2.1 系统管理

营收系统的基础管理功能，包括：

- 水价管理：不同用户类型的水价标准管理，支持阶梯水价
- 用户档案管理：维护用户基本信息、用水信息、账户信息等
  - 客户分组管理
  - 集收管理
  - 客户基础信息管理
  - 定额管理
  - 客户优惠方案设置
- 更名过户管理：处理用户变更、过户等业务
- 注销报停管理：处理用户注销、暂停用水等业务

### 2.2 抄表开账

抄表开账模块负责水表读数的采集和账单生成，主要功能包括：

- 册本管理：册本基本信息的维护和管理
- 抄表录入：支持手工抄表、智能抄表、自报抄表
- 抄表数据审核：数据校验、异常处理、开账处理
- 追加抄表：支持非周期性特殊抄表

### 2.3 收费管理

收费管理模块负责水费的收取和管理，主要功能包括：

- 柜台收费：用户查询、收费处理、收费打印、预存预付
- 柜台结账：日结、交款、结账查询
- 预付款管理：预付款充值、使用和退款
- 缴费记录查询：支持多条件查询缴费记录

### 2.4 账务处理

账务处理模块负责处理各类特殊账务情况，主要功能包括：

- 未销调整：水量调整、金额调整、违约金减免等
- 特殊开账：特殊情况下的账单生成
- 账务退款：多缴费退款、预付款退款等
- 销账调正：对已缴费账单进行调整处理
- 预存调整：预存余额调整、预存转账等
- 账务处理日志：记录所有账务处理操作

### 2.5 发票管理

发票管理模块负责水费发票的管理，主要功能包括：

- 库存管理：发票入库、领用、作废
- 发票打印：普通发票和电子发票
- 发票查询：发票信息查询和统计
- 发票调整：发票重开、补开

### 2.6 代收业务

代收业务模块负责处理各种渠道的水费代收业务，主要功能包括：

- 实时收费：银行代收、支付宝/微信收费、代收点收费
- 银行代扣：代扣协议管理、代扣数据生成和处理
- 银行托收：托收单生成、托收数据处理
- 代扣渠道管理：渠道维护、规则设置、效率分析

### 2.7 环卫系统

环卫系统模块负责管理与环卫相关的收费和计费业务，主要功能包括：

- 计费核定：环卫收费规则配置和业务字典维护
- 计费退补：退费和补缴规则配置，字典配置参与计算
- 计费减免：环卫费用减免规则配置和审批流程
- 环卫收费统计：环卫收费数据统计和分析

### 2.8 业务工单

业务工单模块负责管理日常业务工单的流转和处理，主要功能包括：

- 业务清单：查询通过系统办理的日常业务工单及进度信息
- 上报清单：新增、查询问题清单，包括通过手机端上报的问题
- 稽查工单：对手机端的稽查信息进行多条件查询和导出
- 移表工单：客户对需要进行移动的水表进行登记
- 换表工单：新增客户自报的换表和故障的水表等进行换表登记
- 工作流可视化：工作节点可视化展示和流程管理

## 3. 表务系统

表务系统负责水表的全生命周期管理，包括水表购置、安装、维修、更换等业务。

### 3.1 表务工单

表务工单模块负责处理各类表务作业，主要功能包括：

- 换表工单：换表计划、换表施工、换表回填
- 移表工单：移表申请、移表施工、移表验收
- 拆表工单：拆表申请、拆表施工、拆表确认
- 复装工单：复装申请、复装施工、复装验收
- 校表工单：校表申请、校表实施、校表结果
- 稽查工单：水量异常稽查、违规用水稽查、处罚决定
- 业务上报：异常上报、投诉上报、处理结果反馈

### 3.2 表务仓库

表务仓库模块负责水表的仓储管理，主要功能包括：

- 新表入库：水表检定、入库登记、入库确认
- 水表检定：检定信息记录、结果管理
- 水表领用：领用单登记、领用单管理
- 水表出库：出库登记、出库确认
- 水表退库：退库申请、退库确认
- 水表报废：报废申请、报废确认
- 水表生命周期查询：状态查询、历史记录查询

### 3.3 水表参数与基础信息

水表参数与基础信息模块负责维护水表相关的基础数据，主要功能包括：

- 水表厂家管理：厂家信息维护、厂家状态管理
- 水表型号管理：型号信息维护、型号分类管理
- 水表口径管理：口径信息维护、定换周期设置
- 水表量程管理：量程信息维护、量程范围设置

### 3.4 物联网对接与数据同步

物联网对接与数据同步模块负责水表数据的互联互通，主要功能包括：

- 厂家设备信息管理：设备型号管理、厂家信息维护
- 表务对接日志：数据同步日志、错误处理
- 水表数据推送接口：新表数据推送、校验机制
- 远程抄表数据同步：数据接收、验证与处理
- 物联网水表监控：状态监控、异常事件报警

## 4. 报装系统

报装系统负责新用户的报装立户管理，主要功能包括：

### 4.1 报装流程

报装流程模块负责新用户报装业务的全流程管理，主要功能包括：

- 报装申请：用户申请、材料审核、现场勘查
- 方案设计：设计方案、设计审核、费用估算
- 合同签订：费用通知、合同签订、收费管理
- 施工管理：施工计划、施工实施、施工验收
- 开户通水：水表安装、用户立户、通水确认

### 4.2 一户一表管理

一户一表管理模块负责实施"一户一表"改造，主要功能包括：

- 改造计划：制定改造计划、用户协商、费用估算
- 改造实施：施工管理、水表安装、验收管理
- 用户转换：数据转换、账务处理、使用确认

## 5. 客户服务

客户服务模块提供多渠道的客户服务功能，主要包括：

### 5.1 微信、支付宝服务窗

- 账户绑定：支持用户绑定水务账户
- 用水查询：查询用水情况和用水趋势
- 水费查询：查询水费信息和欠费信息
- 在线缴费：支持在线缴纳水费
- 业务办理：支持在线办理简单业务

### 5.2 历史账单

- 账单查询：查询历史账单信息
- 用水分析：分析用水趋势，提供图表展示
- 账单推送：定期推送账单信息
- 账单明细：提供详细的账单明细

### 5.3 电子发票

- 发票申请：申请开具电子发票
- 发票查询：查询已开具发票
- 发票下载：下载电子发票
- 发票推送：推送电子发票到用户邮箱或微信

### 5.4 营业网点

- 网点查询：查询营业网点信息
- 网点导航：提供到营业网点的导航
- 业务指南：提供各网点业务办理指南
- 等候情况：实时显示各网点的等候情况

### 5.5 账户流水

- 流水查询：查询账户交易流水
- 明细下载：下载流水明细
- 交易统计：提供交易金额统计
- 缴费证明：生成缴费证明

### 5.6 微网厅

- 用户注册：用户注册微网厅账号
- 信息查询：查询用水、缴费信息
- 业务办理：在线办理各类业务
- 用户反馈：提交意见建议


## 6. 系统配置

系统配置模块提供各类系统参数的配置管理功能，主要包括：

### 6.1 水表参数

- 水表厂家：管理水表生产厂商信息
- 水表型号：管理水表型号规格
- 水表量程：管理水表量程规格

### 6.2 地址参数

- 行政区划：管理行政区划信息
- 地址编码：管理地址编码规则
- 地址库：维护标准地址库

### 6.3 价格体系

- 用水性质：管理不同用水性质的分类
- 水价标准：管理不同用水性质的水价标准
- 阶梯水价：管理阶梯水价设置
- 调价管理：管理水价调整流程

### 6.4 基本配置

- 系统参数：管理系统基本参数
- 业务规则：管理业务处理规则
- 打印模板：管理各类打印模板
- 短信模板：管理短信发送模板 

### 6.5 催缴管理

- 催缴计划：制定欠费催缴计划
- 催缴任务：分配催缴任务
- 催缴执行：记录催缴执行情况
- 催缴结果：统计催缴结果

### 6.6 用户权限

- 菜单权限：不同角色可访问的菜单权限配置
- 功能权限：不同角色可操作的功能权限配置
- 数据权限：通过查询字典权限控制不同用户业务取数权限
- 角色管理：自定义角色及权限组合

### 6.7 定时任务

- 任务配置：定时任务可视化配置，包含传参设置
- 任务监控：定时任务执行状态监控
- 任务日志：定时任务执行日志记录和查询
- 任务调度：任务优先级和执行顺序管理

## 7. 系统接口

系统接口模块提供与外部系统的集成和数据交换功能，实现业务数据的互通互联。

### 7.1 银行接口

银行接口实现与银行系统的对接，支持代扣、托收等功能，主要包括：

- 收费接口：实现用户通过银行渠道缴纳水费
- 冲正接口：处理银行退款和交易取消
- 对账接口：与银行系统进行对账
- 托收接口：支持银行托收功能
- 代扣接口：支持银行代扣功能

### 7.2 支付宝/微信接口

支付宝和微信接口实现与第三方支付平台的对接，支持在线支付功能，主要包括：

- 欠费查询：查询用户欠费信息
- 在线支付：支持用户在线缴纳水费
- 支付通知：处理支付结果通知
- 对账接口：与支付平台进行对账

### 7.3 短信接口

短信接口提供短信通知和验证功能，主要包括：

- 账单通知：通过短信通知用户账单信息
- 缴费提醒：提醒用户及时缴费
- 催缴通知：向欠费用户发送催缴短信
- 业务通知：通知用户业务办理状态
- 验证码功能：提供短信验证码服务

### 7.4 集抄系统接口

集抄系统接口实现与智能水表集中抄表系统的对接，主要包括：

- 抄表数据获取：获取智能水表的抄表数据
- 水表状态监控：监控水表的使用状态
- 异常数据处理：处理抄表异常情况

### 7.5 政务系统接口

政务系统接口实现与地方政务平台和政务APP的对接，主要包括：

- 数据推送：推送营收数据到政务平台
- 数据查询：支持政务平台查询水务数据
- 缴费对接：支持通过政务平台缴费
- 报装工单对接：对接报装业务工单

### 7.6 消火栓系统接口

消火栓系统接口实现与消火栓系统的对接，主要功能包括：

- 预存缴费管理：管理用户预存水费
- 剩余水量计算：计算用户剩余可用水量
- 取水控制：根据预存和剩余水量控制取水

### 7.7 其他系统对接

其他系统对接模块负责与周边系统进行数据交换和业务协同，主要功能包括：

- 环卫系统对接：实现与环卫系统的数据同步和业务流程对接
- 客服系统对接：实现与客服系统的工单同步和问题处理
- 工单系统对接：实现与工单系统的工单流转和状态同步
- OA系统对接：实现与OA系统的审批流程对接和数据共享
- 智水擎平台对接：实现与智水擎平台的数据交换和业务协同

## 8. 统计分析

统计分析模块提供多维度的数据统计和分析功能，为管理决策提供数据支持。

### 8.1 报表查询

- 标准报表：系统内置的标准统计报表
- 自定义报表：用户可自定义的报表
- 报表导出：支持将报表导出为Excel、PDF等格式
- 报表打印：支持报表打印功能

### 8.2 欠费查询

- 欠费情况统计：按区域、用户类型等维度统计欠费情况
- 欠费用户明细：查询欠费用户的详细信息
- 欠费分析：分析欠费原因和趋势
- 欠费导出：支持将欠费数据导出

### 8.3 缴费记录

- 缴费情况统计：按多维度统计缴费情况
- 缴费明细查询：查询缴费明细记录
- 缴费趋势分析：分析缴费趋势
- 缴费渠道分析：分析各缴费渠道的使用情况

### 8.4 用水分析

- 用水量统计：按多维度统计用水量
- 用水趋势分析：分析用水趋势，预测用水需求
- 异常用水分析：识别和分析异常用水情况
- 节水潜力分析：分析用户节水潜力

## 9. 工程管理

工程管理模块负责处理与供水工程相关的业务，包括工程申请、施工管理和工程验收等。

### 9.1 工程申请

- 工程立项：新建供水工程的立项申请
- 材料提交：上传工程相关材料
- 前期勘察：记录工程前期勘察结果
- 工程预算：制定工程预算方案
- 申请审批：对工程申请进行审批

### 9.2 工程施工

- 施工计划：制定工程施工计划
- 施工派工：将施工任务分配给施工人员
- 施工记录：记录施工过程和施工情况
- 材料管理：管理工程施工材料的使用情况
- 施工异常处理：处理施工过程中的异常情况

### 9.3 工程验收

- 验收申请：提交工程验收申请
- 验收检查：对工程进行验收检查
- 验收记录：记录验收结果
- 竣工结算：进行工程竣工结算
- 工程归档：对工程资料进行归档

### 9.4 工程查询

- 工程进度查询：查询工程进度情况
- 工程资料查询：查询工程相关资料
- 工程统计：统计工程数量、金额等信息
- 工程分析：分析工程实施情况

## 10. 抄表APP

抄表APP是针对移动端开发的抄表工具，支持外勤人员进行现场抄表、问题处理和工单管理等业务操作。

### 10.1 首页功能

- 首页：显示当前登录用户信息、快捷搜索和主要和抄表业务相关的功能模块
- 个人信息：查看个人信息，可以进行密码、手机号信息修改，可以进行抄表设置
- 快捷查询：提供搜索栏，用户输入户号、户名、地址以及册本后，系统会自动检索到相关的信息

### 10.2 抄表功能

- 抄表任务：显示当前登录的抄表员抄表任务信息
- NFC抄表：抄表设备感应NFC后自动弹出抄表页
- 扫码抄表：扫水表上二维码，搜集该表信息，弹出抄表页
- 数据采集：抄表数据现场采集功能
- AI录入：对接AI接口实现智能读数
- 抄表轨迹：记录表的物理位置，在地图上点击后采集水表定位
- 抄表导航：指引抄表员前往下一个抄表点
- 抄表汇总：系统会根据当前登录的人员自动汇总抄表信息
- 账单查询：查询客户账单详情
- 欠费查询：显示当前登录的抄表员抄表用水客户的欠费情况

### 10.3 工单管理

- 问题上报：系统支持上报当前登录的抄表员抄表时遇到的用水问题
- 问题回填：问题上报后，可进行问题回填和处理
- 代办工单：显示当前登录的抄表员需要代办工单
- 平台工单管理：移动端提交工单后，系统会自动提交到工单处置平台进行受理、派发
- 停水复水工单：当客户存在欠费的情况下可以对该客户进行停水操作
- 稽查工单：实现抄表稽查和水价稽查
- 维修工单：提交坏表维修报修等工单

## 11. 接口服务

接口服务模块提供系统对外的API接口管理和服务能力，实现与第三方系统的便捷集成。

### 11.1 API市场

- API展示：展示系统提供的各类API接口
- API使用说明：提供API接口的详细使用说明和示例
- API测试：提供API接口的在线测试功能

### 11.2 API管理

- API申请：第三方系统申请调用API的流程管理
- API调度看板：监控API调用情况和性能指标
- 接口服务配置管理：管理API接口的配置参数
- 接口限流熔断管理：控制API接口的调用频率和熔断机制

### 11.3 接口权限管理

- 授权管理：管理API接口的授权信息
- 白名单管理：设置允许访问API的IP白名单
- 安全策略：设置API调用的安全策略和防护措施

### 11.4 系统对外接口

- 查询接口：提供各类数据查询接口
- 业务处理接口：提供业务处理和操作接口
- 状态同步接口：提供状态信息同步接口
- 数据推送接口：提供数据推送和订阅接口
---

# 福建水务业务系统数据库设计

## 目录
- [1. 数据库设计概述](#1-数据库设计概述)
- [2. 数据库架构](#2-数据库架构)
- [3. 主要数据实体](#3-主要数据实体)
- [4. 表结构设计](#4-表结构设计)
- [5. 索引设计](#5-索引设计)
- [6. 数据安全性设计](#6-数据安全性设计)

## 1. 数据库设计概述

福建水务业务系统的数据库设计基于MySQL/MariaDB数据库管理系统（同时支持国产OpenGauss数据库），采用关系型数据库模型，以支持业务系统的高并发、高可靠性需求。数据库设计遵循标准化、安全性、扩展性和性能优化的原则，为业务系统提供稳定、高效的数据存储和访问支持。

### 1.1 设计目标

- 支持系统功能需求，满足业务处理的数据需求
- 优化数据库性能，支持高并发访问
- 确保数据安全性，防止数据泄露和丢失
- 支持系统横向扩展，适应业务增长需求
- 支持多租户架构，实现数据隔离

### 1.2 设计原则

- **规范化设计**：遵循数据库设计的第三范式，减少数据冗余
- **适度冗余**：对于常用查询，适度保留冗余字段，提高查询效率
- **模块化**：按业务模块划分表组，便于维护和扩展
- **安全性**：设计完善的权限控制和数据加密方案
- **可扩展性**：预留扩展字段，支持业务功能的扩展
- **通用字段**：遵循RuoYi-Vue-Pro框架规范，统一基础字段定义

## 2. 数据库架构

### 2.1 总体架构

系统采用集中式数据库架构，主要包含以下组件：

- **主数据库**：MySQL/MariaDB主从架构，存储核心业务数据，支持事务处理
- **报表数据库**：存储统计分析数据，支持复杂查询和报表生成
- **历史数据库**：存储历史业务数据，减轻主数据库负担
- **缓存系统**：使用Redis作为缓存数据库，缓存热点数据，提高访问效率

### 2.2 多租户设计

系统采用基于字段的方式实现多租户架构，主要包括：

- **共享数据库，共享模式**：所有租户共享同一数据库实例和表结构
- **租户标识列**：在每个表中增加tenant_id租户标识列，实现数据隔离
- **多租户拦截器**：基于MyBatis Plus的多租户拦截器，自动为SQL添加租户条件
- **权限控制**：通过数据权限控制租户对数据的访问

### 2.3 数据访问层设计

系统基于MyBatis Plus框架实现数据访问层，主要特点包括：

- **通用CRUD**：利用MyBatis Plus提供的BaseMapper，简化基础CRUD操作
- **分页查询**：使用MyBatis Plus的分页插件，实现高性能分页
- **条件构造器**：使用LambdaQueryWrapper/LambdaUpdateWrapper构建动态SQL
- **自动填充**：通过MetaObjectHandler自动填充创建时间、更新时间等字段
- **乐观锁**：支持通过版本号实现乐观锁控制
- **数据权限**：通过自定义拦截器实现数据权限过滤
- **多租户**：基于TenantLineInnerInterceptor实现多租户数据隔离

### 2.4 通用字段设计

系统中所有业务表都包含以下通用字段：

| 字段名 | 数据类型 | 长度 | 是否为空 | 描述 |
|-------|---------|------|---------|-----|
| id | BIGINT | - | 否 | 主键ID |
| creator | VARCHAR | 64 | 是 | 创建者 |
| create_time | DATETIME | - | 否 | 创建时间 |
| updater | VARCHAR | 64 | 是 | 更新者 |
| update_time | DATETIME | - | 是 | 更新时间 |
| deleted | TINYINT | 1 | 否 | 是否删除(0正常,1删除) |
| tenant_id | BIGINT | - | 否 | 租户ID |
| version | INT | - | 是 | 乐观锁版本号 |

## 3. 主要数据实体

系统主要包含以下核心数据实体：

### 3.1 客户实体

- **客户基本信息**：存储客户的基本资料
- **表卡信息**：存储水表基本信息和安装位置
- **账户信息**：存储客户账户信息和余额
- **联系人信息**：存储客户联系人信息

### 3.2 营收实体

- **抄表记录**：存储水表抄读记录
- **账单信息**：存储客户水费账单
- **缴费记录**：存储客户缴费记录
- **调价记录**：存储水价调整记录

### 3.3 表务实体

- **水表档案**：存储水表的完整信息和生命周期
- **表务工单**：存储表务作业工单信息
- **仓库信息**：存储水表仓库信息
- **出入库记录**：存储水表出入库记录

### 3.4 报装实体

- **报装申请**：存储新用户报装申请信息
- **报装工单**：存储报装作业工单信息
- **施工记录**：存储报装施工记录
- **验收记录**：存储报装验收记录

### 3.5 系统管理实体

- **组织机构**：存储系统组织机构信息
- **用户信息**：存储系统用户信息
- **角色权限**：存储系统角色和权限信息
- **系统日志**：存储系统操作日志

## 4. 表结构设计

以下是系统主要表结构设计，按业务模块划分：

### 4.1 客户管理相关表

#### 4.1.1 客户基本信息表(TB_CUSTOMER)

| 字段名 | 数据类型 | 长度 | 是否为空 | 主键 | 描述 |
|-------|---------|------|---------|-----|------|
| CUSTOMER_ID | VARCHAR | 20 | 否 | 是 | 客户编号，主键 |
| TENANT_ID | VARCHAR | 20 | 否 | 否 | 租户标识 |
| CUSTOMER_NAME | VARCHAR | 100 | 否 | 否 | 客户名称 |
| CUSTOMER_TYPE | VARCHAR | 10 | 否 | 否 | 客户类型 |
| ID_TYPE | VARCHAR | 10 | 是 | 否 | 证件类型 |
| ID_NUMBER | VARCHAR | 30 | 是 | 否 | 证件号码 |
| PHONE | VARCHAR | 20 | 是 | 否 | 联系电话 |
| ADDRESS | VARCHAR | 200 | 是 | 否 | 地址 |
| AREA_CODE | VARCHAR | 20 | 是 | 否 | 行政区划代码 |
| CREATE_TIME | DATETIME | - | 否 | 否 | 创建时间 |
| UPDATE_TIME | DATETIME | - | 是 | 否 | 更新时间 |
| STATUS | VARCHAR | 10 | 否 | 否 | 状态 |

#### 4.1.2 表卡信息表(TB_METER_INFO)

| 字段名 | 数据类型 | 长度 | 是否为空 | 主键 | 描述 |
|-------|---------|------|---------|-----|------|
| METER_ID | VARCHAR | 20 | 否 | 是 | 水表编号，主键 |
| CUSTOMER_ID | VARCHAR | 20 | 否 | 否 | 客户编号，外键 |
| TENANT_ID | VARCHAR | 20 | 否 | 否 | 租户标识 |
| METER_NO | VARCHAR | 30 | 否 | 否 | 水表号 |
| METER_TYPE | VARCHAR | 10 | 否 | 否 | 水表类型 |
| METER_MODEL | VARCHAR | 20 | 是 | 否 | 水表型号 |
| METER_CALIBER | VARCHAR | 10 | 是 | 否 | 水表口径 |
| INSTALL_DATE | DATE | - | 是 | 否 | 安装日期 |
| INSTALL_POSITION | VARCHAR | 200 | 是 | 否 | 安装位置 |
| INITIAL_READING | DECIMAL | 10,2 | 否 | 否 | 初始读数 |
| CURRENT_READING | DECIMAL | 10,2 | 否 | 否 | 当前读数 |
| READING_CYCLE | VARCHAR | 10 | 否 | 否 | 抄表周期 |
| BOOK_ID | VARCHAR | 20 | 是 | 否 | 册本编号 |
| STATUS | VARCHAR | 10 | 否 | 否 | 状态 |
| CREATE_TIME | DATETIME | - | 否 | 否 | 创建时间 |
| UPDATE_TIME | DATETIME | - | 是 | 否 | 更新时间 |

#### 4.1.3 账户信息表(TB_ACCOUNT)

| 字段名 | 数据类型 | 长度 | 是否为空 | 主键 | 描述 |
|-------|---------|------|---------|-----|------|
| ACCOUNT_ID | VARCHAR | 20 | 否 | 是 | 账户编号，主键 |
| CUSTOMER_ID | VARCHAR | 20 | 否 | 否 | 客户编号，外键 |
| TENANT_ID | VARCHAR | 20 | 否 | 否 | 租户标识 |
| BALANCE | DECIMAL | 12,2 | 否 | 否 | 账户余额 |
| CREDIT_AMOUNT | DECIMAL | 12,2 | 是 | 否 | 信用额度 |
| LAST_PAYMENT_DATE | DATE | - | 是 | 否 | 最近缴费日期 |
| STATUS | VARCHAR | 10 | 否 | 否 | 状态 |
| CREATE_TIME | DATETIME | - | 否 | 否 | 创建时间 |
| UPDATE_TIME | DATETIME | - | 是 | 否 | 更新时间 |

### 4.2 营收管理相关表

#### 4.2.1 抄表记录表(TB_METER_READING)

| 字段名 | 数据类型 | 长度 | 是否为空 | 主键 | 描述 |
|-------|---------|------|---------|-----|------|
| READING_ID | VARCHAR | 20 | 否 | 是 | 抄表记录编号，主键 |
| METER_ID | VARCHAR | 20 | 否 | 否 | 水表编号，外键 |
| TENANT_ID | VARCHAR | 20 | 否 | 否 | 租户标识 |
| READING_DATE | DATE | - | 否 | 否 | 抄表日期 |
| READING_VALUE | DECIMAL | 10,2 | 否 | 否 | 抄表读数 |
| PREV_READING_VALUE | DECIMAL | 10,2 | 是 | 否 | 上次读数 |
| WATER_USAGE | DECIMAL | 10,2 | 否 | 否 | 用水量 |
| READING_TYPE | VARCHAR | 10 | 否 | 否 | 抄表类型(人工/远传/自报) |
| READER_ID | VARCHAR | 20 | 是 | 否 | 抄表员编号 |
| STATUS | VARCHAR | 10 | 否 | 否 | 状态 |
| REMARK | VARCHAR | 200 | 是 | 否 | 备注 |
| CREATE_TIME | DATETIME | - | 否 | 否 | 创建时间 |
| UPDATE_TIME | DATETIME | - | 是 | 否 | 更新时间 |

#### 4.2.2 账单信息表(TB_BILL)

| 字段名 | 数据类型 | 长度 | 是否为空 | 主键 | 描述 |
|-------|---------|------|---------|-----|------|
| BILL_ID | VARCHAR | 20 | 否 | 是 | 账单编号，主键 |
| CUSTOMER_ID | VARCHAR | 20 | 否 | 否 | 客户编号，外键 |
| METER_ID | VARCHAR | 20 | 否 | 否 | 水表编号，外键 |
| READING_ID | VARCHAR | 20 | 是 | 否 | 抄表记录编号，外键 |
| TENANT_ID | VARCHAR | 20 | 否 | 否 | 租户标识 |
| BILL_MONTH | VARCHAR | 7 | 否 | 否 | 账期(格式:YYYY-MM) |
| WATER_USAGE | DECIMAL | 10,2 | 否 | 否 | 用水量 |
| WATER_FEE | DECIMAL | 10,2 | 否 | 否 | 水费金额 |
| OTHER_FEE | DECIMAL | 10,2 | 是 | 否 | 其他费用 |
| TOTAL_AMOUNT | DECIMAL | 10,2 | 否 | 否 | 总金额 |
| DUE_DATE | DATE | - | 否 | 否 | 缴费截止日期 |
| STATUS | VARCHAR | 10 | 否 | 否 | 状态 |
| CREATE_TIME | DATETIME | - | 否 | 否 | 创建时间 |
| UPDATE_TIME | DATETIME | - | 是 | 否 | 更新时间 |

#### 4.2.3 缴费记录表(TB_PAYMENT)

| 字段名 | 数据类型 | 长度 | 是否为空 | 主键 | 描述 |
|-------|---------|------|---------|-----|------|
| PAYMENT_ID | VARCHAR | 20 | 否 | 是 | 缴费记录编号，主键 |
| BILL_ID | VARCHAR | 20 | 是 | 否 | 账单编号，外键 |
| CUSTOMER_ID | VARCHAR | 20 | 否 | 否 | 客户编号，外键 |
| TENANT_ID | VARCHAR | 20 | 否 | 否 | 租户标识 |
| PAYMENT_TYPE | VARCHAR | 10 | 否 | 否 | 缴费类型 |
| PAYMENT_CHANNEL | VARCHAR | 10 | 否 | 否 | 缴费渠道 |
| PAYMENT_AMOUNT | DECIMAL | 10,2 | 否 | 否 | 缴费金额 |
| PAYMENT_DATE | DATETIME | - | 否 | 否 | 缴费时间 |
| TRANSACTION_NO | VARCHAR | 30 | 是 | 否 | 交易流水号 |
| OPERATOR_ID | VARCHAR | 20 | 是 | 否 | 操作员编号 |
| STATUS | VARCHAR | 10 | 否 | 否 | 状态 |
| REMARK | VARCHAR | 200 | 是 | 否 | 备注 |
| CREATE_TIME | DATETIME | - | 否 | 否 | 创建时间 |
| UPDATE_TIME | DATETIME | - | 是 | 否 | 更新时间 |

### 4.3 表务管理相关表

#### 4.3.1 水表档案表(TB_METER_ARCHIVE)

| 字段名 | 数据类型 | 长度 | 是否为空 | 主键 | 描述 |
|-------|---------|------|---------|-----|------|
| METER_ARCHIVE_ID | VARCHAR | 20 | 否 | 是 | 水表档案编号，主键 |
| METER_ID | VARCHAR | 20 | 否 | 否 | 水表编号，外键 |
| TENANT_ID | VARCHAR | 20 | 否 | 否 | 租户标识 |
| FACTORY | VARCHAR | 50 | 是 | 否 | 生产厂家 |
| PRODUCTION_DATE | DATE | - | 是 | 否 | 生产日期 |
| VALID_PERIOD | INT | - | 是 | 否 | 有效期(月) |
| VERIFICATION_DATE | DATE | - | 是 | 否 | 检定日期 |
| NEXT_VERIFICATION_DATE | DATE | - | 是 | 否 | 下次检定日期 |
| STATUS | VARCHAR | 10 | 否 | 否 | 状态 |
| CREATE_TIME | DATETIME | - | 否 | 否 | 创建时间 |
| UPDATE_TIME | DATETIME | - | 是 | 否 | 更新时间 |

#### 4.3.2 表务工单表(TB_METER_WORKORDER)

| 字段名 | 数据类型 | 长度 | 是否为空 | 主键 | 描述 |
|-------|---------|------|---------|-----|------|
| WORKORDER_ID | VARCHAR | 20 | 否 | 是 | 工单编号，主键 |
| METER_ID | VARCHAR | 20 | 否 | 否 | 水表编号，外键 |
| CUSTOMER_ID | VARCHAR | 20 | 否 | 否 | 客户编号，外键 |
| TENANT_ID | VARCHAR | 20 | 否 | 否 | 租户标识 |
| WORKORDER_TYPE | VARCHAR | 10 | 否 | 否 | 工单类型 |
| WORKORDER_STATUS | VARCHAR | 10 | 否 | 否 | 工单状态 |
| APPLY_DATE | DATE | - | 否 | 否 | 申请日期 |
| PLAN_DATE | DATE | - | 是 | 否 | 计划执行日期 |
| EXECUTE_DATE | DATE | - | 是 | 否 | 实际执行日期 |
| APPLICANT_ID | VARCHAR | 20 | 是 | 否 | 申请人编号 |
| EXECUTOR_ID | VARCHAR | 20 | 是 | 否 | 执行人编号 |
| REASON | VARCHAR | 200 | 是 | 否 | 原因 |
| RESULT | VARCHAR | 200 | 是 | 否 | 结果 |
| CREATE_TIME | DATETIME | - | 否 | 否 | 创建时间 |
| UPDATE_TIME | DATETIME | - | 是 | 否 | 更新时间 |

## 5. 索引设计

为提高系统性能，针对主要查询场景设计了以下索引：

### 5.1 主键索引
- 所有表的主键字段均建立主键索引

### 5.2 外键索引
- 表关联字段建立外键索引，如 CUSTOMER_ID, METER_ID 等

### 5.3 常用查询字段索引
- 客户表：CUSTOMER_NAME, PHONE, ID_NUMBER
- 水表表：METER_NO, BOOK_ID
- 账单表：BILL_MONTH, STATUS
- 缴费表：PAYMENT_DATE, TRANSACTION_NO
- 抄表表：READING_DATE

### 5.4 复合索引
- 客户表：(TENANT_ID, CUSTOMER_TYPE)
- 账单表：(TENANT_ID, CUSTOMER_ID, BILL_MONTH)
- 抄表表：(TENANT_ID, METER_ID, READING_DATE)

## 6. 数据安全性设计

### 6.1 数据加密
- 敏感个人信息（如身份证号码、银行账号等）采用加密存储
- 加密算法采用 AES-256 或同等安全级别的加密方式

### 6.2 权限控制
- 采用基于角色的访问控制（RBAC）模型
- 对不同角色用户设置不同的数据访问权限
- 实现行级、列级的细粒度权限控制

### 6.3 数据备份与恢复
- 定期全量备份，每日增量备份
- 异地数据灾备，确保数据安全
- 完善的数据恢复机制，支持按时间点恢复

### 6.4 数据审计
- 关键业务操作的数据变更记录
- 敏感数据访问日志记录
- 数据异常访问监控与告警 
---

# 福建水务业务系统接口设计

## 目录
- [1. 接口概述](#1-接口概述)
- [2. 外部接口](#2-外部接口)
- [3. 内部接口](#3-内部接口)
- [4. 接口标准](#4-接口标准)

## 1. 接口概述

福建水务业务系统提供丰富的接口，用于与外部系统集成以及系统内部各模块间的数据交换。接口设计遵循标准化、安全性、可扩展性的原则，基于RuoYi-Vue-Pro框架采用RESTful风格设计，支持JSON数据格式。

### 1.1 接口设计原则

- **统一性**：所有接口遵循统一的设计规范和数据格式
- **安全性**：接口通过认证授权、参数校验等机制保障安全
- **可维护性**：接口文档完善，便于维护和升级
- **兼容性**：接口设计考虑版本兼容，支持平滑升级
- **性能优化**：接口设计考虑性能，支持缓存、分页等机制

### 1.2 RESTful API规范

系统API接口采用RESTful风格设计，主要规范如下：

#### 1.2.1 资源命名

- 使用名词复数表示资源集合，如`/users`、`/meters`
- 使用资源ID标识特定资源，如`/users/1`、`/meters/123`
- 资源层级关系通过路径嵌套表示，如`/users/1/meters`

#### 1.2.2 HTTP方法

- GET：获取资源
- POST：创建资源
- PUT：更新资源（全量更新）
- PATCH：部分更新资源
- DELETE：删除资源

#### 1.2.3 状态码

- 200 OK：请求成功
- 201 Created：资源创建成功
- 400 Bad Request：请求参数错误
- 401 Unauthorized：未授权
- 403 Forbidden：权限不足
- 404 Not Found：资源不存在
- 500 Internal Server Error：服务器内部错误

#### 1.2.4 响应格式

系统统一采用以下JSON格式响应：

```json
{
  "code": 0,           // 业务状态码，0表示成功，非0表示失败
  "data": {},          // 响应数据
  "msg": "success"     // 响应消息
}
```

分页查询响应格式：

```json
{
  "code": 0,
  "data": {
    "list": [],        // 数据列表
    "total": 100,      // 总记录数
    "pageNum": 1,      // 当前页码
    "pageSize": 10     // 每页记录数
  },
  "msg": "success"
}
```

### 1.3 接口文档

系统使用Knife4j（基于Swagger）自动生成API文档，文档地址为：`http://{系统地址}/doc.html`。

主要特点：
- 在线接口文档：支持在线查看接口定义
- 接口调试：支持在线调试接口
- 文档导出：支持导出OpenAPI规范文档
- 权限控制：支持对接口文档的访问控制

## 2. 外部接口

### 2.1 与银行接口

#### 2.1.1 银行代扣接口

**功能描述**：通过银行系统自动从用户账户中扣除水费。

**接口规范**：
- 接口方式：文件交换或WebService
- 数据格式：文本文件或XML
- 交换频率：每日或实时

#### 2.1.2 银行实时缴费接口

**功能描述**：用户在银行柜台、网上银行或手机银行实时缴纳水费。

**接口规范**：
- 接口方式：WebService或HTTP接口
- 数据格式：XML或JSON
- 交换频率：实时

### 2.2 支付宝接口

**功能描述**：用户通过支付宝缴纳水费。

**接口规范**：
- 接口方式：HTTP接口
- 数据格式：JSON
- 交换频率：实时

### 2.3 微信支付接口

**功能描述**：用户通过微信支付缴纳水费。

**接口规范**：
- 接口方式：HTTP接口
- 数据格式：XML或JSON
- 交换频率：实时

### 2.4 短信接口

**功能描述**：向用户发送各类业务通知短信。

**接口规范**：
- 接口方式：HTTP接口
- 数据格式：JSON
- 交换频率：实时

### 2.5 物联网集抄平台接口

**功能描述**：与物联网集抄平台交互，获取智能水表数据。

**接口规范**：
- 接口方式：HTTP接口或WebService
- 数据格式：JSON或XML
- 交换频率：定时或实时

## 3. 内部接口

### 3.1 用户接口

#### 3.1.1 用户信息查询接口

**功能描述**：查询用户基本信息。

**接口规范**：
- 请求方式：GET
- 请求路径：/api/users/{userId}
- 返回格式：JSON

#### 3.1.2 用户信息更新接口

**功能描述**：更新用户基本信息。

**接口规范**：
- 请求方式：PUT
- 请求路径：/api/users/{userId}
- 请求/返回格式：JSON

### 3.2 水表接口

#### 3.2.1 水表信息查询接口

**功能描述**：查询水表基本信息。

**接口规范**：
- 请求方式：GET
- 请求路径：/api/meters/{meterId}
- 返回格式：JSON

#### 3.2.2 水表读数上传接口

**功能描述**：上传水表读数。

**接口规范**：
- 请求方式：POST
- 请求路径：/api/meters/{meterId}/readings
- 请求/返回格式：JSON

### 3.3 账单接口

#### 3.3.1 账单查询接口

**功能描述**：查询用户账单信息。

**接口规范**：
- 请求方式：GET
- 请求路径：/api/users/{userId}/bills
- 返回格式：JSON

#### 3.3.2 缴费接口

**功能描述**：处理用户缴费。

**接口规范**：
- 请求方式：POST
- 请求路径：/api/bills/{billId}/payments
- 请求/返回格式：JSON

### 3.4 工单接口

#### 3.4.1 工单创建接口

**功能描述**：创建业务工单。

**接口规范**：
- 请求方式：POST
- 请求路径：/api/workorders
- 请求/返回格式：JSON

#### 3.4.2 工单状态更新接口

**功能描述**：更新工单处理状态。

**接口规范**：
- 请求方式：PUT
- 请求路径：/api/workorders/{workorderId}/status
- 请求/返回格式：JSON

## 4. 接口标准

### 4.1 接口协议

系统接口主要采用以下协议：

- **RESTful API**：适用于系统内部模块间的交互以及移动应用等轻量级客户端
- **WebService**：适用于与外部系统的集成，特别是银行等传统机构
- **消息队列**：适用于异步处理的场景，如批量数据处理、通知推送等

### 4.2 数据格式

接口数据主要采用以下格式：

- **JSON**：主要用于RESTful API接口，结构简单清晰，适合Web应用
- **XML**：主要用于WebService接口，兼容性好，适合与传统系统对接
- **文本文件**：主要用于批量数据交换，如银行代扣文件等

### 4.3 接口安全

接口安全采用以下机制：

- **令牌认证**：使用JWT(JSON Web Token)进行身份认证
- **签名验证**：请求参数签名，确保数据完整性
- **IP白名单**：限制接口调用者的IP地址
- **传输加密**：使用HTTPS协议加密传输数据
- **接口限流**：限制单位时间内的请求次数
- **访问日志**：记录所有接口调用情况 
---

# 福建水务业务系统部署设计

## 目录
- [1. 部署概述](#1-部署概述)
- [2. 部署架构](#2-部署架构)
- [3. 服务器配置](#3-服务器配置)
- [4. 网络架构](#4-网络架构)
- [5. 安全设计](#5-安全设计)
- [6. 部署流程](#6-部署流程)
- [7. 监控与运维](#7-监控与运维)

## 1. 部署概述

福建水务业务系统采用集中化部署模式，基于集团私有云环境进行部署，构建高可用、可扩展的系统架构，满足集团及下属各水务公司的业务需求。

### 1.1 部署目标

- 实现系统的集中部署和统一管理
- 确保系统高可用性和可靠性
- 支持业务动态扩展和弹性伸缩
- 保障数据安全和业务连续性
- 降低运维成本，提高管理效率

### 1.2 部署原则

- **集中部署**：核心业务系统集中部署在集团数据中心，统一管理和维护
- **多级架构**：采用多级架构设计，实现前端负载分担和后端高可用
- **灾备设计**：重要系统和数据实现灾备，确保业务连续性
- **安全防护**：多层次安全防护体系，确保系统和数据安全
- **弹性扩展**：支持系统横向和纵向扩展，适应业务增长需求

## 2. 部署架构

### 2.1 总体部署架构

福建水务业务系统采用三层架构部署：

- **接入层**：负责外部访问请求的接入和负载均衡
- **应用层**：部署业务应用服务，处理业务逻辑
- **数据层**：部署数据库服务，存储业务数据

系统部署采用集群模式，各层均部署多个节点，实现高可用和负载均衡。

### 2.2 生产环境部署架构

生产环境采用双机房部署方案，包括主生产环境和灾备环境：

#### 2.2.1 主生产环境

主生产环境部署在集团主数据中心，包括：

- 负载均衡集群：2台负载均衡服务器
- Web服务器集群：4台Web服务器
- 应用服务器集群：6台应用服务器
- 数据库服务器集群：2台主备数据库服务器
- 文件服务器：2台主备文件服务器
- 缓存服务器集群：2台缓存服务器

#### 2.2.2 灾备环境

灾备环境部署在集团备用数据中心，包括：

- 负载均衡服务器：1台
- Web服务器：2台
- 应用服务器：3台
- 数据库服务器：1台
- 文件服务器：1台
- 缓存服务器：1台

### 2.3 测试环境部署架构

测试环境部署在集团测试中心，用于系统测试和验证，包括：

- Web服务器：1台
- 应用服务器：2台
- 数据库服务器：1台
- 文件服务器：1台

### 2.4 开发环境部署架构

开发环境部署在开发中心，用于系统开发和集成测试，包括：

- 应用服务器：1台
- 数据库服务器：1台

## 3. 服务器配置

### 3.1 硬件配置要求

#### 3.1.1 负载均衡服务器

- CPU：8核
- 内存：16GB
- 存储：100GB SSD
- 网卡：双千兆网卡

#### 3.1.2 Web服务器

- CPU：8核
- 内存：16GB
- 存储：200GB SSD
- 网卡：双千兆网卡

#### 3.1.3 应用服务器

- CPU：16核
- 内存：32GB
- 存储：300GB SSD
- 网卡：双千兆网卡

#### 3.1.4 数据库服务器

- CPU：24核
- 内存：64GB
- 存储：2TB SSD (RAID 10)
- 网卡：双万兆网卡

#### 3.1.5 文件服务器

- CPU：8核
- 内存：16GB
- 存储：4TB (RAID 5)
- 网卡：双千兆网卡

#### 3.1.6 缓存服务器

- CPU：8核
- 内存：32GB
- 存储：100GB SSD
- 网卡：双千兆网卡

### 3.2 软件配置要求

#### 3.2.1 操作系统

- 服务端：CentOS 7+、Ubuntu 18.04+或其他国产Linux发行版
- 客户端：支持Windows、macOS、Linux等现代操作系统

#### 3.2.2 数据库

- MySQL 5.7+ 或 MariaDB 10.2+（推荐）
- 国产数据库可选：OpenGauss、达梦等

#### 3.2.3 应用服务器

- JDK 17或JDK 21（兼容支持JDK 8）
- Apache Tomcat 9.0+或内嵌Tomcat
- Nginx 1.18+（作为前端静态资源服务器和反向代理）

#### 3.2.4 缓存服务器

- Redis 5.0+或Redis集群

#### 3.2.5 中间件

- 消息队列：基于Redis的轻量级队列（可选）
- 分布式任务调度：Quartz集群
- 工作流引擎：Flowable 6.x
- 文件存储：支持本地存储、MinIO、阿里云OSS等

#### 3.2.6 前端环境

- Node.js 16+
- NPM 8+或Yarn 1.22+
- Vue 3.x
- Element Plus

## 4. 网络架构

### 4.1 网络拓扑

福建水务业务系统网络架构采用三层网络结构：

- **接入层**：对外提供服务接入，部署防火墙、负载均衡等设备
- **核心层**：实现业务系统间的互联互通，部署核心交换机
- **服务层**：部署各类服务器，实现业务处理和数据存储

### 4.2 网络安全区域划分

网络安全区域划分为以下几个区域：

- **DMZ区**：部署面向外部的Web服务器，与内网隔离
- **应用区**：部署业务应用服务器
- **数据区**：部署数据库服务器和文件服务器
- **管理区**：部署运维管理服务器

### 4.3 网络带宽配置

- 外网接入带宽：100Mbps，根据实际需求可升级
- 内网骨干带宽：1000Mbps
- 服务器接入带宽：1000Mbps
- 数据中心间专线带宽：100Mbps

## 5. 安全设计

### 5.1 网络安全

#### 5.1.1 边界安全

- 部署高性能防火墙，实现网络隔离
- 部署入侵检测系统(IDS)和入侵防御系统(IPS)
- 部署Web应用防火墙(WAF)，防御Web应用攻击
- 采用VPN技术，保障远程访问安全

#### 5.1.2 内网安全

- 网络安全区域划分，实现不同级别网络隔离
- 内网访问控制，限制不必要的网络访问
- 内网流量监控，及时发现异常流量

### 5.2 系统安全

#### 5.2.1 主机安全

- 操作系统安全加固，关闭不必要的服务和端口
- 系统补丁及时更新，修复安全漏洞
- 部署主机防病毒软件，防御恶意代码
- 主机审计和日志管理，记录重要操作

#### 5.2.2 应用安全

- 应用访问控制，基于角色的权限管理
- 应用操作审计，记录重要业务操作
- 数据传输加密，保护敏感信息
- 输入验证，防止SQL注入、XSS等攻击

### 5.3 数据安全

#### 5.3.1 数据存储安全

- 数据库访问控制，限制数据库访问权限
- 敏感数据加密存储，防止数据泄露
- 数据库审计，记录重要数据操作

#### 5.3.2 数据备份与恢复

- 定期数据备份，每日增量备份，每周全量备份
- 备份数据异地存储，防止灾难性事件导致数据丢失
- 定期演练数据恢复，确保备份数据可用

## 6. 部署流程

### 6.1 部署准备

- 服务器硬件准备和上架
- 网络环境配置和测试
- 操作系统安装和配置
- 基础软件安装和配置

### 6.2 应用部署

#### 6.2.1 数据库部署

- 数据库服务器配置
- 数据库实例创建和配置
- 数据库高可用配置
- 数据备份策略配置

#### 6.2.2 应用服务部署

- 应用服务器配置
- 应用程序部署
- 应用服务参数配置
- 应用服务高可用配置

#### 6.2.3 Web服务部署

- Web服务器配置
- Web应用部署
- Web服务参数配置
- 负载均衡配置

### 6.3 系统联调

- 各组件功能测试
- 系统整体联调测试
- 性能和压力测试
- 高可用性测试

### 6.4 系统上线

- 制定上线计划
- 系统割接准备
- 系统割接实施
- 系统运行监控

## 7. 监控与运维

### 7.1 监控系统

#### 7.1.1 基础设施监控

- 服务器硬件监控：CPU、内存、磁盘、网络等
- 网络设备监控：带宽使用率、连接状态等
- 操作系统监控：系统负载、进程状态等

#### 7.1.2 应用监控

- 应用服务状态监控
- 应用性能监控：响应时间、并发数等
- 业务监控：重要业务指标监控

#### 7.1.3 数据库监控

- 数据库服务状态监控
- 数据库性能监控：CPU使用率、内存使用率、IO性能等
- SQL执行监控：慢查询、锁等待等

### 7.2 运维管理

#### 7.2.1 日常运维

- 系统日常巡检
- 系统性能优化
- 系统容量管理
- 系统备份管理

#### 7.2.2 变更管理

- 变更申请和审批
- 变更实施和验证
- 变更回退预案
- 变更记录管理

#### 7.2.3 故障管理

- 故障监控和告警
- 故障处理流程
- 故障升级机制
- 故障复盘和改进

#### 7.2.4 应急预案

- 系统宕机应急预案
- 网络故障应急预案
- 数据丢失应急预案
- 安全事件应急预案