Sumuxi/fastbee
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

20260427:CLAUDE.md

Browse Source
This commit is contained in:
zhugongping 2026-04-27 09:13:59 +08:00
parent 559bc19e23
commit f3d71e3826
1 changed files with 32 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
CLAUDE.md
View File

@ -1,10 +1,12 @@
# CLAUDE.md # CLAUDE.md
This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
本文件为 Claude Code (claude.ai/code) 在此代码库中工作时提供指导。 本文件为 Claude Code (claude.ai/code) 在此代码库中工作时提供指导。
## 项目概述 ## 项目概述
FastBee 是一个基于若依框架构建的物联网平台（v3.8.5）。后端为多模块 Spring Boot 应用，前端包含三个独立应用。所有 Java 包名使用 `com.fastbee`。 FastBee 是一个基于若依框架构建的物联网平台（v3.8.5）。后端为多模块 Spring Boot 应用（Java 8，Spring Boot 2.5.14），前端包含三个独立应用。所有 Java 包名使用 `com.fastbee`。
## 构建命令 ## 构建命令
@ -34,14 +36,18 @@ npm run lint # ESLint 代码检查
### 前端 - yack-view（Vue 3 + Vite，低代码可视化） ### 前端 - yack-view（Vue 3 + Vite，低代码可视化）
```bash ```bash
cd yack-view cd yack-view
pnpm install # 推荐使用 pnpm（npm 可能出现依赖下载失败）
pnpm dev # Vite 开发服务器
pnpm build # 生产环境构建
# 或使用 npm：
npm install npm install
npm run dev # Vite 开发服务器 npm run dev
npm run build # 生产环境构建 npm run build
npm run lint # ESLint 代码检查
# 或使用 Makefile： # 或使用 Makefile：
make dev make dev
make dist make dist
``` ```
部署：编译文件上传至 Nginx `/var/data/nginx/view/`，配置 `location ^~/view/` 挂载。访问地址：`https://[域名]/view/`。
### 前端 - yack-app（UniApp 移动端） ### 前端 - yack-app（UniApp 移动端）
```bash ```bash
@ -49,6 +55,10 @@ cd yack-app
npm install npm install
# 通过 HBuilderX 或 uni-app CLI 构建 # 通过 HBuilderX 或 uni-app CLI 构建
``` ```
配置：修改 `env.config.js` 设置服务端接口地址和 MQTT 地址。支持微信小程序、Android、iOS、H5。UI 框架为 uView 2.0。
### Docker 部署
`docker/` 目录包含 `docker-compose.yml` 和 EMQX 配置。用于快速部署完整 IoT 平台环境。
## 架构说明 ## 架构说明
@ -69,7 +79,7 @@ fastbee-server/ # 基于 Netty 的协议服务器
http-server/ # HTTP 设备接入服务器（端口 8081） http-server/ # HTTP 设备接入服务器（端口 8081）
tcp-server/ # TCP 服务器（端口 8888） tcp-server/ # TCP 服务器（端口 8888）
coap-server/ # CoAP 服务器（端口 5683） coap-server/ # CoAP 服务器（端口 5683）
sip-server/ # SIP 服务器 sip-server/ # SIP 服务器（GB28181 视频监控，需配合 ZLMediaKit 流媒体服务器）
boot-strap/ # 服务器启动引导 boot-strap/ # 服务器启动引导
fastbee-protocol/ # 协议编解码 fastbee-protocol/ # 协议编解码
base/ # 协议抽象层 base/ # 协议抽象层
@ -77,7 +87,7 @@ fastbee-protocol/ # 协议编解码
fastbee-iot-data/ # IoT 时序数据存储（支持 TDengine） fastbee-iot-data/ # IoT 时序数据存储（支持 TDengine）
fastbee-mq/ # RocketMQ 消息队列集成 fastbee-mq/ # RocketMQ 消息队列集成
fastbee-notify/ # 多渠道通知系统 fastbee-notify/ # 多渠道通知系统
fastbee-record/ # 设备数据记录/持久化 fastbee-record/ # 设备数据记录/持久化（视频录像需配合 ZLMediaKit）
fastbee-plugs/ fastbee-plugs/
generator/ # 代码生成器（Velocity 模板） generator/ # 代码生成器（Velocity 模板）
quartz/ # 定时任务管理 quartz/ # 定时任务管理
@ -171,3 +181,19 @@ SQL 初始化脚本位于 `sql/` 目录。主数据库：`fastbee`。最新完
## 代码生成 ## 代码生成
代码生成器模块（`fastbee-plugs/generator`）使用 Velocity 模板生成 Java + Vue 的 CRUD 脚手架代码。模板位于 `fastbee-plugs/generator/src/main/resources/vm/`。 代码生成器模块（`fastbee-plugs/generator`）使用 Velocity 模板生成 Java + Vue 的 CRUD 脚手架代码。模板位于 `fastbee-plugs/generator/src/main/resources/vm/`。
## MQTT 协议端口
| 协议 | 端口 | 说明 |
|:---|:---|:---|
| mqtt | 1883 | 未加密 TCP，硬件/服务端使用 |
| mqtts | 8883 | 加密 TCP，硬件/服务端使用 |
| ws | 8083 | 未加密 WebSocket，前端/移动端使用 |
| wss | 8084 | 加密 WebSocket，通过代理访问 8083 |
| wxs | 8084 | 微信小程序专用 |
微信小程序和 App 端使用 `wxs://` 协议连接 MQTT。
## GB28181 视频监控
`fastbee-server/sip-server` 实现国标 GB28181 协议，支持摄像头/录像机接入、设备直播、录像拉取、PTZ 云台控制。需部署 ZLMediaKit 流媒体服务器，通过其 API（`/index/api/`）管理 RTP 接收端口和流信息。