Files
WMSlite/WmsLite.Web/README.md
T
zhougfandCursor fa1b286463 Add WmsLite monorepo with JWT auth, tenant context, and project READMEs.
Implement API security baseline (sys_user, JWT, audit fields, transactions,
unique constraints) and Web real login with 401 handling. Document setup
and development workflows in root, WmsLite.Api, and WmsLite.Web README files.

Co-authored-by: Cursor <cursoragent@cursor.com>
2026-05-24 14:17:47 +08:00

110 lines
3.3 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# WmsLite.Web
Umi Max 4 + Ant Design 5 + ProComponents 前端,对接 [WmsLite.Api](../WmsLite.Api/README.md)。
仓库总览见 [../README.md](../README.md)。
## 技术栈
- React 18、TypeScript
- `@umijs/max` 4、Ant Design 5、ProComponents
- `react-activation` 多标签 Keep-Alive
## 功能概览
### 路由
| 路径 | 说明 |
|------|------|
| `/login` | 登录(无 Layout) |
| `/home` | 主页(默认落地页) |
| `/base/*` | 仓库、库区、分区、库位、物料、容器 |
| `/inventory/*` | 库存余额、库存流水 |
| `/orders/*` | 入库、出库、移库、盘点 |
| `/templates` | 系统模板 |
路由与标签标题:`config/config.ts`、`src/constants/routeTabTitles.ts`。
### 认证
- 登录:`POST /api/Auth/login`,成功后写入 `localStorage`:
- `wmslite-token` — JWT
- `wmslite-user` — 用户摘要 JSON
- 请求自动附加 `Authorization: Bearer <token>`(`app.tsx` 拦截器 + `services/api.ts`)。
- **401**:清除本地登录态,提示后跳转 `/login?redirect=...`。
- **不再**向 API 注入硬编码 `tenantId` / `ownerCode`;租户由服务端 JWT 解析。
- 全局字典 `DictionaryProvider` **仅在已登录时**加载 `/api/SysDictionary/map`。
默认开发账号:`admin` / `admin123`(见后端迁移种子)。
### 布局与多标签
- Mix 布局:侧边菜单 + 顶栏标签(`LayoutHeaderTabs`)。
- Keep-Alive 保留列表筛选与滚动(`LayoutKeepAliveOutlet`)。
- 标签 key = `pathname + search`,最多 12 个;批量关闭见顶栏「标签页 ▼」。
### 通用组件
- `CrudPage` — 主数据 CRUD + 分页
- `OrderPage` — 四类单据列表与操作
- 类型定义:`src/types/`(`inventory.ts`、`orders.ts`、`masterData.ts`)
## 本地开发
### 1. 启动后端
```powershell
cd ../WmsLite.Api
dotnet run --launch-profile http
```
后端默认 **http://localhost:9901**。
### 2. 安装依赖并启动前端
```powershell
cd WmsLite.Web
pnpm install
pnpm run dev
```
前端默认 **http://localhost:8000**,`/api` 代理至 `9901`(见 `config/config.ts`)。
### 3. 质量检查
```powershell
pnpm run lint # ESLint + Stylelint(max lint)
pnpm run typecheck # tsc --noEmit
pnpm run build # 生产构建
```
## 目录结构
```
WmsLite.Web/
├── config/config.ts # Umi 配置、路由、代理
├── src/
│ ├── app.tsx # 布局、request、getInitialState、退出登录
│ ├── services/api.ts # HTTP 封装、401 处理、业务 API
│ ├── utils/auth.ts # Token / 用户本地存储
│ ├── contexts/ # 字典、多标签
│ ├── components/ # CrudPage、OrderPage、Layout*
│ ├── pages/ # 业务页面
│ └── types/ # 前端 DTO 类型
├── .eslintrc.js
└── .stylelintrc.js
```
## 错误处理说明
| 场景 | 行为 |
|------|------|
| HTTP 401 | 清 token,已登录时提示「登录已失效」,跳转登录页 |
| `success: false` 业务错误 | Toast 展示 `message`,抛 `BusinessResultError` 避免重复弹窗 |
| 网络 / 5xx | 全局 `errorHandler` Toast |
## 说明
- 超长整型 ID:响应 JSON 经 `jsonSnowflakeParse` 处理,避免 JS 精度丢失。
- 若 API 未启动,代理会报 `ECONNREFUSED`,请先启动 `WmsLite.Api`。