67 lines
2.3 KiB
Markdown
67 lines
2.3 KiB
Markdown
[根目录](../CLAUDE.md) > **nflg-wms-starter**
|
||
|
||
# nflg-wms-starter - 统一启动器模块
|
||
|
||
## 模块职责
|
||
|
||
统一启动器基础模块，不可独立运行。为所有业务服务提供通用的 Spring Boot 自动配置：
|
||
- Sa-Token 认证配置
|
||
- Redis 配置
|
||
- Nacos 服务发现与配置中心
|
||
- 阿里云 OSS / RustFS 文件上传服务
|
||
- Jackson JSON 序列化配置
|
||
- RestTemplate 配置
|
||
- 全局异常处理
|
||
- API 分页结果封装
|
||
- 链路追踪过滤器
|
||
|
||
## 关键依赖
|
||
|
||
- nflg-wms-common
|
||
- nflg-wms-repository
|
||
- Spring Boot Starter Web
|
||
- Spring Cloud Alibaba Nacos (Config + Discovery)
|
||
- Spring Boot Starter Data Redis
|
||
- Sa-Token Spring Boot 3 Starter + SSO + JWT + Redis
|
||
- 阿里云 OSS SDK
|
||
- AWS S3 SDK (RustFS 兼容)
|
||
|
||
## 关键目录说明
|
||
|
||
| 路径 | 说明 |
|
||
|------|------|
|
||
| `config/` | 各类自动配置 |
|
||
| `config/SaTokenConfigure.java` | Sa-Token 全局认证配置（登录/登出/权限/SSO） |
|
||
| `config/AliyunOSSConfig.java` | 阿里云 OSS 对象存储配置 |
|
||
| `config/RustFSConfig.java` | RustFS (S3 兼容) 文件存储配置 |
|
||
| `config/RedisConfig.java` | Redis 序列化配置 |
|
||
| `config/JacksonConfig.java` | Jackson JSON 全局序列化/反序列化配置 |
|
||
| `config/RestTemplateConfig.java` | RestTemplate HTTP 客户端配置 |
|
||
| `advice/GlobalRestControllerAdvice.java` | 全局 REST 异常处理 |
|
||
| `annotation/ApiMark.java` | API 标记注解（用于权限标记） |
|
||
| `filter/TraceFilter.java` | 链路追踪过滤器 |
|
||
| `definer/HostIpDefiner.java` | 主机 IP 定义器（日志用） |
|
||
| `service/` | 公共服务 |
|
||
| `service/FileUploadService.java` | 文件上传服务接口 |
|
||
| `service/impl/OSSFileUploadServiceImpl.java` | OSS 文件上传实现 |
|
||
| `service/impl/RustFSServiceImpl.java` | RustFS 文件上传实现 |
|
||
| `service/BomMaterialService.java` | BOM 物料服务 |
|
||
| `pojo/ApiPageResult.java` | API 分页结果封装 |
|
||
| `BaseController.java` | Controller 基类（提供当前用户/分页等通用方法） |
|
||
| `utils/SpringContextHolder.java` | Spring 上下文持有器 |
|
||
|
||
## 测试
|
||
|
||
- `IdTest.java` - ID 生成测试
|
||
|
||
## 相关文件清单
|
||
|
||
- `src/main/java/com/nflg/wms/starter/` - 全部源码（17 个文件）
|
||
- `pom.xml` - 模块依赖定义
|
||
|
||
## 变更记录 (Changelog)
|
||
|
||
| 时间 | 操作 | 说明 |
|
||
|------|------|------|
|
||
| 2026-05-23 14:16:58 | 初始化 | 首次生成模块文档 |
|