Files
CN_Tool/README.md

89 lines
2.4 KiB
Markdown
Raw Normal View History

2026-04-13 11:50:14 +08:00
# CN_Tool
CN_Tool 是一个基于 Spring Boot 的多模块后端聚合工程,当前仓库内保留的核心能力包括:
- 用户认证、用户/角色/菜单资源管理
- 系统字典、日志、系统配置、注册资源管理
- WebSocket / Netty 通信基础设施
- 激活码与许可证能力
2026-04-15 11:48:33 +08:00
- 波形文本解析与查看数据组装能力
2026-04-13 11:50:14 +08:00
## 当前真实模块
根聚合模块下当前包含以下子模块:
- `entrance`
- `system`
- `user`
- `detection`
- `tools`
2026-04-15 11:48:33 +08:00
其中 `tools` 当前包含:
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
## 启动入口
当前主启动入口位于:
- `entrance/src/main/java/com/njcn/gather/EntranceApplication.java`
2026-04-15 11:48:33 +08:00
`entrance` 模块聚合了 `system``user``detection``activate-tool``wave-tool`,是当前运行时主入口。
2026-04-13 11:50:14 +08:00
## 技术基线
- Java源码目标版本为 `1.8`
- Spring Boot`2.3.12.RELEASE`
- 构建方式Maven 多模块工程
- ORMMyBatis-Plus
- 数据库MySQL
## 运行与构建前提
当前项目存在以下前提条件:
- 需要可用的 JDK 8 环境
- 需要 Maven 环境
- 当前仓库未发现 `mvnw`
- 依赖私有 `com.njcn` 组件
-`pom.xml` 中存在内网 Nexus 发布仓库配置
- 运行前通常需要可访问的 MySQL 数据库和基础表数据
说明:
当前这份仓库并不保证在任意外部环境下可直接编译运行。
如果要做真实构建和启动,需要先满足内部依赖和环境条件。
## 文档入口
P0 已补齐基线文档,建议按以下顺序阅读:
1. [docs/01-项目总览.md](./docs/01-项目总览.md)
2. [docs/02-配置清单.md](./docs/02-配置清单.md)
3. [docs/03-构建与运行前提.md](./docs/03-构建与运行前提.md)
4. [docs/04-过时文档说明.md](./docs/04-过时文档说明.md)
## 模块说明
- `user`
- 负责认证、用户、角色、菜单资源相关能力
- `system`
- 负责字典、日志、系统配置、注册资源相关能力
- `detection`
- 当前以通信基础设施为主,包含 WebSocket / Netty 相关组件
- `tools/activate-tool`
- 负责激活码生成、激活码验证、许可证读取等能力
2026-04-15 11:48:33 +08:00
- `tools/wave-tool`
- 负责波形文本解析与查看数据组装能力
2026-04-13 11:50:14 +08:00
## 文档使用规则
当前仓库中部分历史说明仍然存在。
如文档之间出现冲突,建议按以下优先级理解:
1. `docs/` 下的基线文档
2.`README.md`
3. 各模块下的 `Readme.md`
4. 最终以源码和配置为准