# madong-Admin 后台管理框架（独立版） **Repository Path**: limevibe/madong-admin ## Basic Information - **Project Name**: madong-Admin 后台管理框架（独立版） - **Description**: 基于Webman框架企业级开源权限中台 - RBAC权限管理系统 - **Primary Language**: PHP - **License**: Apache-2.0 - **Default Branch**: main - **Homepage**: https://madong.tech - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 39 - **Created**: 2026-04-14 - **Last Updated**: 2026-04-14 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README # madong-server ## 介绍 madong-server 是 5.x 版本的后端服务，基于 PHP Webman 框架开发的极速开发平台，为前端应用提供稳定、高效的 API 服务。 ## 技术栈 | 技术 | 版本 | 说明 | |------|-----------|------| | PHP | 8.2 ~ 8.4 | 核心开发语言 | | Webman | 2.2 | 高性能 PHP 框架 | | MySQL | 8.0+ | 数据库 | | Redis | 7.0+ | 缓存服务 | | Composer | 2.x | 依赖管理工具 | | Nginx/Apache | - | Web 服务器 | ## 项目结构 ``` madong/ # 项目根目录 ├── backend/ # 后端目录（当前目录） │ ├── app/ # 应用目录 │ │ ├── adminapi/ # 管理后台 API（控制器、验证器等） │ │ ├── api/ # 前台 API（控制器、验证器等） │ │ ├── bootstrap/ # 启动引导文件 │ │ ├── command/ # 命令行工具 │ │ ├── dao/ # 数据访问层 │ │ ├── enum/ # 枚举类 │ │ ├── event/ # 事件定义 │ │ ├── install/ # 安装脚本 │ │ ├── listener/ # 事件监听器 │ │ ├── middleware/ # 中间件 │ │ ├── model/ # 模型 │ │ ├── process/ # 自定义进程 │ │ ├── queue/ # 队列任务 │ │ ├── schema/ # 数据结构定义 │ │ ├── scope/ # 作用域定义 │ │ ├── service/ # 业务服务层 │ │ └── functions.php # 全局函数 │ ├── config/ # 配置文件 │ │ ├── plugin/ # 插件配置 │ │ ├── route/ # 路由配置 │ │ └── *.php # 各类配置文件 │ ├── core/ # 核心框架 │ │ ├── base/ # 基础类 │ │ ├── cache/ # 缓存组件 │ │ ├── captcha/ # 验证码组件 │ │ ├── db/ # 数据库组件 │ │ ├── email/ # 邮件服务 │ │ ├── excel/ # Excel 导入导出 │ │ ├── exception/ # 异常处理 │ │ ├── generator/ # 代码生成器 │ │ ├── interface/ # 接口定义 │ │ ├── jwt/ # JWT 认证 │ │ ├── logger/ # 日志组件 │ │ ├── notify/ # 通知服务 │ │ ├── plugin/ # 插件核心 │ │ ├── route/ # 路由组件 │ │ ├── scheduler/ # 定时任务 │ │ ├── sms/ # 短信服务 │ │ ├── tool/ # 工具类 │ │ ├── trait/ # 特性类 │ │ ├── upload/ # 文件上传 │ │ ├── uuid/ # UUID 生成 │ │ └── functions.php # 核心函数 │ ├── plugin/ # 插件目录 │ ├── public/ # 静态资源 │ ├── resource/ # 资源文件 │ ├── runtime/ # 运行时文件 │ ├── support/ # 第三方支持库 │ ├── tests/ # 单元测试 │ ├── vendor/ # Composer 依赖包 │ ├── composer.json # Composer 配置 │ ├── composer.lock # 依赖锁定文件 │ ├── phinx.php # 数据库迁移配置 │ └── README.md # 项目说明文档 │ └── frontend/ # 前端目录（需单独下载） ├── admin/ # 管理后台前端 └── web/ # 前台前端 ``` > **注意**：前后端分离部署，前端目录需单独下载或创建。 ## 核心功能 - **用户认证**：基于 JWT 的身份验证机制 - **权限管理**：细粒度的权限控制体系 - **缓存服务**：集成 Redis 缓存，提升系统性能 - **邮件服务**：支持邮件发送功能 - **文件上传**：支持多种存储方式 - **国际化**：支持多语言配置 - **插件系统**：支持第三方扩展 - **命令行工具**：支持更多操作 - **SSE 实时推送**：支持 Server-Sent Events 实时进度反馈 - **服务层架构**：清晰的 DAO/Service 分层设计 - **代码生成器**：自动化生成控制器、模型、服务层代码 - **数据迁移**：支持数据库版本化管理 ## 运行环境 - PHP 8.2 ~ 8.4 - MySQL 8.0+ - Redis 7.0+ - Nginx/Apache - Composer 2.x+ ## 安装部署 ### 1. 环境准备 确保安装了以下软件： - PHP 8.2 ~ 8.4 - MySQL 8.0+ - Redis 7.0+ - Nginx/Apache - Composer 2.x+ - Git（用于下载前端资源） ### 2. 项目安装 ```bash # 进入后端目录 cd backend # 安装后端依赖 composer install ``` ### 3. 下载前端资源 **方式一：使用命令下载（推荐）** ```bash # 进入后端目录 cd backend # 下载所有前端代码（管理后台 + 前台） php webman madong-download:frontend # 仅下载管理后台 php webman madong-download:frontend --admin # 仅下载前台 php webman madong-download:frontend --web # 指定分支下载 php webman madong-download:frontend -b develop # 强制覆盖更新 php webman madong-download:frontend -f ``` **方式二：手动下载** 如果没有安装 Git 或无法使用命令，可手动下载前端代码： 1. 访问 Gitee 仓库下载： - 管理后台：https://gitee.com/motion-code/madong-vue - 前台：https://gitee.com/motion-code/madong-nuxt 2. 解压后将代码放置到项目根目录： ``` madong/ ├── backend/ # 后端代码 └── frontend/ # 前端代码 ├── admin/ # 管理后台前端（来自 madong-vue） └── web/ # 前台前端（来自 madong-nuxt） ``` ### 4. 启动安装向导 完成以上步骤后，访问安装向导完成系统配置： ``` http://127.0.0.1:8001/install ``` ### 5. 启动服务 ```bash # 进入后端目录 cd backend # 开发环境启动 php start.php start # 生产环境启动 php start.php start -d ``` 服务默认运行在 `http://127.0.0.1:8001` ## 配置说明 ### 数据库配置 修改 `config/database.php` 文件，配置数据库连接： ```php return [ 'default' => 'mysql', 'connections' => [ 'mysql' => [ 'driver' => 'mysql', 'host' => '127.0.0.1', 'port' => 3306, 'database' => 'madong', 'username' => 'root', 'password' => '123456', 'charset' => 'utf8mb4', 'collation' => 'utf8mb4_unicode_ci', 'prefix' => '', ], ], ]; ``` ### Redis 配置 修改 `config/redis.php` 文件，配置 Redis 连接： ```php return [ 'default' => [ 'host' => '127.0.0.1', 'port' => 6379, 'auth' => '', 'db' => 0, ], ]; ``` ## API 文档 启动服务后，可通过以下方式访问 API 文档： - 查看 `app/controller` 目录下的控制器文件 - 参考项目文档 ## 开发指南 ### 代码规范 - 遵循 PSR-4 自动加载规范 - 遵循 PSR-12 代码风格规范 - 使用 PHP 8.0+ 的特性 ### 模块开发 1. 创建控制器：在 `app/adminapi`（管理后台）或 `app/api`（前台）目录下创建控制器 2. 创建服务层：在 `app/service` 目录下创建业务逻辑 3. 创建 DAO 层：在 `app/dao` 目录下创建数据访问对象 4. 创建模型：在 `app/model` 目录下创建 Eloquent 模型 5. 配置路由：在 `config/route/adminapi.php` 或 `config/route/api.php` 文件中添加路由 6. 测试：使用 Postman 或其他工具测试 API ## 系统演示 管理后台： http://demo.madong.tech 账号：admin 密码：123456 ## 更新日志 ### 5.x 版本 - 重构后端架构，基于 Webman 框架 - 实现 JWT 认证机制 - 集成 Redis 缓存服务 - 优化数据库操作 - 增强插件系统，支持第三方扩展 - 完善配置系统，支持多环境配置 - 新增国际化支持，支持多语言 - 优化错误处理和日志系统 - 新增文件上传功能，支持多种存储方式 - 完善命令行工具，支持更多操作 - 新增 SSE 实时推送，支持插件安装/卸载进度实时反馈 - 新增服务层（Service）和数据访问层（DAO）分层架构 - 新增代码生成器，提升开发效率 - 优化插件安装/卸载流程，统一由插件 Install.php 管理生命周期 - 新增枚举类规范，统一状态码和业务枚举定义 ## 官方论坛 产品BUG、优化建议，欢迎社区反馈：http://www.madong.tech ## 如何贡献 非常欢迎你的加入！[提一个 Issue](https://gitee.com/motion-code/madong/issues) 或者提交一个 Pull Request。 **Pull Request:** 1. Fork 代码! 2. 创建自己的分支: `git checkout -b feature/xxxx` 3. 提交你的修改: `git commit -am 'feat(function): add xxxxx'` 4. 推送您的分支: `git push origin feature/xxxx` 5. 提交`pull request` ## Git 贡献提交规范 - 参考规范([Git](https://www.conventionalcommits.org/) [Vue](https://github.com/vuejs/vue/blob/dev/.github/COMMIT_CONVENTION.md) [Angular](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-angular)) - `feat` 增加新功能 - `fix` 修复问题/BUG - `style` 代码风格相关无影响运行结果的 - `perf` 优化/性能提升 - `refactor` 重构 - `revert` 撤销修改 - `test` 测试相关 - `docs` 文档/注释 - `chore` 依赖更新/脚手架配置修改等 - `ci` 持续集成 - `types` 类型定义文件更改 - `wip` 开发中 ## 维护者 [Mr.April](https://gitee.com/liu_guan_qing) ## 许可证 Apache License