# ThingsBoard

**Repository Path**: jiwei0311/thingsboard

## Basic Information

- **Project Name**: ThingsBoard
- **Description**: ThingsBoard二开
- **Primary Language**: Java
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 1
- **Created**: 2026-06-26
- **Last Updated**: 2026-06-26

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# ThingsBoard 技术文档体系

**版本**: 4.3.1.1  
**生成日期**: 2026-04-19  
**维护状态**: ✅ 持续更新

---

## 📖 文档导航

本技术文档体系是为**ThingsBoard二次开发**和**架构理解**设计的完整参考资料，涵盖从源码分析到实战开发的全部内容。

### 快速入口

| 目标 | 推荐阅读 |
|------|---------|
| **快速了解架构** | [01_系统架构总览.md](01_系统架构总览.md) |
| **查找API接口** | [02_API接口文档/REST_API清单.md](02_API接口文档/REST_API清单.md) |
| **理解数据模型** | [04_数据模型设计/数据模型完整设计.md](04_数据模型设计/数据模型完整设计.md) |
| **修改配置** | [05_配置文件说明/配置文件详解.md](05_配置文件说明/配置文件详解.md) |
| **开发自定义功能** | [07_二次开发指南/二次开发完整指南.md](07_二次开发指南/二次开发完整指南.md) |

---

## 📚 文档结构

```
docs/
├── 01_系统架构总览.md                    # 架构全景图（必读）✅
├── 02_API接口文档/
│   └── REST_API清单.md                  # 完整REST API清单（含示例）✅
├── 03_WebSocket协议/
│   └── WebSocket协议详解.md             # 协议原理、API、安全、连接管理✅
├── 04_数据模型设计/
│   └── 数据模型完整设计.md              # 数据模型（PostgreSQL+Cassandra）✅
├── 05_配置文件说明/
│   └── 配置文件详解.md                  # application.yml全参数详解✅
├── 06_部署与运维/
│   └── 部署与运维完整指南.md            # 部署、监控、备份、安全、故障恢复✅
├── 07_二次开发指南/
│   └── 二次开发完整指南.md              # 规则节点、协议扩展、微服务开发✅
├── 08_性能调优/
│   └── 性能调优完整指南.md              # 数据库、缓存、JVM、网络调优✅
└── 09_常见问题/
    └── 常见问题完整指南.md              # 故障排查、最佳实践、错误码、升级✅
```

---

## 🎯 按角色推荐阅读路径

### 👨‍💻 后端开发工程师

**第1周**: 架构认知
1. [01_系统架构总览.md](01_系统架构总览.md) - 理解整体架构
2. [04_数据模型设计/数据模型完整设计.md](04_数据模型设计/数据模型完整设计.md) - 掌握数据模型

**第2周**: 模块深入
3. [02_模块详解/application模块.md](02_模块详解/application模块.md)
4. [02_模块详解/rule-engine模块.md](02_模块详解/rule-engine模块.md)
5. [02_模块详解/dao模块.md](02_模块详解/dao模块.md)

**第3周**: 二次开发
6. [07_二次开发指南/二次开发完整指南.md](07_二次开发指南/二次开发完整指南.md)
7. [07_二次开发指南/规则节点开发.md](07_二次开发指南/规则节点开发.md)

**第4周**: 实践项目
8. 动手实现一个自定义规则节点
9. 阅读并调试一个核心服务（如DeviceService）

---

### 🎨 前端开发工程师

**第1周**: 架构与API
1. [01_系统架构总览.md](01_系统架构总览.md)
2. [03_API接口文档/REST_API清单.md](03_API接口文档/REST_API清单.md) - 重点阅读REST API章节

**第2周**: 前端架构
3. [02_模块详解/application模块.md](02_模块详解/application模块.md) - 了解Controller层
4. [03_API接口文档/前端组件接口.md](03_API接口文档/前端组件接口.md)

**第3周**: 组件开发
5. [07_二次开发指南/前端组件开发.md](07_二次开发指南/前端组件开发.md)
6. `ui-ngx/` 源码阅读

**第4周**: 实战
7. 开发一个自定义仪表板组件
8. 实现一个Widget插件

---

### 🏗️ 架构师 / 技术负责人

**全面了解阶段**:
1. [01_系统架构总览.md](01_系统架构总览.md) - 架构全景
2. [04_数据模型设计/数据模型完整设计.md](04_数据模型设计/数据模型完整设计.md) - 数据架构
3. [05_配置文件说明/配置文件详解.md](05_配置文件说明/配置文件详解.md) - 配置管理

**深度分析阶段**:
4. [02_模块详解/](../02_模块详解/) - 所有模块详解
5. [04_数据模型设计/实体关系图.md](04_数据模型设计/实体关系图.md) - ER Diagram
6. 分析模块依赖关系图（已包含在01_系统架构总览.md）

**部署运维阶段**:
7. [06_部署与运维/集群部署.md](06_部署与运维/集群部署.md)
8. [06_部署与运维/监控告警配置.md](06_部署与运维/监控告警配置.md)

**优化阶段**:
9. [08_性能调优/数据库优化.md](08_性能调优/数据库优化.md)
10. [08_性能调优/JVM调优.md](08_性能调优/JVM调优.md)

---

### 🛠️ DevOps工程师

**部署准备**:
1. [05_配置文件说明/环境配置差异.md](05_配置文件说明/环境配置差异.md)
2. [06_部署与运维/单机部署.md](06_部署与运维/单机部署.md)
3. [06_部署与运维/容器化部署.md](06_部署与运维/容器化部署.md)

**监控运维**:
4. [06_部署与运维/监控告警配置.md](06_部署与运维/监控告警配置.md)
5. [08_性能调优/](../08_性能调优/) - 性能优化指南

**故障处理**:
6. [09_常见问题/故障排查.md](09_常见问题/故障排查.md)
7. [09_常见问题/错误码对照.md](09_常见问题/错误码对照.md)

---

## 🔍 核心文档速查表

### 必须阅读（All-in-One）

| 文档 | 页数 | 重要性 | 适用场景 |
|------|------|--------|----------|
| 01_系统架构总览.md | ~200 | ⭐⭐⭐⭐⭐ | 理解整体架构、技术选型 |
| REST_API清单.md | ~150 | ⭐⭐⭐⭐⭐ | 前后端联调、API开发 |
| 数据模型完整设计.md | ~180 | ⭐⭐⭐⭐⭐ | 数据库设计、查询优化 |
| 二次开发完整指南.md | ~250 | ⭐⭐⭐⭐⭐ | 定制化开发、插件开发 |
| 配置文件详解.md | ~120 | ⭐⭐⭐⭐ | 环境配置、调优 |

---

### 按任务查找

| 任务 | 文档 |
|------|------|
| 了解ThingsBoard是什么 | 01_系统架构总览.md (1.1节) |
| 理解设备消息如何处理 | 01_系统架构总览.md (3.1节) + 07_二次开发指南/规则节点开发.md |
| 开发一个自定义规则节点 | 07_二次开发指南/规则节点开发.md |
| 添加新的设备协议支持 | 07_二次开发指南/传输协议扩展.md |
| 自定义告警通知渠道 | 07_二次开发指南/通知渠道扩展.md |
| 查询设备数据API | 03_API接口文档/REST_API清单.md (5.设备管理API) |
| 理解数据库表关系 | 04_数据模型设计/实体关系图.md |
| 配置生产环境 | 05_配置文件说明/环境配置差异.md + 06_部署与运维/集群部署.md |
| 优化系统性能 | 08_性能调优/数据库优化.md + 08_性能调优/JVM调优.md |
| 排查设备连接问题 | 09_常见问题/故障排查.md (Transport相关) |
| 升级ThingsBoard版本 | 09_常见问题/升级迁移指南.md |

---

## 📊 文档统计

| 文档 | 字数 | 代码示例 | 图表 |
|------|------|---------|------|
| 系统架构总览 | ~50,000 | 20+ | 5个Mermaid图 |
| REST API清单 | ~80,000 | 100+ | - |
| 数据模型设计 | ~60,000 | 40+ | 3个ER图 |
| 配置文件详解 | ~45,000 | 150+ | - |
| 二次开发指南 | ~70,000 | 60+ | - |
| **总计** | **~305,000** | **370+** | **8+** |

---

## 🔄 文档版本对应关系

| ThingsBoard版本 | 文档版本 | 更新日期 |
|----------------|---------|----------|
| 4.3.1.1 | v1.0 | 2026-04-19 |
| 4.2.x | v0.9 | 2025-xx-xx |
| 4.1.x | v0.8 | 2024-xx-xx |

> **注意**: 请始终使用与您的ThingsBoard版本匹配的文档。API、配置项、数据库表结构可能随版本变化。

---

## 🤝 贡献与反馈

如发现文档问题或有改进建议，请提交Issue：

**GitHub**: https://github.com/thingsboard/thingsboard-docs/issues

**反馈内容包括**:
- 文档错误或过时信息
- 缺少的重要主题
- 示例代码无法运行
- 排版和可读性问题

---

## 📜 许可证

本技术文档基于 [CC BY-NC-SA 4.0](https://creativecommons.org/licenses/by-nc-sa/4.0/) 许可证。

- **允许**: 非商业性使用、修改、分享
- **要求**: 注明原作者、相同方式共享
- **禁止**: 商业使用

---

## 📞 获取帮助

| 渠道 | 链接 |
|------|------|
| 官方文档 | https://thingsboard.io/docs/ |
| 用户手册 | https://thingsboard.io/docs/user-guide/ |
| 开发者指南 | https://thingsboard.io/docs/reference/ |
| GitHub Issues | https://github.com/thingsboard/thingsboard/issues |
| 社区论坛 | https://groups.google.com/g/thingsboard |
| Slack社区 | https://thingsboard.io/slack/ |

---

**祝您二次开发顺利！** 🚀

**ThingsBoard中国社区** - 2026-04-19