Files
CN_Tool/tools/README.md

74 lines
1.8 KiB
Markdown
Raw Normal View History

2026-04-13 11:50:14 +08:00
# Tools 模块说明
## 当前状态
`tools` 当前是工具能力聚合模块,但在本仓库内已经完成一次收口。
2026-04-15 11:48:33 +08:00
当前真实保留的子模块有:
2026-04-13 11:50:14 +08:00
- `activate-tool`
2026-04-15 11:48:33 +08:00
- `wave-tool`
2026-04-13 11:50:14 +08:00
2026-04-15 11:48:33 +08:00
因此,`tools` 现阶段仍然是聚合模块,但当前已实际承载激活工具和波形查看工具两个子模块。
2026-04-13 11:50:14 +08:00
## 当前结构
```text
tools/
2026-04-15 11:48:33 +08:00
├── activate-tool/
└── wave-tool/
2026-04-13 11:50:14 +08:00
```
## activate-tool 的职责
`activate-tool` 当前提供的能力主要围绕设备授权与许可证:
- 生成设备申请码
- 生成激活码
- 校验激活码
- 读取本地许可证信息
从接口层看,当前主要围绕 `/activate/*` 路径提供能力。
2026-04-15 11:48:33 +08:00
## wave-tool 的职责
`wave-tool` 当前提供的能力主要围绕波形文本解析与查看数据组装:
- 解析单列幅值波形文本
- 解析双列时间/幅值波形文本
- 统计点位范围、均值、点数等摘要信息
- 按查看场景输出下采样后的点位集合
从接口层看,当前主要围绕 `/wave/*` 路径提供能力。
2026-04-13 11:50:14 +08:00
## 模块定位
当前 `activate-tool` 更适合作为平台级基础能力模块,而不是业务检测模块的一部分。
它的职责边界建议理解为:
- 负责授权相关的编码、解码和许可证文件处理
- 不负责检测业务本身
- 不负责系统级注册资源管理的全部逻辑
## 依赖关系
2026-04-15 11:48:33 +08:00
`tools/activate-tool``tools/wave-tool` 当前主要依赖:
2026-04-13 11:50:14 +08:00
- `com.njcn:njcn-common`
- `com.njcn:spingboot2.3.12`
并由 `entrance` 模块直接聚合使用。
## 文档说明
在本次 `P0` 收口前,`tools/README.md` 曾描述多个不存在于当前仓库中的工具子模块。
该描述已不再作为当前项目结构依据。
如果后续重新引入新的工具子模块,应:
- 同步更新 `tools/pom.xml`
- 同步更新本说明文档
-`docs` 下补充模块边界与职责说明