15 KiB
15 KiB
福建水务营收系统概要设计文档
文档信息
| 项目信息 | 详情 |
|---|---|
| 项目名称 | 福建水务营收系统 |
| 文档类型 | 概要设计文档 |
| 技术框架 | RuoYi-Vue-Pro + yudao-ui-admin-vue3 |
| 文档版本 | v1.0 |
| 编写日期 | 2024-12-19 |
| 文档状态 | ✅ 已完成 |
目录
引言
编写目的
文档目标
本文档是福建水务营收系统的概要设计文档，旨在为系统的详细设计、开发实施、测试验证、运维管理等后续工作提供重要的技术依据和指导方案。
编写目的
- 指导系统开发：为开发团队提供清晰、完整、可执行的技术架构方案和实施蓝图
- 规范设计标准：建立统一的技术标准和开发规范，确保系统架构的一致性和可维护性
- 评审技术方案：为项目技术评审、方案论证提供详细的技术文档支撑
- 支撑项目管理：为项目管理、进度控制、质量管控提供技术基础和评估依据
- 保障系统质量：通过详细的设计说明确保系统的可靠性、安全性、可扩展性和高性能
目标读者
本文档的主要读者包括：
| 读者类型 | 主要关注点 | 使用目的 |
|---|---|---|
| 系统架构师 | 技术架构设计、技术选型方案 | 架构设计评审、技术方案优化 |
| 项目经理 | 项目范围、技术风险、实施计划 | 项目管理、进度控制、风险评估 |
| 开发工程师 | 技术实现方案、接口设计、数据库设计 | 系统开发、代码实现、模块集成 |
| 测试工程师 | 功能设计、性能指标、接口规范 | 测试用例设计、测试计划制定 |
| 运维工程师 | 部署架构、监控方案、运维策略 | 系统部署、运维管理、性能优化 |
| 业务分析师 | 业务功能、流程设计、用户体验 | 需求验证、业务流程梳理 |
| 甲方技术团队 | 整体技术方案、质量标准、交付成果 | 技术评审、验收标准制定 |
预期用途
- 开发阶段：作为系统详细设计和编码实现的技术指导文档
- 测试阶段：作为系统测试、集成测试、性能测试的参考标准
- 部署阶段：作为系统部署、环境配置、运维管理的操作指南
- 维护阶段：作为系统维护、功能扩展、技术升级的参考依据
- 培训阶段：作为技术培训、知识传递的重要教材
背景
项目背景
随着福建省水务行业数字化转型的深入推进和"数字福建"战略的全面实施，传统的水务营收管理系统已无法满足现代化管理的需要。为了提升水务企业的服务效率、管理水平和客户体验，迫切需要构建一套现代化、智能化、集成化的水务营收系统。
业务发展需求
- 集团化管理：支持福建水务集团及下属分公司的统一管理和分级运营
- 多租户架构：实现"一套系统、多级管理"的集团化运营模式
- 移动化办公：支持抄表员移动抄表、客户移动缴费等移动化业务
- 智能化服务：集成物联网技术，实现远程抄表、智能监控等功能
- 一体化平台：整合营收、客服、表务等多业务系统的一体化平台
技术升级需求
- 现代化技术栈：采用先进的微服务架构和前后端分离技术
- 国产化适配：全面适配华为OpenGauss等国产化数据库和中间件
- 云原生部署：支持容器化部署和云原生架构
- 安全合规：满足等保三级安全要求和行业安全规范
系统现状
现有系统问题
- 技术架构陈旧：基于传统单体架构，扩展性和维护性较差
- 数据孤岛严重：各子系统数据分散，缺乏统一的数据管理
- 用户体验不佳：界面设计过时，操作流程复杂，移动端支持不足
- 集成能力弱：与外部系统集成困难，接口标准化程度低
- 运维成本高：系统运维复杂，故障定位困难，升级部署风险大
业务挑战
- 客户服务效率低：传统柜台服务模式，客户等待时间长
- 抄表作业不规范：人工抄表易出错，实时性差
- 收费方式单一：主要依赖现金收费，线上支付渠道不完善
- 数据分析能力弱：缺乏有效的数据分析和决策支持工具
相关系统
本系统需要与多个相关系统进行数据交换和业务协同：
内部系统
- 企业ERP系统：财务数据同步、资产管理集成
- GIS地理信息系统：管网信息、客户位置信息集成
- 客户服务系统：客户信息管理、服务工单处理
- 水质监测系统：水质数据采集和分析
- SCADA生产调度系统：生产数据监控和调度
外部系统
- 银行代扣系统：支持工商银行、建设银行等主要银行的代扣业务
- 第三方支付平台：微信支付、支付宝等移动支付接口
- 短信服务平台：阿里云短信、腾讯云短信等消息推送服务
- 物联网平台：智能水表、远程抄表设备的数据采集
- 政务服务平台：与当地政务服务网的数据对接
监管系统
- 水务行业监管平台：向省市水务部门报送运营数据
- 价格监管系统：水价政策执行情况报送
- 环保监测系统：污水处理和环保数据上报
建设环境
技术环境
- 开发框架：基于RuoYi-Vue-Pro开源框架进行定制开发
- 数据库：华为OpenGauss 5.0+企业版，支持主从复制和读写分离
- 中间件：Redis 6.0集群、RabbitMQ消息队列、MinIO对象存储
- 部署环境：支持Docker容器化部署和Kubernetes集群管理
- 监控运维：集成Prometheus + Grafana监控体系
基础设施环境
- 网络环境：千兆局域网，支持VPN远程接入
- 安全环境：防火墙、入侵检测、安全审计等安全防护体系
- 机房环境：符合国家A级机房标准，具备完善的电力、空调、监控设施
- 灾备环境：建设异地灾备中心，实现数据同步和业务连续性
定义
专业术语
| 术语 | 英文全称 | 中文定义 | 备注 |
|---|---|---|---|
| 抄表 | Meter Reading | 定期读取水表示数，记录客户用水量的业务过程 | 包括人工抄表和远程抄表 |
| 开账 | Billing | 根据抄表数据计算水费，生成客户账单的业务过程 | 核心营收业务 |
| 阶梯水价 | Tiered Water Pricing | 按用水量分档计费的水价政策 | 节水政策工具 |
| 水表 | Water Meter | 测量和记录水流量的计量设备 | 包括机械表和智能表 |
| 远传水表 | Remote Water Meter | 具备远程数据传输功能的智能水表 | 物联网设备 |
| 客户编号 | Customer Code | 唯一标识客户的业务编码 | 业务主键 |
| 水表编号 | Meter Code | 唯一标识水表的设备编码 | 设备标识 |
| 账务 | Accounting | 客户费用计算、账单管理、收费处理等财务业务 | 财务核心 |
| 收费 | Billing Collection | 向客户收取水费的业务过程 | 包括现金、刷卡、移动支付等 |
| 营业网点 | Service Outlet | 提供客户服务的营业场所 | 线下服务渠道 |
| 工单 | Work Order | 记录和跟踪业务处理过程的管理单据 | 流程管理工具 |
| 多租户 | Multi-tenancy | 支持多个独立客户共享同一应用实例的架构模式 | 技术架构模式 |
技术术语
| 术语 | 英文全称 | 中文定义 | 备注 |
|---|---|---|---|
| 微服务 | Microservices | 将单体应用拆分为多个独立服务的架构模式 | 现代架构模式 |
| 容器化 | Containerization | 使用容器技术打包和部署应用的技术方案 | Docker技术 |
| API网关 | API Gateway | 统一管理和路由API请求的服务组件 | 微服务架构组件 |
| 负载均衡 | Load Balancing | 将请求分发到多个服务实例的技术 | 高可用技术 |
| 缓存 | Cache | 临时存储频繁访问数据以提高性能的技术 | 性能优化技术 |
| 消息队列 | Message Queue | 异步消息传递的中间件技术 | 系统解耦技术 |
| 数据库连接池 | Database Connection Pool | 管理数据库连接的资源池技术 | 性能优化技术 |
| ORM | Object-Relational Mapping | 对象关系映射，简化数据库操作的技术 | 数据访问技术 |
| JWT | JSON Web Token | 基于JSON的安全令牌标准 | 认证技术 |
| RESTful | Representational State Transfer | 基于HTTP的Web服务架构风格 | 接口设计规范 |
缩略语
| 缩略语 | 英文全称 | 中文含义 | 使用场景 |
|---|---|---|---|
| RuoYi | 若依开源框架 | 基于Spring Boot的快速开发框架 | 后端开发框架 |
| Vue | Vue.js | 渐进式JavaScript框架 | 前端开发框架 |
| SaaS | Software as a Service | 软件即服务 | 服务模式 |
| B/S | Browser/Server | 浏览器/服务器架构 | 系统架构模式 |
| M/S | Mobile/Server | 移动端/服务器架构 | 移动应用架构 |
| RBAC | Role-Based Access Control | 基于角色的访问控制 | 权限管理模式 |
| SSO | Single Sign-On | 单点登录 | 认证技术 |
| DTO | Data Transfer Object | 数据传输对象 | 数据传输模式 |
| VO | Value Object | 值对象 | 数据展示模式 |
| DO | Data Object | 数据对象 | 数据持久化模式 |
| DAO | Data Access Object | 数据访问对象 | 数据访问模式 |
| MVC | Model-View-Controller | 模型-视图-控制器 | 设计模式 |
| IoT | Internet of Things | 物联网 | 技术领域 |
| GPS | Global Positioning System | 全球定位系统 | 定位技术 |
| GIS | Geographic Information System | 地理信息系统 | 地理信息技术 |
业务术语规范
客户管理相关
- 用户：指系统的操作用户，如管理员、抄表员等
- 客户：指水务服务的最终用户，即用水客户
- 账户：客户在系统中的业务账户，用于记录用水和缴费信息
- 档案：客户的基本信息档案，包括身份、地址、联系方式等
计量收费相关
- 周期：抄表计费的时间周期，通常为月度
- 示数：水表显示的累计用水量数值
- 用量：某个周期内的实际用水量
- 水费：根据用水量和水价计算的费用
- 滞纳金：逾期未缴费产生的违约金
设备管理相关
- 表具：水表设备的统称
- 口径：水表的流量规格，如DN15、DN20等
- 厂商：水表生产厂家
- 型号：水表的具体型号规格
参考资料
国家标准和行业规范
| 标准编号 | 标准名称 | 版本 | 适用范围 |
|---|---|---|---|
| GB/T 778.1-2018 | 饮用冷水水表和热水水表 第1部分：技术要求 | 2018版 | 水表技术规范 |
| GB/T 778.2-2018 | 饮用冷水水表和热水水表 第2部分：试验方法 | 2018版 | 水表检测标准 |
| CJ/T 133-2019 | 电子远传水表 | 2019版 | 远传水表技术规范 |
| GB 50015-2019 | 建筑给水排水设计标准 | 2019版 | 给排水工程设计 |
| CJ/T 224-2019 | 城市供水水质标准 | 2019版 | 供水水质要求 |
信息安全标准
| 标准编号 | 标准名称 | 版本 | 适用范围 |
|---|---|---|---|
| GB/T 22239-2019 | 信息安全技术 网络安全等级保护基本要求 | 2019版 | 等保三级合规 |
| GB/T 25070-2019 | 信息安全技术 网络安全等级保护安全设计技术要求 | 2019版 | 安全设计规范 |
| GB/T 28448-2019 | 信息安全技术 网络安全等级保护测评要求 | 2019版 | 安全测评标准 |
| GM/T 0054-2018 | 信息系统密码应用基本要求 | 2018版 | 密码应用规范 |
软件工程标准
| 标准编号 | 标准名称 | 版本 | 适用范围 |
|---|---|---|---|
| GB/T 8566-2007 | 信息技术 软件生存周期过程 | 2007版 | 软件开发流程 |
| GB/T 16260.1-2006 | 软件工程 产品质量 第1部分：质量模型 | 2006版 | 软件质量标准 |
| GB/T 15532-2008 | 计算机软件测试规范 | 2008版 | 软件测试规范 |
| ISO/IEC 25010:2011 | Systems and software Quality Requirements and Evaluation (SQuaRE) | 2011版 | 软件质量国际标准 |
技术参考文档
开发框架文档
- RuoYi-Vue-Pro官方文档 - https://doc.iocoder.cn/
- Spring Boot官方文档 - https://spring.io/projects/spring-boot
- Vue 3官方文档 - https://vuejs.org/
- Element Plus组件库文档 - https://element-plus.org/
数据库文档
- 华为OpenGauss数据库文档 - https://opengauss.org/
- Redis官方文档 - https://redis.io/documentation
- MyBatis-Plus官方文档 - https://baomidou.com/
部署运维文档
- Docker官方文档 - https://docs.docker.com/
- Kubernetes官方文档 - https://kubernetes.io/docs/
- Nginx官方文档 - https://nginx.org/en/docs/
业务参考资料
水务行业资料
- 《城市供水条例》 - 国务院令第158号
- 《城市供水价格管理办法》 - 国家发改委、住建部令第47号
- 《福建省城市供水管理办法》 - 福建省政府令第169号
- 《福建省阶梯水价实施方案》 - 福建省发改委文件
项目相关文档
- 《福建水务营收系统需求分析报告》 - v2.0
- 《福建水务营收系统可行性研究报告》 - v1.0
- 《福建水务营收系统项目建设方案》 - v1.5
- 《现有系统调研报告》 - v1.0
- 《业务流程梳理报告》 - v2.1
技术选型参考
架构设计参考
- 《微服务架构设计模式》 - Chris Richardson著
- 《Spring微服务实战》 - John Carnell著
- 《Vue.js设计与实现》 - 尤雨溪著
- 《分布式系统架构与实现》 - 李智慧著
数据库设计参考
- 《数据库系统概念》 - Abraham Silberschatz著
- 《高性能MySQL》 - Baron Schwartz著
- 《Redis设计与实现》 - 黄健宏著
安全设计参考
- 《Web安全深度剖析》 - 张炳帅著
- 《网络安全等级保护实施指南》 - 公安部信息安全等级保护评估中心编
本章小结
本章作为福建水务营收系统概要设计文档的引言部分，明确了文档的编写目的、项目背景、相关定义和参考资料。为后续的详细技术设计提供了必要的背景信息和术语基础。
核心要点：
- 📋 明确了文档的目标读者和预期用途
- 🏗️ 阐述了项目建设背景和技术升级需求
- 📚 建立了统一的术语规范和技术标准
- 📖 提供了完整的参考资料和技术依据
文档导航：