Files
hzdyjs/.serena/memories/project_structure.md
T
zlwu 249b1dfeb4 feat: 完善项目开发规范和测试文档体系
📝 主要改进:
• Cursor配置模块化:拆分为前端、后端、移动端、文档、API测试5个专门规范文件
• API文档重新组织:按业务模块拆分到docs/开发文档/API/目录下
• 新增维修分类功能完整测试方案和自动化测试脚本
• 后端热启动脚本完善,支持Linux/Windows双平台
• 强化文档同步更新规范,确保代码与文档一致性

🔧 技术改进:
• 优化Cursor AI工作流程和代码生成质量
• 完善API测试规范(AES+RSA双重加密登录方法)
• 提升开发效率和代码质量标准化程度

�� 测试覆盖:
• 维修分类管理功能端到端测试验证通过
• 包含页面加载、CRUD操作、搜索功能等核心测试用例

更新时间:2025-07-01
2025-07-01 17:53:05 +08:00

7.4 KiB

项目目录结构说明

总体结构概览

hzdyjs_xg/
├── backend/              # 后端工程 (Spring Boot)
├── web/                  # 前端工程 (Vue 3 + TypeScript)  
├── mobile/               # 移动端工程 (uniapp)
├── docs/                 # 项目文档
├── test/                 # 测试脚本和报告
├── scripts/              # 工具脚本
└── 工程本地启动指导.md    # 启动指导文档

后端工程结构 (backend/)

backend/
├── ruoyi-admin/          # 主应用模块 (Spring Boot启动类)
│   ├── src/main/java/
│   │   ├── org.dromara/
│   │   │   ├── DromaraApplication.java    # 主启动类
│   │   │   ├── test/                      # 测试代码
│   │   │   ├── web/                       # Web层 (认证、登录等)
│   │   │   └── zhxy.hq/                   # 后勤业务模块
│   │   │       ├── controller/            # 控制器层
│   │   │       ├── service/               # 服务层  
│   │   │       ├── mapper/                # 数据访问层
│   │   │       └── domain/                # 实体和VO/BO
│   │   └── resources/
│   │       ├── application.yml            # 主配置文件
│   │       ├── application-dev.yml        # 开发环境配置
│   │       ├── mapper/                    # MyBatis映射文件
│   │       └── static/                    # 静态资源
│   └── target/                           # 编译输出目录
├── ruoyi-common/         # 通用组件模块
│   ├── ruoyi-common-core/         # 核心工具类
│   ├── ruoyi-common-web/          # Web通用配置
│   ├── ruoyi-common-mybatis/      # MyBatis配置
│   ├── ruoyi-common-redis/        # Redis配置
│   ├── ruoyi-common-satoken/      # SaToken认证
│   └── [其他通用模块...]
├── ruoyi-modules/        # 业务模块
│   ├── ruoyi-system/             # 系统管理模块
│   ├── ruoyi-generator/          # 代码生成模块
│   ├── ruoyi-workflow/           # 工作流模块
│   ├── ruoyi-job/                # 任务调度模块
│   └── ruoyi-demo/               # 示例模块
├── ruoyi-extend/         # 扩展模块
│   ├── ruoyi-monitor-admin/      # 监控模块
│   └── ruoyi-snailjob-server/    # 任务调度服务
├── script/               # 脚本和SQL
│   ├── sql/                      # 数据库脚本
│   ├── docker/                   # Docker配置
│   └── bin/                      # 启动脚本
├── hot-start.sh          # 热启动脚本
├── start-*.sh            # 分步启动脚本
└── pom.xml               # Maven主配置文件

前端工程结构 (web/)

web/
├── src/
│   ├── api/              # API接口定义
│   │   ├── hq/                   # 后勤相关API
│   │   ├── system/               # 系统管理API
│   │   └── types.ts              # 类型定义
│   ├── assets/           # 静态资源
│   │   ├── images/               # 图片资源
│   │   ├── styles/               # 样式文件
│   │   └── icons/                # 图标资源
│   ├── components/       # 全局组件
│   │   ├── Pagination/           # 分页组件
│   │   ├── DictTag/              # 字典标签组件
│   │   └── [其他组件...]
│   ├── views/            # 页面视图
│   │   ├── hq/                   # 后勤管理页面
│   │   ├── system/               # 系统管理页面
│   │   └── login/                # 登录页面
│   ├── router/           # 路由配置
│   ├── store/            # 状态管理 (Pinia)
│   ├── utils/            # 工具函数
│   ├── types/            # TypeScript类型定义
│   ├── directive/        # 自定义指令
│   ├── lang/             # 国际化配置
│   ├── layout/           # 布局组件
│   ├── plugins/          # 插件配置
│   └── main.ts           # 入口文件
├── public/               # 公共资源
├── index.html            # HTML模板
├── vite.config.ts        # Vite配置
├── package.json          # NPM配置
├── tsconfig.json         # TypeScript配置
└── eslint.config.ts      # ESLint配置

移动端工程结构 (mobile/)

mobile/
├── src/
│   ├── pages/            # 页面
│   │   ├── index/                # 首页
│   │   ├── login/                # 登录页
│   │   ├── mine/                 # 个人中心
│   │   └── workbench/            # 工作台
│   ├── api/              # API接口
│   ├── utils/            # 工具类
│   ├── static/           # 静态资源
│   ├── config.js         # 配置文件
│   ├── App.vue           # 应用根组件
│   └── main.js           # 入口文件
├── manifest.json         # 应用配置
├── pages.json            # 页面路由配置
└── uni.scss             # 全局样式

文档工程结构 (docs/)

docs/
├── 项目总览/             # 项目概况和架构
├── 业务模块/             # 各业务模块详细文档
│   ├── property-maintenance/     # 物业报修模块
│   ├── hq-satisfaction-survey/  # 满意度调查模块
│   ├── hall-reservation/        # 报告厅预约模块
│   └── system-management/       # 系统管理模块
├── 需求文档/             # 需求分析和规格说明
├── 设计文档/             # 系统设计和架构文档
│   └── database/                # 数据库设计脚本
├── 开发文档/             # 开发指南和API文档
├── 测试文档/             # 测试计划和用例
├── 部署文档/             # 部署和运维文档
├── 中间件配置/           # 中间件配置说明
├── 变更管理/             # 代码变更记录
├── 知识库/               # 技术知识和最佳实践
└── 报告文档/             # 项目报告和总结

测试工程结构 (test/)

test/
├── [大量测试脚本文件.js]  # 功能测试脚本
├── [大量SQL文件.sql]      # 数据修复脚本
├── [大量报告文件.md]      # 测试和修复报告
├── package.json           # Node.js依赖配置
└── node_modules/          # Node.js依赖包

关键文件说明

配置文件

  • backend/ruoyi-admin/src/main/resources/application.yml - 主配置
  • web/vite.config.ts - 前端构建配置
  • mobile/manifest.json - 移动端应用配置

启动脚本

  • backend/hot-start.sh - 一键热启动所有服务
  • backend/start-monitor.sh - 启动监控服务
  • backend/start-job.sh - 启动任务调度服务
  • backend/start-main.sh - 启动主应用服务

数据库脚本

  • docs/设计文档/database/ - 数据库创建和更新脚本
  • backend/script/sql/ - RuoYi框架相关的数据库脚本

文档入口

  • docs/README.md - 文档中心总入口
  • 工程本地启动指导.md - 本地开发环境搭建指南
  • backend/README-热启动脚本.md - 热启动脚本使用说明