70 lines
2.0 KiB
Markdown
70 lines
2.0 KiB
Markdown
|
[根目录](../CLAUDE.md) > **nflg-wms-gateway**
|
|||
|
|
|
|||
|
|
# nflg-wms-gateway - API 网关服务
|
|||
|
|
|
|||
|
|
## 模块职责
|
|||
|
|
|
|||
|
|
系统入口网关服务，基于 Spring Cloud Gateway 实现。负责：
|
|||
|
|
- 统一路由转发（基于 Nacos 服务发现自动路由）
|
|||
|
|
- Sa-Token 权限校验与鉴权
|
|||
|
|
- CORS 跨域处理
|
|||
|
|
- 链路追踪（TraceId 传递）
|
|||
|
|
- 健康检查与监控
|
|||
|
|
|
|||
|
|
## 入口与启动
|
|||
|
|
|
|||
|
|
| 项 | 值 |
|
|||
|
|
|----|-----|
|
|||
|
|
| 入口类 | `com.nflg.wms.gateway.GateWayApplication` |
|
|||
|
|
| 端口 | 8100 |
|
|||
|
|
| 服务名 | gateway-local |
|
|||
|
|
|
|||
|
|
## 关键依赖
|
|||
|
|
|
|||
|
|
- nflg-wms-common
|
|||
|
|
- nflg-wms-repository
|
|||
|
|
- Spring Cloud Gateway
|
|||
|
|
- Spring Cloud LoadBalancer
|
|||
|
|
- Spring Cloud Alibaba Nacos (Config + Discovery)
|
|||
|
|
- Sa-Token Reactor Spring Boot 3 Starter (响应式)
|
|||
|
|
- Sa-Token Redis Jackson
|
|||
|
|
- Redisson
|
|||
|
|
- Loki Logback Appender
|
|||
|
|
|
|||
|
|
**注意**：网关不依赖 nflg-wms-starter，使用独立的 Sa-Token 响应式配置。
|
|||
|
|
|
|||
|
|
## 关键目录说明
|
|||
|
|
|
|||
|
|
| 路径 | 说明 |
|
|||
|
|
|------|------|
|
|||
|
|
| `GateWayApplication.java` | 启动入口 |
|
|||
|
|
| `config/CorsWebFilter.java` | CORS 跨域过滤器配置 |
|
|||
|
|
| `satoken/SaTokenConfigure.java` | Sa-Token 网关层鉴权配置（响应式） |
|
|||
|
|
| `satoken/StpInterfaceImpl.java` | Sa-Token 权限接口实现 |
|
|||
|
|
| `service/AuthService.java` | 认证服务 |
|
|||
|
|
| `filter/TraceIdFilter.java` | TraceId 链路追踪过滤器 |
|
|||
|
|
| `definer/HostIpDefiner.java` | 主机 IP 定义器 |
|
|||
|
|
|
|||
|
|
## 配置
|
|||
|
|
|
|||
|
|
- 路由配置：通过 Nacos 服务发现自动路由 (`spring.cloud.gateway.discovery.locator.enabled: true`)
|
|||
|
|
- 服务 ID 小写化 (`lower-case-service-id: true`)
|
|||
|
|
|
|||
|
|
## 测试
|
|||
|
|
|
|||
|
|
- `DeployDevTest.java` - 开发环境部署测试
|
|||
|
|
- `DeploySitTest.java` - SIT 环境部署测试
|
|||
|
|
|
|||
|
|
## 相关文件清单
|
|||
|
|
|
|||
|
|
- `src/main/java/com/nflg/wms/gateway/` - 全部源码（7 个文件）
|
|||
|
|
- `src/main/resources/application*.yml` - 配置文件（4 个环境）
|
|||
|
|
- `src/main/resources/logback-spring.xml` - 日志配置
|
|||
|
|
- `pom.xml` - 模块依赖定义
|
|||
|
|
|
|||
|
|
## 变更记录 (Changelog)
|
|||
|
|
|
|||
|
|
| 时间 | 操作 | 说明 |
|
|||
|
|
|------|------|------|
|
|||
|
|
| 2026-05-23 14:16:58 | 初始化 | 首次生成模块文档 |
|