first commit

This commit is contained in:
2025-09-24 14:08:54 +08:00
commit 40784642cf
83 changed files with 37832 additions and 0 deletions

202
debug_tools.md Normal file
View File

@@ -0,0 +1,202 @@
# Debug Tools - 调试工具集
## 工具集概述
Debug Tools 是 OneApp 开发阶段使用的调试工具集合,提供了全面的开发调试、性能监控、问题诊断等功能。这些工具仅在开发环境中使用,帮助开发团队快速定位问题、优化性能、监控应用状态。
## 工具列表
### 1. kit_debugtools (v0.2.4+1)
**核心调试工具包**
- 调试面板管理
- 开发者选项控制
- 调试信息展示
- 工具集成管理
### 2. kit_tool_dio (v0.2.4)
**网络请求调试工具**
- HTTP请求拦截和查看
- 请求/响应日志记录
- 网络性能分析
- API调试界面
### 3. kit_tool_console (v0.2.2)
**控制台日志工具**
- 实时日志查看
- 日志级别过滤
- 日志搜索功能
- 日志导出功能
### 4. kit_tool_channel_monitor (v0.2.2)
**原生通道监控工具**
- Flutter与原生代码通信监控
- Method Channel调用跟踪
- 参数和返回值查看
- 通信性能分析
### 5. kit_tool_device_info (v0.2.2)
**设备信息查看工具**
- 设备硬件信息展示
- 系统版本信息
- 应用安装信息
- 运行环境状态
### 6. kit_tool_memory (v0.2.3)
**内存监控工具**
- 实时内存使用监控
- 内存泄漏检测
- 垃圾回收分析
- 内存使用趋势图
### 7. kit_tool_ui (v0.2.3)
**UI调试工具**
- Widget树结构查看
- 布局边界显示
- 性能叠加层
- UI渲染分析
### 8. kit_tool_show_code (v0.2.3)
**代码查看工具**
- 源码快速查看
- 代码搜索功能
- 文件结构浏览
- 代码片段分享
## 主要功能
### 开发调试
```dart
// 启用调试工具
if (kDebugMode) {
DebugTools.init();
DebugTools.showDebugPanel();
}
// 网络请求调试
DioDebugTool.enableNetworkMonitoring();
// UI调试
UIDebugTool.showWidgetInspector();
```
### 性能监控
```dart
// 内存监控
MemoryTool.startMonitoring();
// 渲染性能
UITool.enablePerformanceOverlay();
// 通道监控
ChannelMonitor.startMonitoring();
```
### 日志管理
```dart
// 查看控制台日志
ConsoleTool.showLogs();
// 过滤错误日志
ConsoleTool.filterByLevel(LogLevel.error);
// 导出日志文件
ConsoleTool.exportLogs();
```
## 使用场景
### 开发阶段
- **问题诊断**:快速定位和分析问题
- **性能优化**:监控性能指标,识别瓶颈
- **功能测试**:验证新功能的正确性
- **兼容性测试**:测试不同设备的兼容性
### 测试阶段
- **回归测试**:确保新版本没有引入问题
- **压力测试**:监控高负载下的应用表现
- **用户体验测试**:分析用户交互流程
- **稳定性测试**:长时间运行监控
### 生产前验证
- **最终检查**:上线前的最后检查
- **性能基准**:建立性能基准数据
- **监控配置**:配置生产环境监控
- **问题预防**:预防潜在问题
## 集成方式
### 开发依赖配置
```yaml
dev_dependencies:
# 调试工具集
kit_debugtools: ^0.2.4+1
kit_tool_dio: ^0.2.4
kit_tool_console: ^0.2.2
kit_tool_channel_monitor: ^0.2.2
kit_tool_device_info: ^0.2.2
kit_tool_memory: ^0.2.3
kit_tool_ui: ^0.2.3
kit_tool_show_code: ^0.2.3
```
### 初始化配置
```dart
void main() {
// 仅在调试模式下启用调试工具
if (kDebugMode) {
_initDebugTools();
}
runApp(MyApp());
}
void _initDebugTools() {
// 初始化调试工具包
DebugTools.init(
enableNetworkMonitoring: true,
enableMemoryMonitoring: true,
enableUIDebugging: true,
enableConsoleLogging: true,
);
}
```
## 注意事项
### 使用限制
- **开发环境专用**:仅在开发和测试环境使用
- **性能影响**:调试工具会影响应用性能
- **内存占用**:会增加应用的内存使用
- **安全考虑**:不应在生产环境中包含
### 最佳实践
- **按需启用**:只启用需要的调试功能
- **及时关闭**:测试完成后及时关闭调试工具
- **版本控制**:确保生产版本不包含调试代码
- **文档记录**:记录调试过程和发现的问题
## 工具特色
### 易用性
- **一键启用**:简单的配置即可启用所有工具
- **直观界面**:清晰的调试界面和信息展示
- **快速操作**:快捷键和手势支持
- **智能提示**:自动识别和提示潜在问题
### 功能完整性
- **全面覆盖**覆盖网络、内存、UI、日志等各个方面
- **深度分析**:提供详细的分析数据和报告
- **实时监控**:实时监控应用运行状态
- **历史记录**:保存历史数据便于对比分析
### 扩展性
- **插件化设计**:支持自定义调试插件
- **API开放**提供开放的调试API
- **配置灵活**:支持灵活的配置选项
- **集成简单**:容易集成到现有项目中
## 总结
Debug Tools 调试工具集为 OneApp 的开发和测试提供了强大的支持。通过这套完整的调试工具,开发团队能够更高效地进行问题诊断、性能优化和质量保证,确保应用的稳定性和用户体验。
这些工具的设计原则是简单易用、功能全面、性能友好,帮助开发者在开发过程中快速定位问题,提升开发效率,保证代码质量。