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

系统设计团队

2025年06月09日

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

一、项目背景与概述

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

二、系统设计总体规划

1. 设计依据

2. 设计原则

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

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

  1. 原系统功能梳理
  2. 业务流程梳理

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

  1. 技术架构设计
  2. 系统功能模块划分

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

  1. 系统功能模块详细设计
  2. 数据库设计
  3. 接口设计

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

  1. 性能设计
  2. 安全设计
  3. 部署设计

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

  1. 文档整合
  2. 文档评审

四、人员分工建议

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

1. 按模块分工

2. 按系统功能分工

五、文档规范与模板

1. 文档格式规范

2. 设计文档模板

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

# [模块名称]设计说明

## 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. 设计计划文档

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

2. 系统架构设计

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

3. 模块功能设计

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

4. 数据库设计

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

5. 接口设计

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

6. 部署运维设计

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

三、编写建议

1. 编写前的准备

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

3. 多人协作编写策略

4. 编写工具使用建议

四、后续工作建议

1. 文档评审与完善

2. 详细设计与开发

3. 文档维护与更新

五、常见问题与解决方案

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

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

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

4. 文档内容难以理解

福建水务业务系统概述

目录

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.1 系统架构图

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

系统架构图

2. 技术架构

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

2.1 服务端

2.2 客户端

2.3 技术特性

3. 应用架构

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

3.1 统一平台

3.2 营收系统

3.3 客户服务

3.4 表务系统

3.5 报装管理

3.6 统计分析

3.7 工程管理

3.8 抄表APP

3.9 接口服务

3.10 系统配置

4. 数据架构

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

4.1 数据分层

4.2 数据模型

4.3 数据集成与共享

5. 安全架构

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

5.1 网络安全

5.2 数据安全

5.3 应用安全

5.4 接口安全

6. 部署架构

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

6.1 物理部署

6.2 逻辑部署

6.3 容器部署

7. 接口架构

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

7.1 外部接口

7.2 内部接口

7.3 接口标准

7.4 接口服务管理

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

目录

1. 统一平台

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

1.1 单点登录

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

1.2 系统管理

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

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 其他系统对接

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

8. 统计分析

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

8.1 报表查询

8.2 欠费查询

8.3 缴费记录

8.4 用水分析

9. 工程管理

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

9.1 工程申请

9.2 工程施工

9.3 工程验收

9.4 工程查询

10. 抄表APP

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

10.1 首页功能

10.2 抄表功能

10.3 工单管理

11. 接口服务

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

11.1 API市场

11.2 API管理

11.3 接口权限管理

11.4 系统对外接口

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

目录

1. 数据库设计概述

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

1.1 设计目标

1.2 设计原则

2. 数据库架构

2.1 总体架构

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

2.2 多租户设计

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

2.3 数据访问层设计

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

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 外键索引

5.3 常用查询字段索引

5.4 复合索引

6. 数据安全性设计

6.1 数据加密

6.2 权限控制

6.3 数据备份与恢复

6.4 数据审计

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

目录

1. 接口概述

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

1.1 接口设计原则

1.2 RESTful API规范

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

1.2.1 资源命名

1.2.2 HTTP方法

1.2.3 状态码

1.2.4 响应格式

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

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

分页查询响应格式：

{
  "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 接口协议

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

4.2 数据格式

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

4.3 接口安全

接口安全采用以下机制：

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

目录

1. 部署概述

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

1.1 部署目标

1.2 部署原则

2. 部署架构

2.1 总体部署架构

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

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

2.2 生产环境部署架构

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

2.2.1 主生产环境

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

2.2.2 灾备环境

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

2.3 测试环境部署架构

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

2.4 开发环境部署架构

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

3. 服务器配置

3.1 硬件配置要求

3.1.1 负载均衡服务器

3.1.2 Web服务器

3.1.3 应用服务器

3.1.4 数据库服务器

3.1.5 文件服务器

3.1.6 缓存服务器

3.2 软件配置要求

3.2.1 操作系统

3.2.2 数据库

3.2.3 应用服务器

3.2.4 缓存服务器

3.2.5 中间件

3.2.6 前端环境

4. 网络架构

4.1 网络拓扑

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

4.2 网络安全区域划分

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

4.3 网络带宽配置

5. 安全设计

5.1 网络安全

5.1.1 边界安全

5.1.2 内网安全

5.2 系统安全

5.2.1 主机安全

5.2.2 应用安全

5.3 数据安全

5.3.1 数据存储安全

5.3.2 数据备份与恢复

6. 部署流程

6.1 部署准备

6.2 应用部署

6.2.1 数据库部署

6.2.2 应用服务部署

6.2.3 Web服务部署

6.3 系统联调

6.4 系统上线

7. 监控与运维

7.1 监控系统

7.1.1 基础设施监控

7.1.2 应用监控

7.1.3 数据库监控

7.2 运维管理

7.2.1 日常运维

7.2.2 变更管理

7.2.3 故障管理

7.2.4 应急预案