115 lines
3.1 KiB
Markdown
115 lines
3.1 KiB
Markdown
|
[根目录](../CLAUDE.md) > **nflg-wms-common**
|
|||
|
|
|
|||
|
|
# nflg-wms-common - 公共模块
|
|||
|
|
|
|||
|
|
## 模块职责
|
|||
|
|
|
|||
|
|
公共基础模块，不包含任何业务逻辑，不可独立启动。为所有其他模块提供：
|
|||
|
|
- 通用 POJO 定义（QO/VO/DTO）
|
|||
|
|
- 常量定义
|
|||
|
|
- 异常类
|
|||
|
|
- 工具类
|
|||
|
|
- 函数式接口
|
|||
|
|
|
|||
|
|
## 关键依赖
|
|||
|
|
|
|||
|
|
- Hutool (工具库)
|
|||
|
|
- Sa-Token Core (权限 Token 核心)
|
|||
|
|
- MyBatis-Plus Core (分页等核心功能)
|
|||
|
|
- Jackson (JSON 序列化)
|
|||
|
|
- EEC (Excel 导出)
|
|||
|
|
- OkHttp (HTTP 客户端)
|
|||
|
|
- TinyPinyin (拼音转换)
|
|||
|
|
- Spring Data MongoDB (文档型数据模型)
|
|||
|
|
|
|||
|
|
## 关键目录说明
|
|||
|
|
|
|||
|
|
| 路径 | 说明 |
|
|||
|
|
|------|------|
|
|||
|
|
| `constant/` | 业务常量/枚举 |
|
|||
|
|
| `exception/` | 异常类 |
|
|||
|
|
| `function/` | 函数式接口 |
|
|||
|
|
| `pojo/` | 公共 POJO 容器 |
|
|||
|
|
| `pojo/qo/` | 查询/请求对象 (Query Object) |
|
|||
|
|
| `pojo/vo/` | 视图对象 (View Object) |
|
|||
|
|
| `pojo/dto/` | 数据传输对象 (Data Transfer Object) |
|
|||
|
|
| `pojo/document/` | MongoDB 文档模型 |
|
|||
|
|
| `util/` | 工具类 |
|
|||
|
|
|
|||
|
|
## 常量/枚举清单
|
|||
|
|
|
|||
|
|
| 类 | 说明 |
|
|||
|
|
|----|------|
|
|||
|
|
| `OrderState` | 订单状态枚举 |
|
|||
|
|
| `UserState` | 用户状态枚举 |
|
|||
|
|
| `UserType` | 用户类型枚举 |
|
|||
|
|
| `BarCodeType` | 条码类型枚举 |
|
|||
|
|
| `OperationType` | 操作类型枚举 |
|
|||
|
|
| `AduitLogType` | 审计日志类型枚举 |
|
|||
|
|
| `InventoryCheckTaskState` | 盘点任务状态枚举 |
|
|||
|
|
| `BarCodeProcessStage` | 条码处理阶段枚举 |
|
|||
|
|
|
|||
|
|
## 异常类清单
|
|||
|
|
|
|||
|
|
| 类 | 说明 |
|
|||
|
|
|----|------|
|
|||
|
|
| `NflgException` | 通用业务异常 |
|
|||
|
|
| `DataAlertException` | 数据告警异常 |
|
|||
|
|
| `SAPException` | SAP 集成异常 |
|
|||
|
|
|
|||
|
|
## 函数式接口清单
|
|||
|
|
|
|||
|
|
| 类 | 说明 |
|
|||
|
|
|----|------|
|
|||
|
|
| `BranchHandleFunction` | 分支处理函数 |
|
|||
|
|
| `ThrowExceptionFunction` | 抛异常函数 |
|
|||
|
|
| `ThrowBusinessExceptionFunction` | 抛业务异常函数 |
|
|||
|
|
| `TrueHandleFunction` | 真值处理函数 |
|
|||
|
|
|
|||
|
|
## 工具类清单
|
|||
|
|
|
|||
|
|
| 类 | 说明 |
|
|||
|
|
|----|------|
|
|||
|
|
| `MultilingualUtil` | 多语言工具 |
|
|||
|
|
| `ZipUtils` | 压缩工具 |
|
|||
|
|
| `StringUtil` | 字符串工具 |
|
|||
|
|
| `DateTimeUtil` | 日期时间工具 |
|
|||
|
|
| `Base62Util` | Base62 编码工具 |
|
|||
|
|
| `BeanUtil` | Bean 拷贝工具 |
|
|||
|
|
| `BomUtil` | BOM 工具 |
|
|||
|
|
| `EecExcelUtil` | EEC Excel 工具 |
|
|||
|
|
| `NumberUtil` | 数字工具 |
|
|||
|
|
| `PageUtil` | 分页工具 |
|
|||
|
|
| `UserUtil` | 用户工具 |
|
|||
|
|
| `VUtil` | 校验/断言工具 |
|
|||
|
|
|
|||
|
|
## 数据模型
|
|||
|
|
|
|||
|
|
### 核心 POJO
|
|||
|
|
- `ApiResult<T>` - 统一 API 响应包装
|
|||
|
|
- `PageData<T>` - 分页数据包装
|
|||
|
|
|
|||
|
|
### MongoDB 文档
|
|||
|
|
- `InMaterialScanRecord` - 入库物料扫码记录
|
|||
|
|
- `OutMaterialScanRecord` - 出库物料扫码记录
|
|||
|
|
- `InventoryCheckTaskScanRecord` - 盘点任务扫码记录
|
|||
|
|
- `PackageMaterialScanRecord` - 包装物料扫码记录
|
|||
|
|
- `SrmMaterialReceiptScanCodes` - SRM 物料收货扫码记录
|
|||
|
|
- `SrmMaterialReceiptNoScanCodes` - SRM 物料收货非扫码记录
|
|||
|
|
|
|||
|
|
## 测试
|
|||
|
|
|
|||
|
|
无独立测试文件。
|
|||
|
|
|
|||
|
|
## 相关文件清单
|
|||
|
|
|
|||
|
|
- `src/main/java/com/nflg/wms/common/` - 全部源码
|
|||
|
|
- `pom.xml` - 模块依赖定义
|
|||
|
|
|
|||
|
|
## 变更记录 (Changelog)
|
|||
|
|
|
|||
|
|
| 时间 | 操作 | 说明 |
|
|||
|
|
|------|------|------|
|
|||
|
|
| 2026-05-23 14:28:57 | 更新 | 补充完整工具类清单（3->12 个），增加常量/枚举/异常/函数式接口独立清单表格 |
|
|||
|
|
| 2026-05-23 14:16:58 | 初始化 | 首次生成模块文档 |
|