gunshi-project-ss/deprecated/设计文档总目录.md

146 lines
5.7 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters!

This file contains ambiguous Unicode characters that may be confused with others in your current locale. If your use case is intentional and legitimate, you can safely ignore this warning. Use the Escape button to highlight these characters.

# 黑石咀水库系统详细设计文档 - 总目录
## 文档概述
本文档是湖北省山洪灾害监测预报预警"四预"系统详细设计文档,基于黑石咀水库系统代码库实际实现编写。
## 文档结构
### 第1章 项目概述
*(待编写)*
### 第2章 系统需求分析
*(待编写)*
### 第3章 系统总体设计
*(待编写)*
### 第4章 项目总体设计
**文件位置**: `详细设计文档.md`
**状态**: ✅ 已完成
**内容概要**:
- 4.1 总体架构(四层分布式体系架构)
- 4.2 网络架构(多网络区域架构设计)
- 4.3 部署架构VPC隔离和负载均衡
- 4.4 数据架构(数据生命周期管理)
- 4.5 安全架构(等保三级安全体系)
- 4.6 数据流向(多源数据汇集和处理)
- 4.7 技术路线(微服务和云计算)
- 4.8 接口设计(用户接口、外部接口、内部接口)
### 第5章 功能设计
**文件位置**: `第5章_功能设计.md`
**状态**: ✅ 已完成
**内容概要**:
- 5.1 梳理集成基础数据(数据治理和调查评价成果集成)
- 5.2 算法模型建设方案(分布式水文模型和淹没分析模型)
- 5.3 简化淹没范围与水深分析模型HEC-RAS模型集成
- 5.4 县级用户创建34个县用户管理
- 5.5 县级数据整理与应用西塞山区等34个区县数据处理
- 5.6 系统功能完善(智能降雨预报、流域管理、动态预警)
- 5.7 县级考核管理功能(考核任务、预警配置、防治点管理)
### 第6章 数据库设计
**文件位置**: `第6章_数据库设计.md`
**状态**: ✅ 已完成除6.3节)
**内容概要**:
- 6.1 数据库设计说明(设计原则、运行环境、安全设计)
- 6.2 部署架构(主备架构和高可用性)
- 6.4 数据库访问优化设计(索引优化、分页处理、批量操作)
- 6.5 缓存机制设计Redis缓存和本地缓存
- 6.6 数据库安全实现(访问控制、数据加密)
- 6.7 数据库监控与维护(性能监控、备份恢复)
- 6.8 关键数据模型设计(监测数据、预警数据、业务数据)
- 6.9 数据库扩展性设计(分库分表、微服务支持)
### 第7章 网络系统设计
**文件位置**: `第7章_网络系统设计.md`
**状态**: ✅ 已完成
**内容概要**:
- 7.1 网络规划(政务外网和互联网接入区)
- 7.2 政务外网及专网区(专线安全和认证机制)
- 7.3 互联网区多网络接入和外部API集成
- 7.4 安全隔离区(容器化安全隔离)
- 7.5 容器化网络架构Docker配置和应用服务器
- 7.6 多环境网络配置(开发环境和生产环境)
- 7.7 网络安全措施(访问控制、数据传输安全)
- 7.8 HTTP客户端配置连接配置和负载分担
- 7.9 网络监控与维护(性能监控和故障恢复)
- 7.10 部署脚本实现(自动化部署)
- 7.11 网络扩展性设计(水平扩展和云原生支持)
- 7.12 网络性能优化(传输优化和缓存优化)
- 7.13 网络安全合规(等保三级要求和安全防护)
## 技术映射汇总
### 核心技术栈
- **后端框架**: Spring Boot 3.x + Java 21
- **数据库**: PostgreSQL + MyBatis-Plus 3.5.7
- **缓存**: Redis + Caffeine
- **部署**: Docker + docker-compose
- **消息调度**: Spring Boot Quartz
- **空间数据**: JTS (LocationTech)
- **外部集成**: HTTP API + Token认证
### 关键业务模块
1. **数据采集同步**: `DataTaskHsz.java` - 5分钟定时数据同步
2. **预报服务**: `ForecastService.java` - 气象预报和洪水预测
3. **预警系统**: `MessageCenterService.java` - 多级预警管理
4. **考核管理**: `AssessTaskService.java` - 县级考核工作流
5. **防治对象管理**: `AttResBaseService.java` - 防治对象数据管理
### 数据模型设计
- **监测数据**: `StPptnR`(降雨)、`StRsvrR`(水位)、`StRiverR`(河流)
- **预警管理**: `MessageCenter`(消息)、`OsmoticWarnRule`(规则)
- **业务数据**: `AssessTask`(考核)、`AttResBase`(防治对象)
### 网络安全架构
- **部署架构**: 前端VPC + 后端VPC + 数据库VPC
- **安全隔离**: 互联网区 ↔ 安全隔离区 ↔ 政务外网区
- **认证机制**: Token认证 + IP白名单 + SSL加密
- **监控告警**: 性能监控 + 日志审计 + 故障恢复
## 文档完整性检查
### 已完成章节
- ✅ 第4章 项目总体设计 - 完整映射代码实现
- ✅ 第5章 功能设计 - 详细功能模块与代码对应
- ✅ 第6章 数据库设计 - 全面数据库设计与优化
- ✅ 第7章 网络系统设计 - 完整网络架构与安全设计
### 待完成章节
- ⏳ 第1章 项目概述
- ⏳ 第2章 系统需求分析
- ⏳ 第3章 系统总体设计
### 文档质量评估
- **技术准确性**: 高 - 基于实际代码库实现
- **代码映射**: 完整 - 所有设计都有对应的代码实现
- **架构描述**: 清晰 - 从总体到详细的技术架构
- **安全考虑**: 全面 - 等保三级安全要求
- **部署指导**: 实用 - Docker配置和部署脚本
## 使用说明
### 目标读者
- 系统架构师
- 开发工程师
- 运维人员
- 项目管理人员
### 使用建议
1. **系统设计**: 重点阅读第4章总体设计和第7章网络设计
2. **功能开发**: 参考第5章功能设计和具体代码实现
3. **数据库设计**: 详细参考第6章数据库设计
4. **部署运维**: 结合第7章网络设计和CLAUDE.md开发指南
### 配套文档
- `CLAUDE.md`: 项目开发指南和技术栈说明
- `todo.md`: 项目进度追踪和任务管理
- `degisn.md`: 原始设计思路参考
---
**文档版本**: v1.0
**创建日期**: 2025-09-11
**最后更新**: 2025-09-11
**维护状态**: 持续更新中