Skip to content

软件部分

本章节涵盖 YunStack-IoT 软件部分的实现设计,包括 NestJS 后端服务、微信小程序(UniApp)和 Web 管理后台(Vue 3)。

为了让您能够循序渐进地掌握软件部分的设计,我们建议按照以下顺序阅读文档:

📚 阅读路径建议

第一阶段:后端核心

目标:理解后端服务的整体架构、模块划分和数据模型。

  1. 整体软件架构
    • 必读。包含软件全景图、关键交互协议(HTTP/WebSocket/MQTT)、部署架构和 monorepo 目录结构。看完后您应该对软件体系有全局认知。
  2. 后台服务设计
    • 必读。NestJS 模块划分、MQTT 消息路由机制、设备状态管理策略和鉴权方案。后端开发的核心文档。
  3. 数据库设计
    • 必读。PostgreSQL 表结构(Prisma Schema)、InfluxDB 时序模型设计、索引策略和降采样规则。数据库设计和数据层开发的参考文档。

第二阶段:前端应用

目标:了解小程序和 Web 后台的项目结构和页面设计。

  1. 微信小程序
    • 开发参考。项目结构、页面清单(登录/首页/设备详情/设置等)、多种登录方式设计和 IoT 业务页面规划。
    • 界面与交互设计 — 设备列表、控制页、配网流程、家庭管理等页面的布局结构和交互流程。
    • 技术实现 — WebSocket 客户端、BLE 配网、Pinia 状态管理、物模型组件映射。
  2. Web 管理后台
    • 开发参考。项目结构、页面清单(系统管理/IoT 业务)、Pinia Store 模块设计。
    • 界面与交互设计 — 产品/设备管理、数据看板、固件升级等页面的布局结构和交互流程。
    • 技术实现 — WebSocket 集成、ECharts 图表、权限化 UI、固件上传流程。

第三阶段:开发参考

目标:开发时查阅协议规范和接口文档。

  1. 参考 架构与协议 章节中的 API 接口规范物模型设计规范 等协议文档进行开发。

⚡ 快速导航

模块文档说明
后端整体软件架构全景图、部署架构、目录结构
后端后台服务设计模块划分、MQTT 路由、设备状态管理、鉴权
后端数据库设计Prisma Schema、InfluxDB 时序模型、索引与降采样
小程序项目总览项目结构、页面清单、登录方式、IoT 页面设计
小程序界面与交互设计页面布局、组件交互、状态流转、配网流程
小程序技术实现WebSocket客户端、BLE配网、状态管理、组件映射
Web项目总览项目结构、系统管理页面、IoT 业务页面设计
Web界面与交互设计页面布局、数据看板、固件管理、升级任务
Web技术实现WebSocket集成、ECharts图表、权限UI、固件上传