mojiahui/webman-buildadmin
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

优化描述文档

Browse Source
This commit is contained in:
zhenhui
2026-03-18 16:01:13 +08:00
parent 6a1cc94d04
commit 299c012063
2 changed files with 8 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@@ -1,8 +1,8 @@
# 大富翁 BuildAdmin 项目介绍 # 项目介绍
## 一、项目概述 ## 一、项目概述
**dafuweng-webman** 是基于 **Webman**（Workerman）的 BuildAdmin 后台管理系统，将原 ThinkPHP8 版 BuildAdmin 迁移到 Webman 框架，实现前后端分离、常驻内存运行，提供高性能、可扩展的后台管理能力。 **webman-builadmin** 是基于 **Webman**（Workerman）的 BuildAdmin 后台管理系统，将原 ThinkPHP8 版 BuildAdmin 迁移到 Webman 框架，实现前后端分离、常驻内存运行，提供高性能、可扩展的后台管理能力。
### 核心特性 ### 核心特性
@@ -49,7 +49,7 @@
## 三、项目结构 ## 三、项目结构
``` ```
dafuweng-webman/ webman-builadmin/
├── app/ # 应用代码 ├── app/ # 应用代码
│ ├── admin/ # 后台管理 │ ├── admin/ # 后台管理
│ │ ├── controller/ # 控制器（auth、user、routine、crud、security、mall 等） │ │ ├── controller/ # 控制器（auth、user、routine、crud、security、mall 等）
@@ -137,7 +137,7 @@ dafuweng-webman/
```bash ```bash
# 进入项目目录 # 进入项目目录
cd dafuweng-webman cd webman-builadmin
# 安装 PHP 依赖 # 安装 PHP 依赖
composer install composer install
@@ -193,7 +193,7 @@ pnpm dev
| 问题 | 修复说明 | | 问题 | 修复说明 |
|------|----------| |------|----------|
| 数据库配置不一致 | 统一 `database.php` 与 `thinkorm.php` 默认值为 `dafuweng-buildadmin` | | 数据库配置不一致 | 统一 `database.php` 与 `thinkorm.php` 默认值为 `webman-builadmin` |
| 语言 key 命名错误 | `quick Search Fields` 改为 `quickSearchFields` | | 语言 key 命名错误 | `quick Search Fields` 改为 `quickSearchFields` |
| 编辑时密码必填 | 编辑时密码可选，仅新增时必填；后端支持密码加密与重置 | | 编辑时密码必填 | 编辑时密码可选，仅新增时必填；后端支持密码加密与重置 |
| 多余表单校验 | 移除 `create_time`、`update_time` 的表单校验 | | 多余表单校验 | 移除 `create_time`、`update_time` 的表单校验 |
@@ -203,7 +203,7 @@ pnpm dev
## 八、注意事项 ## 八、注意事项
1. **错误目录**：若存在 `dafuweng-webmanweb` 目录，为路径拼写错误，建议删除或修正为 `dafuweng-webman/web`。 1. **错误目录**：若存在 `webman-builadmin` 目录，为路径拼写错误，建议删除或修正为 `webman-builadmin/web`。
2. **生产环境**：建议将 `config/app.php` 中 `debug` 改为从 `.env` 读取，例如 `env('app_debug', false)`。 2. **生产环境**：建议将 `config/app.php` 中 `debug` 改为从 `.env` 读取，例如 `env('app_debug', false)`。
3. **密码加密**：使用 `hash_password()` 存储密码，`verify_password()` 校验。 3. **密码加密**：使用 `hash_password()` 存储密码，`verify_password()` 校验。

4
docs/CRUD生成逻辑说明.md
View File

@@ -133,7 +133,7 @@
|--------------|------------------------|----------------------------------| |--------------|------------------------|----------------------------------|
| 数据库配置 | `config/database.php` | `config/thinkorm.php` | | 数据库配置 | `config/database.php` | `config/thinkorm.php` |
| 默认连接 | `config('database.default')` | `config('thinkorm.default')` | | 默认连接 | `config('database.default')` | `config('thinkorm.default')` |
| 根路径 | `root_path()` | `root_path()`（同，指向 dafuweng-webman 项目根） | | 根路径 | `root_path()` | `root_path()`（同，指向 webman-builadmin 项目根） |
| 控制器初始化 | `initialize()` 自动调用 | 在 `initializeBackend` 中调用 `$this->initialize()` | | 控制器初始化 | `initialize()` 自动调用 | 在 `initializeBackend` 中调用 `$this->initialize()` |
| XSS 过滤 | `$request->filter('clean_xss')` | `$inputFilter = 'clean_xss'`，由 Backend trait 在 add/edit 时应用 | | XSS 过滤 | `$request->filter('clean_xss')` | `$inputFilter = 'clean_xss'`，由 Backend trait 在 add/edit 时应用 |
@@ -147,7 +147,7 @@
- `$value` 有值：按自定义路径解析，会去掉 `app/$app/$type` 前缀 - `$value` 有值：按自定义路径解析，会去掉 `app/$app/$type` 前缀
- 预设：`admin`→`auth/admin`，`admin_rule`→`auth/rule` 等 - 预设：`admin`→`auth/admin`，`admin_rule`→`auth/rule` 等
**示例（表名 `xxx_yyy_zzz`，均相对于 dafuweng-webman 项目根）：** **示例（表名 `xxx_yyy_zzz`，均相对于 webman-builadmin 项目根）：**
| 配置项 | 默认值 | 公共模型时 | | 配置项 | 默认值 | 公共模型时 |
|------------------|------------------------------------------|----------------------------------------| |------------------|------------------------------------------|----------------------------------------|