项目初始化
This commit is contained in:
60
tools/README.md
Normal file
60
tools/README.md
Normal file
@@ -0,0 +1,60 @@
|
||||
# Tools 模块说明
|
||||
|
||||
## 当前状态
|
||||
|
||||
`tools` 当前是工具能力聚合模块,但在本仓库内已经完成一次收口。
|
||||
|
||||
当前真实保留的子模块只有:
|
||||
|
||||
- `activate-tool`
|
||||
|
||||
因此,`tools` 现阶段不是一个包含多个通用工具的完整工具市场,而是一个仅保留激活能力的聚合模块。
|
||||
|
||||
## 当前结构
|
||||
|
||||
```text
|
||||
tools/
|
||||
└── activate-tool/
|
||||
```
|
||||
|
||||
## activate-tool 的职责
|
||||
|
||||
`activate-tool` 当前提供的能力主要围绕设备授权与许可证:
|
||||
|
||||
- 生成设备申请码
|
||||
- 生成激活码
|
||||
- 校验激活码
|
||||
- 读取本地许可证信息
|
||||
|
||||
从接口层看,当前主要围绕 `/activate/*` 路径提供能力。
|
||||
|
||||
## 模块定位
|
||||
|
||||
当前 `activate-tool` 更适合作为平台级基础能力模块,而不是业务检测模块的一部分。
|
||||
|
||||
它的职责边界建议理解为:
|
||||
|
||||
- 负责授权相关的编码、解码和许可证文件处理
|
||||
- 不负责检测业务本身
|
||||
- 不负责系统级注册资源管理的全部逻辑
|
||||
|
||||
## 依赖关系
|
||||
|
||||
`tools/activate-tool` 当前主要依赖:
|
||||
|
||||
- `com.njcn:njcn-common`
|
||||
- `com.njcn:spingboot2.3.12`
|
||||
|
||||
并由 `entrance` 模块直接聚合使用。
|
||||
|
||||
## 文档说明
|
||||
|
||||
在本次 `P0` 收口前,`tools/README.md` 曾描述多个不存在于当前仓库中的工具子模块。
|
||||
该描述已不再作为当前项目结构依据。
|
||||
|
||||
如果后续重新引入新的工具子模块,应:
|
||||
|
||||
- 同步更新 `tools/pom.xml`
|
||||
- 同步更新本说明文档
|
||||
- 在 `docs` 下补充模块边界与职责说明
|
||||
|
||||
Reference in New Issue
Block a user