- 重新组织文档结构,优化标题层级 - 添加系统架构图,直观展示系统组成- 补充前端架构、后端架构、数据架构等详细内容 - 更新安全架构、部署架构、性能优化策略等章节 - 增加扩展性设计和高可用设计章节 - 总结系统架构设计特点和优势
6.0 KiB
6.0 KiB
项目结构说明
1. 项目总体结构
xlxumu/
├── admin-system/ # 管理后台前端
├── backend-java/ # Java后端服务
├── backend/ # Node.js后端服务
├── docs/ # 项目文档
├── frontend/ # 用户端前端
├── miniprogram/ # 微信小程序
└── README.md # 项目说明
2. 前端项目结构
2.1 admin-system (管理后台)
admin-system/
├── public/
├── src/
│ ├── api/ # API接口
│ ├── assets/ # 静态资源
│ ├── components/ # 公共组件
│ ├── layout/ # 布局组件
│ ├── router/ # 路由配置
│ ├── store/ # 状态管理
│ ├── styles/ # 样式文件
│ ├── utils/ # 工具函数
│ ├── views/ # 页面组件
│ └── App.vue
├── .env # 环境变量
├── .eslintrc.js # ESLint配置
├── package.json # 依赖配置
└── vue.config.js # Vue配置
2.2 frontend (用户端)
frontend/
├── public/
├── src/
│ ├── api/ # API接口
│ ├── assets/ # 静态资源
│ ├── components/ # 公共组件
│ ├── composables/ # 组合式函数
│ ├── layout/ # 布局组件
│ ├── pages/ # 页面组件
│ ├── router/ # 路由配置
│ ├── stores/ # 状态管理
│ ├── styles/ # 样式文件
│ ├── utils/ # 工具函数
│ └── App.vue
├── .env # 环境变量
├── .eslintrc.js # ESLint配置
├── nuxt.config.ts # Nuxt配置
├── package.json # 依赖配置
└── tsconfig.json # TypeScript配置
2.3 miniprogram (微信小程序)
miniprogram/
├── components/ # 自定义组件
├── images/ # 图片资源
├── pages/ # 页面文件
├── utils/ # 工具函数
├── app.js # 小程序逻辑
├── app.json # 小程序公共设置
├── app.wxss # 公共样式
├── package.json # 依赖配置
└── project.config.json # 项目配置
3. 后端项目结构
3.1 Java后端 (backend-java)
backend-java/
├── README.md # 项目说明
├── pom.xml # Maven配置
├── common/ # 公共模块
│ ├── pom.xml
│ └── src/
├── config-server/ # 配置中心
│ ├── pom.xml
│ └── src/
├── gateway/ # 网关服务
│ ├── pom.xml
│ └── src/
├── registry/ # 注册中心
│ ├── pom.xml
│ └── src/
├── services/ # 业务服务
│ ├── farming-service/ # 养殖管理服务 (端口: 8081)
│ │ ├── pom.xml
│ │ └── src/
│ ├── user-center-service/ # 用户中心服务 (端口: 8082)
│ │ ├── pom.xml
│ │ └── src/
│ ├── trade-service/ # 交易服务 (端口: 8083)
│ │ ├── pom.xml
│ │ └── src/
│ ├── finance-service/ # 金融服务 (端口: 8084)
│ │ ├── pom.xml
│ │ └── src/
│ ├── data-platform-service/ # 数据平台服务 (端口: 8085)
│ │ ├── pom.xml
│ │ └── src/
│ ├── government-service/ # 政务服务 (端口: 8086)
│ │ ├── pom.xml
│ │ └── src/
│ ├── dashboard-service/ # 大屏服务 (端口: 8087)
│ │ ├── pom.xml
│ │ └── src/
│ └── mall-service/ # 商城服务 (端口: 8088)
│ ├── pom.xml
│ └── src/
└── scripts/ # 部署脚本
3.2 Node.js后端 (backend)
backend/
├── api/ # API接口
├── config/ # 配置文件
├── controllers/ # 控制器
├── middleware/ # 中间件
├── models/ # 数据模型
├── routes/ # 路由配置
├── services/ # 业务逻辑
├── utils/ # 工具函数
├── app.js # 应用入口
├── package.json # 依赖配置
└── server.js # 服务启动
4. 文档结构
docs/
├── README.md # 文档目录说明
├── API_DOCUMENTATION_STANDARD.md # API文档标准
├── API_DOCUMENTATION_MAINTENANCE.md # API文档维护流程
├── PROJECT_STRUCTURE.md # 项目结构说明
├── design/ # 设计文档
│ ├── ARCHITECTURE.md # 系统架构设计
│ ├── DEVELOPMENT_PLAN.md # 开发计划
│ ├── api/ # API设计
│ └── database/ # 数据库设计
├── development_plans/ # 开发计划
└── requirements/ # 需求文档
5. 部署配置
5.1 环境配置
.env: 开发环境配置.env.staging: 测试环境配置.env.production: 生产环境配置
5.2 Docker配置
docker-compose.yml: Docker编排配置Dockerfile: Docker镜像配置
6. 技术栈说明
6.1 前端技术栈
- Vue 3 + Element Plus (管理后台)
- Nuxt 3 (用户端)
- 微信小程序原生开发
6.2 后端技术栈
- Java Spring Boot (核心服务)
- Node.js Express (部分服务)
- MySQL (主数据库)
- Redis (缓存)
- RabbitMQ (消息队列)
6.3 DevOps工具
- Git (版本控制)
- Jenkins (持续集成)
- Docker (容器化)
- Kubernetes (容器编排)