# pro-react-admin
**Repository Path**: wkylin/pro-react-admin
## Basic Information
- **Project Name**: pro-react-admin
- **Description**: Pro React Admin 是一款基于 React v19 的高性能、企业级中后台前端解决方案。深度整合 RBAC 动态权限、KeepAlive 缓存、多标签页与 AI 智能助手。提供开箱即用的国际化、暗黑模式、Mock 数据与 E2E 测试体系，助力开发者快速构建稳健、安全的 SaaS 平台与数据可视化系统
- **Primary Language**: JavaScript
- **License**: MIT
- **Default Branch**: main
- **Homepage**: https://wkylin.github.io/pro-react-admin/
- **GVP Project**: No
## Statistics
- **Stars**: 9
- **Forks**: 2
- **Created**: 2022-09-15
- **Last Updated**: 2026-02-03
## Categories & Tags
**Categories**: Uncategorized
**Tags**: None
## README
## 🚀 Pro React Admin
**Pro React Admin** 是一款基于 **React v19** 的高性能、企业级中后台前端解决方案。具备双重架构设计，既是完整的企业级应用，也是可发布的组件库 @w.ui/wui-react。 深度整合 **RBAC 动态权限**、**KeepAlive 缓存**、**多标签页**与 **AI 智能助手**。提供开箱即用的国际化、暗黑模式、Mock 数据与 E2E 测试体系，助力开发者快速构建稳健、安全的 SaaS 平台与数据可视化系统。
---
## 🌐 在线预览
- **主应用 (Main App)**: [https://wkylin.github.io/pro-react-admin/](https://wkylin.github.io/pro-react-admin/)
- **主应用 (Vercel App)**: [https://pro-react-admin.vercel.app/](https://pro-react-admin.vercel.app/)
- **组件文档 (Storybook)**: [https://wkylin.github.io/pro-react-admin/storybook/](https://wkylin.github.io/pro-react-admin/storybook/)
- **导航页 (Portal)**: [https://wkylin.github.io/pro-react-admin/portal.html](https://wkylin.github.io/pro-react-admin/portal.html)
---
## 🏆 项目亮点
- **🚀 极致性能体验**：基于 **React 19** 构建，重构 `KeepAlive` 缓存机制（采用 CSS 显隐策略替代 DOM 移动，大幅减少重排），配合 `useTransition` 实现丝滑的 Tab 切换与交互响应。
- **🧩 丰富组件生态**：沉淀 **120+** 高质量业务组件，支持 **独立打包发布 (@w.ui/wui-react)**。集成 **Storybook** 实现组件可视化开发与文档管理，显著提升复用效率。
- **🛡️ 企业级权限体系**：完善的 **RBAC** 模型，支持路由、菜单、按钮级细粒度权限控制。内置路由自动过滤、`useSafeNavigate` 防越权跳转，保障系统安全。
- **⚡️ 前沿技术栈**：采用 **TypeScript v5** + **Ant Design v6** + **Vite v7/Webpack v5** 双构建模式，紧跟社区最新标准，提供最佳开发体验。
- **🧩 多项目模式（共享依赖）**：通过 `PROJECT` 环境变量在同一仓库/同一套依赖（一个 `node_modules`）下承载多个业务项目；支持项目级入口与路由覆盖，按项目输出产物目录（`dist` / `dist-`），新项目仅需新增 `src/projects/` 业务代码。
- **🤖 AI 智能化集成**：内置 ChatGPT 演示（支持 SSE 流式响应）、Markmap 思维导图生成、Mermaid 流程图渲染，探索 AI 在后台管理中的应用场景。
- **🧪 全链路质量保障**：集成 **Playwright** E2E 自动化测试，配合 Mock Service Worker (MSW) 实现真实的网络模拟与多角色权限切换测试。
- **📱 极致移动端适配**：精心打磨的响应式布局，从 PC 到手机端提供一致的流畅体验。
- **⚙️ CI/CD 集成** ：GitHub Actions：自动构建部署到 GitHub Pages. Sentry 集成：可选的错误监控与源码上传
---
## 🔑 核心功能
- 🔐 **动态权限引擎**：登录后根据角色（Admin/Manager/Business/User）自动生成路由表，非权限路由自动拦截（403/404）。
- 📑 **高性能多标签页**：支持 `ProTabs` 多页签切换，状态持久化保持，支持右键菜单（关闭其他/关闭所有/刷新）。
- 📚 **组件文档库**：集成 Storybook，提供 120+ 组件的交互式文档与预览，支持 Props 动态调试与独立测试。
- 📡 **健壮请求层**：封装统一请求库，支持并发控制、自动重试、取消重复请求、全局错误处理与消息去重。
- 👤 **登录/注册流程**：完整的登录鉴权流程，支持一键测试账号切换，实时同步权限状态。
- 📊 **数据可视化**：集成 ECharts、Recharts 等多种图表库，支持大数据量展示。
- 📝 **富文本与文档**：支持 Markdown 实时渲染与编辑、代码高亮、数学公式解析。
- 🎬 **多媒体支持**：内置音频/视频播放器，支持 Tab 切换自动暂停/恢复播放，优化资源占用。
- 🌍 **主题与国际化**：内置明亮/暗黑模式一键切换，支持多语言（i18n）动态切换。
- 🧪 **Mock 数据模拟**：基于 Faker.js 和 MSW 的纯前端 Mock 方案，脱离后端独立开发。
- 📦 **组件库发布**：支持将 `src/components` 独立打包为 NPM 库 (`@w.ui/wui-react`)，提供 ESM/UMD 格式，支持按需加载与类型提示。
- 🧩 **多项目模式（共享依赖）**：一个仓库 + 一个 `node_modules` 承载多个业务项目；通过 `PROJECT` 选择入口与路由，Vite/Webpack 均可按项目构建与预览，避免重复 clone/重复安装依赖。
---
## 🧰 技术栈
- ⚛️ **Core**: React v19 / TypeScript v5
- 🎨 **UI**: Ant Design v6
- 🧭 **Router**: React Router v7
- ⚡ **Build**: Vite v7 / Webpack v5
- 🧪 **Test**: Playwright / Jest / Testing Library
- 🧪 **Mock**: Mock Server（Faker/MSW）
- 📏 **Lint**: ESLint / Prettier / Husky / Commitizen
- 🔍 **Quality**: Sentry / SonarQube / DeepScan
- 🐳 **Deploy**: Docker / Nginx / Github Actions
---
## 📁 目录结构
```text
pro-react-admin/
├── src/
│ ├── actions/ # Redux/Action 相关
│ ├── assets/ # 静态资源
│ ├── components/ # 业务组件
│ ├── config/ # 配置文件
│ ├── hooks/ # 自定义 hooks
│ ├── i18n/ # 国际化
│ ├── mock/ # Mock 数据
│ ├── pages/ # 页面模块
│ ├── reducers/ # Redux Reducer
│ ├── routers/ # 路由配置
│ ├── service/ # 请求与服务
│ ├── store/ # 状态管理
│ ├── styles/ # 全局样式
│ ├── theme/ # 主题相关
│ ├── utils/ # 工具函数
│ ├── App.tsx # 应用入口
│ └── index.tsx # 渲染入口
├── public/ # 公共资源
├── tests/ # 测试用例
├── docs/ # 文档
├── scripts/ # 脚本
├── api/ # Mock API 服务
├── ...
```
---
## 🚀 快速开始
```bash
git clone https://github.com/wkylin/pro-react-admin.git
cd pro-react-admin
npm install
npm run dev
```
## 🧩 多项目模式（共享依赖）
多项目模式的目标是：把“模板工程 + 基础设施 + 依赖”沉淀成一个仓库，后续新业务只需要在 `src/projects/` 里新增业务代码。
- 📘 详细文档： [多项目（Multi Project）模式](./docs/MULTI_PROJECT.md)
### ✅ 快速上手
项目通过环境变量 `PROJECT` 来选择当前项目（默认不传即主项目）。脚本已使用 `cross-env`，Windows/macOS/Linux 统一。
- Webpack 启动 ProjectA：`npm run start:projectA`
- Webpack 启动 ProjectB：`npm run start:projectB`
- Webpack 构建 ProjectB：`npm run build:production:projectB`
- Vite 启动 ProjectA：`npm run dev:vite:projectA`
- Vite 启动 ProjectB：`npm run dev:vite:projectB`
### 📁 目录约定
```text
src/projects/
/
index.tsx # 项目入口（可复用通用 renderApp）
routers/ # 项目路由（可选，存在则覆盖主路由）
index.jsx
authRouter.jsx
pages/ # 项目页面（可选）
components/ # 项目组件（可选）
public/ # 项目静态资源（可选，构建时叠加到 public）
```
### 🧭 路由覆盖与复用策略
- 默认情况下：`@routers` 指向 `src/routers`（主项目路由）。
- 若存在 `src/projects//routers/`：`@routers` 会指向项目路由，从而实现“同框架/同基础设施下的路由隔离”。
- 示例：
- `projectA` 使用“转发主路由”的方式实现最大化复用。
- `projectB` 落地“独立路由 + 独立 pages/components”，并演示直接复用主项目组件（如 `@stateless/*`）。
### 📦 产物目录与本地预览（dist 自动切换）
多项目构建时输出目录采用约定：
- 主项目：`dist/`
- 项目构建：`dist-/`（例如 `dist-projectB/`）
同时，`serve/http/clean` 相关脚本已改为自动指向当前项目的产物目录，避免手动切换路径。
提示：运行 `npm run lighthouse` 前请先启动 dev server（例如先执行 `npm run dev`/`npm run start`）。
### 🆕 如何新增一个新项目（推荐流程）
1) 新建目录：`src/projects//`
2) 添加入口：`src/projects//index.tsx`
3) （可选）添加路由覆盖：`src/projects//routers/index.jsx`
4) 新增 pages/components 业务代码
5) 复制一份脚本（参考 `projectA/projectB`）或直接使用 `cross-env PROJECT= ...` 启动/构建
更多用法详见 [详细文档](./docs/README_PERMISSION.md) 与 [用户角色权限说明](./docs/USER_ROLE_PERMISSION.md)。
---
## 🧩 微前端（Webpack Module Federation）POC
在“多项目模式”的基础上，仓库提供一个 **Webpack Module Federation** 的最小可运行 POC：
- Shell(host) 统一承载与导航
- projectA/projectB 以 remote 的形式被动态加载
- 目标部署形态：**同域名不同 path**（例如 `/`、`/projectA/`、`/projectB/`）
### ✅ 本地联调（3 个 devServer）
1) 启动两个 remote：
- `npm run start:mf:projectA`（默认 `http://localhost:8081/`，remoteEntry：`/remoteEntry.js`）
- `npm run start:mf:projectB`（默认 `http://localhost:8082/`，remoteEntry：`/remoteEntry.js`）
2) 启动 Shell(host)：
- `npm run start:mf:shell`（默认 `http://localhost:8080/`）
3) 访问：
- `http://localhost:8080/#/portal`
- `http://localhost:8080/#/projectA`
- `http://localhost:8080/#/projectB`
### 📦 生产构建与同域名不同 path 部署
- Shell(host)：`npm run build:mf:shell` → 输出到 `dist-shell/`
- projectA(remote)：`npm run build:mf:projectA` → 输出到 `dist-projectA/`
- projectB(remote)：`npm run build:mf:projectB` → 输出到 `dist-projectB/`
推荐的网关/Nginx 映射（示意）：
- `/` → `dist-shell/`
- `/projectA/` → `dist-projectA/`
- `/projectB/` → `dist-projectB/`
其中 remoteEntry 在生产默认按路径引用：
- projectA：`/projectA/remoteEntry.js`
- projectB：`/projectB/remoteEntry.js`
说明：
- 目前路由使用 Hash Router（`/#/...`），通常不依赖 history fallback。
- 这是 POC：remote 暴露的是 `src/projects//mfe/App.tsx` 对应的 `./App` 模块；Shell 通过 `import('projectA/App')` / `import('projectB/App')` 动态加载。
---
## 📝 近期主要更新
- ⚡ **性能优化**：重构 `KeepAlive` 实现，支持 React 19 `` (Offscreen) 原生冻结，降级模式采用 CSS 显隐替代 DOM 移动，大幅减少重排
- 🎨 **体验优化**：`ProTabs` 切换引入 `useTransition`，交互响应更流畅；`global-loader` 移除逻辑优化，消除首屏白屏与卡顿
- 🎬 **媒体控制**：音视频组件（MusicPlayer/Video）支持 Tab 切换自动暂停/恢复播放
- 🛠️ **开发体验**：`KeepAlive` 支持 HMR 热更新，开发调试状态不丢失
- 🛡️ **权限体系**：重构支持缓存、过期、强制刷新、单例获取，避免重复请求和竞态
- 🛣️ **路由过滤**：路由与菜单权限自动过滤，首页对所有账号可见
- 🔒 **安全跳转**：`useSafeNavigate`/`SafeLink` 封装，防止越权跳转
- 📡 **请求重构**：支持并发/串行/重试/取消/全局错误处理
- 🔔 **消息去重**：全局消息去重，避免重复弹窗干扰
- 🎭 **Mock 增强**：多角色切换与权限同步
- 🧪 **E2E 测试**：Playwright 核心场景覆盖
- 📚 **文档完善**：文档与示例持续更新
- **📦 组件库独立打包**: 新增 `@w.ui/wui-react` 组件库构建流程，支持 Vite Library Mode 打包 ESM/UMD 格式。
- **🚀 发布流程自动化**: 集成 `standard-version` 版本管理与 NPM 发布脚本，支持 Scoped Package 发布。
- **🎨 组件重构与优化**: 样式重构，适配移动端与暗黑模式。交互优化，支持自定义提示与自定义样式。规范化导出结构，修复模块解析问题。
- **🛠️ 构建配置升级**: 完善 `vite.config.lib.ts`，配置路径别名 (`@assets`, `@hooks` 等) 与外部依赖，确保构建产物纯净。
- **🧩 多项目模式（共享依赖）**：引入 `PROJECT` 环境变量，在同一仓库/同一套依赖（一个 `node_modules`）下承载多个业务项目；支持 **Vite / Webpack** 双构建链路按项目入口打包。
- **🧭 项目级路由覆盖**：通过别名 `@routers` 支持项目覆盖主路由；示例 `projectB` 已落地独立 `routers/pages/components`，并演示复用主项目组件（`@stateless/*`）。
- **🧰 dist 工具脚本**：`serve/http/clean` 相关脚本改为自动指向当前项目产物目录（`dist` / `dist-`），减少多项目场景下的重复维护。
- **✅ 构建验证**：`npm run build:production:projectB` 产物输出到 `dist-projectB/`。
---
## 🏗️ 技术架构
**多项目架构补充说明（Multi Project）**
- **入口约定**：默认入口为 `src/index.tsx`；项目入口为 `src/projects//index.tsx`，通过 `PROJECT=` 切换。
- **构建与产物**：Vite/Webpack 均支持按项目构建，产物目录采用 `dist` / `dist-` 的约定，便于部署与本地预览。
- **路由隔离与复用**：`@routers` 指向 `src/routers` 或 `src/projects//routers`（存在即覆盖）；从而实现“同一套基础设施 + 项目级路由差异”。
- **示例项目**：`projectA` 以“转发主路由”演示复用；`projectB` 以“独立路由 + 独立页面/组件”演示隔离与复用并存。
---
## 🦄 脚手架--白泽 baize
> **白泽**，中国古代神话中的瑞兽。能言语，通万物之情，知鬼神之事，“王者有德”才出现，能辟除人间一切邪气，可令人逢凶化吉。
>
> 本项目取名"白泽"，寓意作为开发者的瑞兽，帮助您辟除配置烦恼，逢凶化吉，快速启动高质量项目。
Baize CLI 是一个轻量、规范且高效的前端项目脚手架工具，旨在帮助开发者快速搭建基于 React、Vue 等现代框架的标准化项目结构。
- 🚀 快速启动：秒级生成项目模板，开箱即用。
- 🛠 规范集成：内置 ESLint、Prettier 等代码规范配置。
- 🎨 交互友好：优雅的命令行交互体验。
- 🌏 线上地址：[Baize](https://www.npmjs.com/package/baize-cli)
```bash
> npm install -g baize-cli
> baize
```
## 🔍 自动化持续代码审查工具
1. [DeepSource/](https://deepsource.io/)
2. [DeepScan](https://deepscan.io/)
3. [SonarQube](https://www.sonarsource.com/)
---
## 🐳 本地部署 SonarQube
1. [SonarQube for Mac](https://juejin.cn/post/7210005376652886077)
2. [Gitlab for Mac](https://juejin.cn/post/7210746685802397755)
3. [Gitlab CI/CD for Mac](https://juejin.cn/post/7214686619097874491)
---
## 📖 贡献指南
欢迎 PR、Issue 与 Star！
1. Fork 本仓库
2. 新建分支：`git checkout -b feature/xxx`
3. 提交更改：`git commit -m 'feat: 新增 xxx 功能'`
4. 推送分支：`git push origin feature/xxx`
5. 新建 Pull Request
---
## 📄 License
Apache-2.0 © [wkylin](https://github.com/wkylin)
---
## 📝 约定式提交
1. [约定式提交](https://www.conventionalcommits.org/zh-hans/v1.0.0/)
2. [语义化版本 2.0.0](https://semver.org/lang/zh-CN/)
---
## ⭐️ Star History
[](https://star-history.com/#wkylin/pro-react-admin&Date)
