Update README.md

This commit is contained in:
gitee-bot
2026-04-15 03:58:27 +00:00
committed by Gitee
parent 105559014f
commit 1153d58208

197
README.md
View File

@@ -2,18 +2,11 @@
# MPay V2 Webman # MPay V2 Webman
基于 Webman 框架开发的支付系统后台管理 API。 基于 Webman 高性能 PHP 框架开发的支付系统后台管理 API。
# 说明
Mpay V2 项目还在开发中,暂没有发布测试版本,欢迎收藏关注最新动态。
**个人乐观预计在 2026 年 高考前发布第一个版本,后端代码全开源,注释详细。**
## 项目简介 ## 项目简介
MPay V2 Webman 是一个采用 Webman 高性能 PHP 框架构建的支付系统后台管理接口,提供用户认证、权限管理、系统配置、菜单路由等核心功能 MPay V2 Webman 是一个采用 Webman 高性能 PHP 框架构建的支付系统后台管理接口,提供商户管理、支付通道配置、账户资金管理、订单交易、退款结算等核心功能。系统采用分层架构设计,包含完整的认证授权体系、权限管理、支付路由、通知回调等模块
## 技术栈 ## 技术栈
@@ -22,71 +15,84 @@ MPay V2 Webman 是一个采用 Webman 高性能 PHP 框架构建的支付系统
- **数据库**: MySQL - **数据库**: MySQL
- **缓存**: Redis - **缓存**: Redis
- **认证**: JWT - **认证**: JWT
- **架构模式**: MVC + Repository + Service
## 图片展示
<img src="doc/img/1.png" width=640 />
<img src="doc/img/2.png" width=640 />
<img src="doc/img/3.png" width=640 />
<img src="doc/img/4.png" width=640 />
<img src="doc/img/5.png" width=640 />
<img src="doc/img/6.png" width=640 />
<img src="doc/img/7.png" width=640 />
<img src="doc/img/8.png" width=640 />
<img src="doc/img/9.png" width=640 />
<img src="doc/img/10.png" width=640 />
<img src="doc/img/11.png" width=640 />
## 项目结构 ## 项目结构
``` ```
app/ mpay_v2_webman/
├── command/ # 命令行控制器 ├── app/ # 应用核心代码
├── common/ # 公共基础类 ├── command/ # 命令行控制器
│ ├── base/ # 基础类Controller、Model、Service、Repository │ ├── common/ # 公共基础类
│ ├── constants/ # 常量定义 │ ├── base/ # 基础类Controller、Model、Service、Repository
│ ├── enums/ # 枚举类 │ ├── constant/ # 常量定义
│ ├── middleware/ # 中间件 │ ├── enums/ # 枚举类
└── utils/ # 工具类 │ ├── interface/ # 接口定义
├── events/ # 事件类 │ │ ├── middleware/ # 中间件
├── exceptions/ # 异常类 │ │ ├── payment/ # 支付通道实现
├── http/ # HTTP 控制器 │ │ └── util/ # 工具类
── admin/ # 后台管理接口 ── exception/ # 异常类
├── controller/ # 控制器 ├── http/ # HTTP 控制器
── middleware/ # 中间件 ── admin/ # 后台管理接口
├── models/ # 数据模型 │ │ ├── api/ # 商户API接口
├── process/ # 进程管理 │ │ └── mer/ # 商户门户接口
├── repositories/ # 数据仓库 │ ├── listener/ # 事件监听
├── services/ # 业务服务 │ ├── model/ # 数据模型
└── validation/ # 验证器 │ ├── process/ # 进程管理
config/ # 配置文件 │ ├── repository/ # 数据仓库层
database/ # 数据库脚本 │ ├── route/ # 路由定义
doc/ # 文档 │ ├── service/ # 业务服务层
public/ # 公共资源 │ └── validation/ # 验证器
support/ # 框架支持类 ├── config/ # 配置文件
├── database/ # 数据库脚本
├── doc/ # 文档资源
├── public/ # 公共资源
└── support/ # 框架支持类
``` ```
## 核心功能 ## 核心功能
### 认证模块 ### 商户管理
- 用户登录/登出 - 商户信息管理
- 验证码生成与验证 - 商户分组配置
- JWT Token 认证 - 商户策略管理
- 用户信息获取 - API 凭证管理
### 权限管理 ### 支付通道
- 菜单路由管理 - 支付通道配置
- 用户角色关联 - 支付类型管理
- 支付插件管理
- 轮询通道组
- 支付路由解析
### 资金账户
- 账户余额查询
- 账户流水明细
- 冻结/解冻资金
- 账户充值/扣款
### 订单交易
- 支付订单创建
- 支付回调处理
- 订单状态管理
- 退款处理
### 结算管理
- 结算订单
- 结算周期配置
- 自动/手动结算
### 认证授权
- JWT Token 认证
- 后台用户管理
- 商户登录认证
- 权限中间件
### 系统配置 ### 系统配置
- 系统参数配置 - 系统参数配置
- 字典管理 - 字典管理
- 表单配置 - 菜单路由
- 配置缓存管理 - 配置缓存
### 中间件
- CORS 跨域处理
- 静态文件处理
- 认证鉴权
## 快速开始 ## 快速开始
@@ -118,71 +124,4 @@ composer install
5. 导入数据库 5. 导入数据库
```bash ```bash
mysql -u用户名 -p 数据库名 < database/ma_system_config.sql mysql -u用户名 -p 数据库名
```
6. 启动服务
```bash
# Linux/Mac
php start.php start
# Windows
windows.bat
```
## API 接口
### 认证接口
| 接口 | 方法 | 描述 |
|------|------|------|
| `/admin/auth/captcha` | GET | 获取验证码 |
| `/admin/auth/login` | POST | 用户登录 |
### 用户接口
| 接口 | 方法 | 描述 |
|------|------|------|
| `/admin/user/info` | GET | 获取当前用户信息 |
### 菜单接口
| 接口 | 方法 | 描述 |
|------|------|------|
| `/admin/menu/routers` | GET | 获取菜单路由 |
### 系统接口
| 接口 | 方法 | 描述 |
|------|------|------|
| `/admin/system/dict/{code}` | GET | 获取字典数据 |
| `/admin/system/tabs` | GET | 获取标签页配置 |
| `/admin/system/config/{tabKey}` | GET/POST | 获取/提交表单配置 |
## 异常处理
项目定义了以下自定义异常类:
- `BadRequestException` - 请求参数错误 (400)
- `UnauthorizedException` - 未授权 (401)
- `ForbiddenException` - 禁止访问 (403)
- `NotFoundException` - 资源不存在 (404)
- `ValidationException` - 参数校验失败 (422)
- `InternalServerException` - 系统内部错误 (500)
## 配置说明
主要配置文件位于 `config/` 目录:
- `app.php` - 应用配置
- `database.php` - 数据库配置
- `redis.php` - Redis 配置
- `jwt.php` - JWT 配置
- `route.php` - 路由配置
- `middleware.php` - 中间件配置
- `cache.php` - 缓存配置
- `log.php` - 日志配置
## 许可证
本项目基于 MIT 许可证开源。