183 lines
29 KiB
Plaintext
183 lines
29 KiB
Plaintext
# RXThinkCMF ThinkPHP8+AntDesign 开发文档
|
||
|
||
> RXThinkCMF 企业级前后端分离后台管理系统 - ThinkPHP8 + Vue3 + AntDesign。支持五种数据库一键切换、RBAC 按钮级权限、多租户数据隔离、声明式 CRUD 基座与代码生成器。本文档共 140 篇，按章节组织。
|
||
|
||
## 1. 了解项目
|
||
|
||
- [1.1 项目介绍](http://docs.thinkphp8.antdvue.rxthink.cn/zh/introduction.html): RXThinkCMF 是企业级前后端分离后台管理系统，后端基于 ThinkPHP 8，前端基于 Vue3 + AntDesign，内置 RBAC 按钮级权限、多租户数据隔离、代码生成器等开箱即用功能，
|
||
- [1.2 为什么选择我们](http://docs.thinkphp8.antdvue.rxthink.cn/zh/why.html): 本页从架构可维护性、功能开箱即用与工程可持续性三个维度说明选择本项目的理由，技术选型对比时可作为评估依据。
|
||
- [1.3 目录结构](http://docs.thinkphp8.antdvue.rxthink.cn/zh/directory.html): + 保持一致性：目录结构一旦确定，应保持一致性，避免随意更改。
|
||
- [1.4 新手入门指南](http://docs.thinkphp8.antdvue.rxthink.cn/zh/course.html): 详细的安装步骤请参考 开发环境准备 章节。
|
||
- [1.5 技术栈说明](http://docs.thinkphp8.antdvue.rxthink.cn/zh/tech-stack.html): 本页列出项目前后端完整技术选型与版本要求，包含语言、框架、核心依赖及其选型理由，评估兼容性或升级影响时对照本表。
|
||
- [1.6 更新日志](http://docs.thinkphp8.antdvue.rxthink.cn/zh/changelog.html): 更新日志是项目演进的完整记录，帮助开发者和企业了解每个版本的能力变化与技术演进方向。
|
||
- [常见问题汇总](http://docs.thinkphp8.antdvue.rxthink.cn/zh/faq.html): 本页汇总了项目各模块的常见问题及解决方案，按场景分类索引。
|
||
|
||
## 2. 快速入门
|
||
|
||
- [2.1 开发环境准备](http://docs.thinkphp8.antdvue.rxthink.cn/zh/quickstart/environment.html): 本章指导您从零搭建开发环境，包括 PHP、Composer、数据库、Node.js 的安装与配置。
|
||
- [2.2 后端服务启动](http://docs.thinkphp8.antdvue.rxthink.cn/zh/quickstart/backend-start.html): 1. 源码包请务必从官方网站订单中心下载，确保获取的是正版授权的最新版本。
|
||
- [2.3 前端服务启动](http://docs.thinkphp8.antdvue.rxthink.cn/zh/quickstart/frontend-start.html): 本章指导您启动前端开发服务器，包括依赖安装、环境配置和 Vite 开发服务器启动。
|
||
- [2.4 数据库初始化](http://docs.thinkphp8.antdvue.rxthink.cn/zh/quickstart/database-init.html): 本章指导您完成数据库的创建和 SQL 脚本导入。
|
||
- [2.5 环境变量配置](http://docs.thinkphp8.antdvue.rxthink.cn/zh/quickstart/env-vars.html): 项目使用 .env 文件管理环境变量，支持开发、测试、生产等多环境切换。
|
||
- [2.6 第一个接口调试](http://docs.thinkphp8.antdvue.rxthink.cn/zh/quickstart/first-api.html): 本章通过实际操作，带您完成第一个 API 接口的调试，从登录获取 Token 到调用业务接口。
|
||
- [2.7 Docker 快速体验](http://docs.thinkphp8.antdvue.rxthink.cn/zh/quickstart/docker.html): Docker 方案适合快速体验项目功能，无需手动安装 PHP、MySQL 等环境。
|
||
- [2.8 常见问题 FAQ](http://docs.thinkphp8.antdvue.rxthink.cn/zh/quickstart/faq.html): 本页收录环境搭建与首次运行阶段的常见问题，按环境、数据库与启动等场景分类，快速入门受阻时优先按症状查阅。
|
||
|
||
## 3. 模块开发实战
|
||
|
||
- [3.1 概述与目标](http://docs.thinkphp8.antdvue.rxthink.cn/zh/guide/overview.html): 本章以项目内置的 example（案例演示） 模块为例，从数据库建表到前端页面联调，手把手演示开发全流程。
|
||
- [3.2 数据库建表](http://docs.thinkphp8.antdvue.rxthink.cn/zh/guide/database.html): 建表是模块开发的第一步。
|
||
- [3.3 模型层开发](http://docs.thinkphp8.antdvue.rxthink.cn/zh/guide/model.html): 模型层负责定义数据库表的映射关系，继承 BaseModel 后自动获得软删除和审计字段能力。
|
||
- [3.4 验证器开发](http://docs.thinkphp8.antdvue.rxthink.cn/zh/guide/validator.html): 验证器用于校验请求参数的合法性，继承 ThinkPHP 的 Validate 类。
|
||
- [3.5 逻辑层开发](http://docs.thinkphp8.antdvue.rxthink.cn/zh/guide/logic.html): 逻辑层是业务核心，通过"属性配置 + 生命周期钩子"实现声明式 CRUD。
|
||
- [3.6 控制器开发](http://docs.thinkphp8.antdvue.rxthink.cn/zh/guide/controller.html): 控制器是 HTTP 请求的入口，负责参数获取、调用 Logic 层、返回 JSON 响应。
|
||
- [3.7 路由注册](http://docs.thinkphp8.antdvue.rxthink.cn/zh/guide/route.html): 路由定义在 route/app.php 中，按模块分组注册。
|
||
- [3.8 权限节点配置](http://docs.thinkphp8.antdvue.rxthink.cn/zh/guide/permission.html): 权限节点用于控制用户能访问哪些接口。
|
||
- [3.9 前端联调指引](http://docs.thinkphp8.antdvue.rxthink.cn/zh/guide/frontend-integration.html): 后端接口开发完成后，需要在前端创建对应的 API 模块和页面组件。
|
||
- [3.10 完整代码清单](http://docs.thinkphp8.antdvue.rxthink.cn/zh/guide/code-list.html): 本节汇总 example（案例演示）模块涉及的所有文件，方便开发时快速定位。
|
||
- [3.11 常见问题与排错](http://docs.thinkphp8.antdvue.rxthink.cn/zh/guide/faq.html): 本页汇总模块开发实战中的常见问题与排错方法，按前后端分类覆盖 401/403、路由注册、参数校验等高频问题，开发受阻时按症状索引即可定位。
|
||
|
||
## 4. 架构设计
|
||
|
||
- [4.1 整体架构概览](http://docs.thinkphp8.antdvue.rxthink.cn/zh/architecture/overview.html): 本章从全局视角阐述系统的整体技术架构，涵盖前端、后端、数据库及基础设施等核心组成部分，旨在帮助开发者快速建立对系统全貌的清晰认知。
|
||
- [4.2 请求处理链路](http://docs.thinkphp8.antdvue.rxthink.cn/zh/architecture/request-flow.html): 一个典型的 API 请求经过以下阶段：浏览器 → Nginx → CORS 中间件 → Auth 中间件（JWT 认证 + RBAC 鉴权）→ Tenant 中间件 → Demo 中间件 → Log
|
||
- [4.3 后端分层架构](http://docs.thinkphp8.antdvue.rxthink.cn/zh/architecture/backend-layer.html): 后端采用"三层主干 + 三层支撑"架构：Controller → Logic → Model 构成主干链路，Validate、Service、Middleware 分别提供参数校验、通用能力、
|
||
- [4.4 前端分层架构](http://docs.thinkphp8.antdvue.rxthink.cn/zh/architecture/frontend-layer.html): 前端采用 Vue 3 + TypeScript 组件化架构，分为 View（视图）→ API（接口）→ Store（状态）→ HTTP（请求）四层。
|
||
- [4.5 目录结构设计](http://docs.thinkphp8.antdvue.rxthink.cn/zh/architecture/directory-design.html): 目录结构遵循"按职责分层、按模块分组"的原则。
|
||
- [4.6 核心基类体系](http://docs.thinkphp8.antdvue.rxthink.cn/zh/architecture/base-classes.html): 项目有四个核心基类，构成"控制器 → 逻辑层 → 模型"三层架构的骨架。
|
||
- [4.7 横切机制](http://docs.thinkphp8.antdvue.rxthink.cn/zh/architecture/cross-cutting.html): 横切机制是 BaseLogic/BaseModel 内置的自动处理能力，开发者通过属性配置启用，无需手动编写处理代码。
|
||
- [4.8 缓存架构设计](http://docs.thinkphp8.antdvue.rxthink.cn/zh/architecture/cache.html): 项目采用两级缓存架构：请求级缓存（内存）+ 持久缓存（file/Redis），大幅减少数据库查询。
|
||
- [4.9 数据库设计](http://docs.thinkphp8.antdvue.rxthink.cn/zh/architecture/database-design.html): 项目支持 MySQL、PostgreSQL、SQL Server、Oracle、SQLite 五种数据库，通过 .env 的 DATABASE.TYPE 一键切换。
|
||
- [4.10 安全架构设计](http://docs.thinkphp8.antdvue.rxthink.cn/zh/architecture/security.html): 本章详细阐述系统的安全架构设计，围绕认证、授权、防护、审计四大安全领域展开，旨在帮助开发者全面理解系统的安全保障体系。
|
||
- [4.11 扩展性设计](http://docs.thinkphp8.antdvue.rxthink.cn/zh/architecture/extensibility.html): 系统通过六种机制保证良好的扩展性：属性配置、生命周期钩子、自动参数校验、中间件链、注解系统、服务层复用。
|
||
|
||
## 5. 核心功能
|
||
|
||
- [5.1 用户认证（JWT）](http://docs.thinkphp8.antdvue.rxthink.cn/zh/core/jwt.html): JWT（JSON Web Token）是系统的核心认证机制。
|
||
- [5.2 认证流程实战](http://docs.thinkphp8.antdvue.rxthink.cn/zh/core/auth-flow.html): 本节通过完整的请求链路，展示从登录到接口调用的认证全流程，包括登录、Token 刷新、接口认证、权限校验、租户隔离五个核心环节。
|
||
- [5.3 验证码机制](http://docs.thinkphp8.antdvue.rxthink.cn/zh/core/captcha.html): CaptchaService 提供图片验证码的生成与验证，用于登录等需要人机校验的场景。
|
||
- [5.4 权限管理（RBAC）](http://docs.thinkphp8.antdvue.rxthink.cn/zh/core/rbac.html): 系统采用 RBAC（基于角色的访问控制）权限模型，通过"用户 → 角色 → 菜单/权限"三层关系实现细粒度的权限控制。
|
||
- [5.5 跨域资源共享（CORS）](http://docs.thinkphp8.antdvue.rxthink.cn/zh/core/cors.html): CorsMiddleware 处理跨域请求，支持通过 .env 动态配置允许的来源域名。
|
||
- [5.6 密码加密服务](http://docs.thinkphp8.antdvue.rxthink.cn/zh/core/password.html): PasswordService 基于 bcrypt 实现双重加盐密码加密，全系统的密码加解密均通过本服务完成，包括登录校验、新建用户、重置密码、租户账号创建等场景。
|
||
- [5.7 演示模式](http://docs.thinkphp8.antdvue.rxthink.cn/zh/core/demo-mode.html): 演示模式是系统内置的安全机制，用于公共演示环境的数据保护。
|
||
- [5.8 多租户隔离](http://docs.thinkphp8.antdvue.rxthink.cn/zh/core/tenant.html): 采用共享数据库、共享表、tenant_id 字段隔离的方案。
|
||
- [5.9 数据权限](http://docs.thinkphp8.antdvue.rxthink.cn/zh/core/data-scope.html): 数据权限控制用户能看到哪些数据，基于角色的 data_scope 字段进行过滤。
|
||
- [5.10 字典模块](http://docs.thinkphp8.antdvue.rxthink.cn/zh/core/dict.html): DictService 提供字典项的读取、正反向转换与缓存管理，是字典体系的核心服务。
|
||
- [5.11 字典配置与使用](http://docs.thinkphp8.antdvue.rxthink.cn/zh/core/dict-guide.html): 数据字典的完整使用流程，从新增字典类型到在代码中使用字典数据的实操指南。
|
||
- [5.12 系统配置管理](http://docs.thinkphp8.antdvue.rxthink.cn/zh/core/config.html): 系统配置管理用于动态配置参数，支持分组管理。
|
||
- [5.13 系统参数管理](http://docs.thinkphp8.antdvue.rxthink.cn/zh/core/param.html): ParamService 管理系统级参数，如默认密码、系统名称等，采用两级缓存（请求级 + 持久缓存），大幅减少数据库查询。
|
||
- [5.14 操作日志](http://docs.thinkphp8.antdvue.rxthink.cn/zh/core/operation-log.html): 操作日志通过 #[Log] 注解 + LogMiddleware 自动记录，无需手动埋点。
|
||
- [5.15 登录日志](http://docs.thinkphp8.antdvue.rxthink.cn/zh/core/login-log.html): 登录日志记录用户的登录/登出行为，包括成功和失败记录。
|
||
- [5.16 异常与响应处理](http://docs.thinkphp8.antdvue.rxthink.cn/zh/core/exception.html): ExceptionHandle 将所有异常统一渲染为 JSON 响应，保证前端始终拿到结构一致的错误信息。
|
||
- [5.17 防重复提交](http://docs.thinkphp8.antdvue.rxthink.cn/zh/core/idempotent.html): 防重复提交是保障数据一致性的重要措施。
|
||
- [5.18 注解系统总览](http://docs.thinkphp8.antdvue.rxthink.cn/zh/core/attributes.html): 项目使用 PHP 8 原生注解（Attribute）实现声明式配置，目前有三个注解类，由 AttributeService 通过反射读取。
|
||
|
||
## 6. 业务模块
|
||
|
||
- [6.1 用户管理](http://docs.thinkphp8.antdvue.rxthink.cn/zh/modules/user.html): 用户管理是系统核心模块，继承 BaseTenantLogic 实现租户隔离，支持 CRUD、重置密码、Excel 导入导出。
|
||
- [6.2 角色管理](http://docs.thinkphp8.antdvue.rxthink.cn/zh/modules/role.html): 角色管理是 RBAC 权限体系的核心，通过角色关联菜单实现权限分配。
|
||
- [6.3 菜单管理](http://docs.thinkphp8.antdvue.rxthink.cn/zh/modules/menu.html): 菜单管理负责维护系统的菜单树和权限节点，是 RBAC 权限体系的基础数据。
|
||
- [6.4 部门管理](http://docs.thinkphp8.antdvue.rxthink.cn/zh/modules/dept.html): 部门管理维护组织架构数据，支持树形结构，是数据权限（按部门过滤）的基础。
|
||
- [6.5 职级管理](http://docs.thinkphp8.antdvue.rxthink.cn/zh/modules/level.html): 职级管理维护用户的职级属性数据，支持 Excel 导入导出。
|
||
- [6.6 岗位管理](http://docs.thinkphp8.antdvue.rxthink.cn/zh/modules/position.html): 岗位管理维护用户的岗位属性数据。
|
||
- [6.7 文章管理](http://docs.thinkphp8.antdvue.rxthink.cn/zh/modules/article.html): 文章管理模块支持富文本内容编辑、封面图上传、分类关联。
|
||
- [6.8 公告与链接管理](http://docs.thinkphp8.antdvue.rxthink.cn/zh/modules/content.html): 本节涵盖通知公告和友情链接两个模块，均继承 BaseTenantLogic 实现租户隔离。
|
||
- [6.9 行政区划管理](http://docs.thinkphp8.antdvue.rxthink.cn/zh/modules/city.html): 行政区划管理维护全国省市区街道四级数据，支持按父编码级联查询。
|
||
- [6.10 分类管理](http://docs.thinkphp8.antdvue.rxthink.cn/zh/modules/category.html): 分类管理支持树形分类数据，可用于文章分类、商品分类等场景。
|
||
- [6.11 定时任务](http://docs.thinkphp8.antdvue.rxthink.cn/zh/modules/job.html): 定时任务系统由三部分组成：JobLogic（调度逻辑）+ BaseTask（任务处理器）+ JobRunCommand（命令行入口）。
|
||
- [6.12 参数管理](http://docs.thinkphp8.antdvue.rxthink.cn/zh/modules/param.html): 参数管理维护系统级配置参数，如默认密码、系统名称等。
|
||
- [6.13 租户管理](http://docs.thinkphp8.antdvue.rxthink.cn/zh/modules/tenant.html): 租户管理是多租户体系的核心，支持租户的 CRUD、创建租户账号、查看租户用户。
|
||
- [6.14 文件模板管理](http://docs.thinkphp8.antdvue.rxthink.cn/zh/modules/filetemplate.html): 文件模板管理用于维护系统中使用的文件模板，支持按编码查询模板。
|
||
- [6.15 首页与个人中心](http://docs.thinkphp8.antdvue.rxthink.cn/zh/modules/index.html): 首页与个人中心模块负责当前登录用户的信息获取、菜单加载、密码修改和个人信息更新。
|
||
|
||
## 7. 文件处理
|
||
|
||
- [7.1 文件上传全流程](http://docs.thinkphp8.antdvue.rxthink.cn/zh/tools/upload.html): 文件处理分为两个阶段：上传到临时目录（upload_file）→ 入库时迁移到正式目录（save_file）。
|
||
- [7.2 上传配置详解](http://docs.thinkphp8.antdvue.rxthink.cn/zh/tools/upload-config.html): 文件上传配置定义在 config/file.php 和 .env 中，控制上传目录、域名、大小限制、允许的文件类型等。
|
||
- [7.3 富文本处理](http://docs.thinkphp8.antdvue.rxthink.cn/zh/tools/rich-text.html): 富文本（如文章内容）中的图片/视频也需要处理。
|
||
- [7.4 数据导入导出](http://docs.thinkphp8.antdvue.rxthink.cn/zh/tools/excel.html): ExcelService 基于 PhpSpreadsheet 封装导入导出能力，支持普通导入导出和分批导出（大数据量）。
|
||
- [7.5 前端文件组件](http://docs.thinkphp8.antdvue.rxthink.cn/zh/tools/file-components.html): 本节介绍前端项目中的文件处理组件，包括上传组件（BasicUpload）和图片预览组件的使用方法。
|
||
- [7.6 数据库迁移工具](http://docs.thinkphp8.antdvue.rxthink.cn/zh/tools/db-migrate.html): db:migrate 是一个 CLI 命令行工具，支持在 MySQL / PostgreSQL / SQL Server / Oracle / SQLite 五种数据库之间任意组合迁移。
|
||
|
||
## 8. 接口规范与对接
|
||
|
||
- [8.1 统一响应格式](http://docs.thinkphp8.antdvue.rxthink.cn/zh/api-spec/response.html): 所有接口返回统一的 JSON 结构，前端可据此判断请求结果。
|
||
- [8.2 错误码对照表](http://docs.thinkphp8.antdvue.rxthink.cn/zh/api-spec/error-code.html): 所有接口返回统一的 JSON 结构，通过 code 字段区分业务状态。
|
||
- [8.3 分页查询规范](http://docs.thinkphp8.antdvue.rxthink.cn/zh/api-spec/pagination.html): 所有分页接口遵循统一的参数命名和返回结构。
|
||
- [8.4 文件上传接口](http://docs.thinkphp8.antdvue.rxthink.cn/zh/api-spec/upload.html): 文件上传接口将文件保存到临时目录，返回文件 URL。
|
||
- [8.5 字典数据接口](http://docs.thinkphp8.antdvue.rxthink.cn/zh/api-spec/dict-api.html): 字典数据接口分为两组：字典管理（DictController）和字典项管理（DictItemController）。
|
||
- [8.6 Token 使用说明](http://docs.thinkphp8.antdvue.rxthink.cn/zh/api-spec/token.html): 系统采用 JWT 双令牌认证，access_token 用于接口认证（2小时），refresh_token 用于刷新令牌（7天）。
|
||
- [8.7 API 接口总览](http://docs.thinkphp8.antdvue.rxthink.cn/zh/api-spec/overview.html): 本节按模块分组列出所有 API 接口的概述，详细路由清单见附录 E。
|
||
|
||
## 9. 前端开发
|
||
|
||
- [9.1 前端工程概述](http://docs.thinkphp8.antdvue.rxthink.cn/zh/frontend/overview.html): 前端基于 Vue 3 + TypeScript + Vite + AntDesign 构建，采用 Pinia 状态管理，支持动态菜单和权限控制。
|
||
- [9.2 目录结构详解](http://docs.thinkphp8.antdvue.rxthink.cn/zh/frontend/directory.html): 本节详细介绍前端项目的目录结构，帮助开发者快速定位代码和理解项目组织方式。
|
||
- [9.3 环境与构建配置](http://docs.thinkphp8.antdvue.rxthink.cn/zh/frontend/env-config.html): 本节说明前端项目的环境变量配置和 Vite 构建配置，包括开发环境和生产环境的差异配置。
|
||
- [9.4 HTTP 请求封装](http://docs.thinkphp8.antdvue.rxthink.cn/zh/frontend/http.html): 前端使用 Axios 封装 HTTP 请求，自动处理 Token 携带、响应码判断、错误提示。
|
||
- [9.5 路由与动态菜单](http://docs.thinkphp8.antdvue.rxthink.cn/zh/frontend/router.html): 前端路由采用动态生成机制，从后端 /index/getMenus 接口获取菜单数据，自动转换为 Vue Router 路由。
|
||
- [9.6 状态管理（Pinia）](http://docs.thinkphp8.antdvue.rxthink.cn/zh/frontend/store.html): 前端使用 Pinia 进行全局状态管理，核心 Store 包含用户信息、动态路由、项目配置等。
|
||
- [9.7 权限控制](http://docs.thinkphp8.antdvue.rxthink.cn/zh/frontend/permission.html): 前端权限控制通过 v-perm / v-perms 指令实现按钮级权限控制。
|
||
- [9.8 登录流程](http://docs.thinkphp8.antdvue.rxthink.cn/zh/frontend/login.html): 本节说明前端登录流程的实现，包括登录表单提交、Token 存储、路由守卫和登出处理。
|
||
- [9.9 数据展示组件](http://docs.thinkphp8.antdvue.rxthink.cn/zh/frontend/display-components.html): 本节介绍前端项目中常用的数据展示组件，包括表格（BasicTable）、页面容器（PageWrapper）和图标选择器（IconPicker）。
|
||
- [9.10 数据录入组件](http://docs.thinkphp8.antdvue.rxthink.cn/zh/frontend/form-components.html): 本节介绍前端项目中常用的数据录入组件，包括表单（BasicForm）、弹窗表单和上传组件的使用方法。
|
||
- [9.11 Excel 导入导出组件](http://docs.thinkphp8.antdvue.rxthink.cn/zh/frontend/excel-components.html): 本节介绍前端项目中的 Excel 导入导出组件，包括导入组件（ImpExcel）和导出功能（jsonToSheetXlsx）的使用方法。
|
||
- [9.12 新增页面开发步骤](http://docs.thinkphp8.antdvue.rxthink.cn/zh/frontend/new-page.html): 以 example 模块为例，演示从 API 到视图的完整开发步骤。
|
||
- [9.13 API 模块编写规范](http://docs.thinkphp8.antdvue.rxthink.cn/zh/frontend/api-module.html): 本节定义前端 API 模块的编写规范，包括命名规范、请求方式和文件组织。
|
||
- [9.14 样式与主题定制](http://docs.thinkphp8.antdvue.rxthink.cn/zh/frontend/style.html): 前端使用 WindiCSS + Less 实现样式管理，基于 @zougt/vite-plugin-theme-preprocessor 支持主题切换和暗色模式。
|
||
- [9.15 布局系统](http://docs.thinkphp8.antdvue.rxthink.cn/zh/frontend/layout.html): 前端布局采用经典的企业后台布局：左侧菜单 + 顶部导航 + 内容区域，支持多标签页导航。
|
||
- [9.16 工具函数](http://docs.thinkphp8.antdvue.rxthink.cn/zh/frontend/utils.html): 本节介绍前端项目中常用的工具函数，包括本地存储、类型判断、URL 处理和权限检查等。
|
||
- [9.17 国际化（i18n）](http://docs.thinkphp8.antdvue.rxthink.cn/zh/frontend/i18n.html): 本节介绍前端项目的国际化方案，基于 vue-i18n 实现多语言切换。
|
||
|
||
## 10. 代码生成器
|
||
|
||
- [10.1 概述与架构](http://docs.thinkphp8.antdvue.rxthink.cn/zh/generator/overview.html): 代码生成器可根据数据库表结构一键生成 CRUD 模块的全部代码，包括后端 Controller/Logic/Model/Validate 和前端 API/View。
|
||
- [10.2 CLI 命令行使用](http://docs.thinkphp8.antdvue.rxthink.cn/zh/generator/cli.html): 代码生成器提供 CLI 命令行方式，适合批量生成或 CI/CD 集成场景。
|
||
- [10.3 Web 管理界面](http://docs.thinkphp8.antdvue.rxthink.cn/zh/generator/web-ui.html): 代码生成器提供 Web 管理界面，通过可视化操作完成代码生成，无需命令行。
|
||
- [10.4 表结构解析引擎](http://docs.thinkphp8.antdvue.rxthink.cn/zh/generator/parser.html): 解析引擎读取数据库表的字段信息（名称、类型、注释、是否必填等），并自动分析字段属性（图片、富文本、选项、外键等），作为代码生成的数据源。
|
||
- [10.5 代码生成引擎](http://docs.thinkphp8.antdvue.rxthink.cn/zh/generator/code-engine.html): 代码生成引擎基于模板文件，将表结构信息渲染为实际代码文件。
|
||
- [10.6 自定义模板开发](http://docs.thinkphp8.antdvue.rxthink.cn/zh/generator/templates.html): 代码生成器使用 PHP 原生模板引擎渲染代码，模板文件存放在 templates/ 目录下。
|
||
- [10.7 配置文件详解](http://docs.thinkphp8.antdvue.rxthink.cn/zh/generator/config.html): 代码生成器通过 .env 和 Web 界面配置，主要控制生成行为和默认值。
|
||
- [10.8 实战案例](http://docs.thinkphp8.antdvue.rxthink.cn/zh/generator/demo.html): 以「案例演示」模块为例，演示代码生成器的完整使用流程。
|
||
- [10.9 常见问题](http://docs.thinkphp8.antdvue.rxthink.cn/zh/generator/faq.html): 本页收录代码生成器使用中的常见问题，覆盖生成文件位置、命名规则、重复生成与模板定制等场景，生成结果不符合预期时优先查阅。
|
||
|
||
## 11. 运维部署
|
||
|
||
- [11.1 部署 Checklist](http://docs.thinkphp8.antdvue.rxthink.cn/zh/deploy/checklist.html): 从服务器准备到应用上线的完整部署操作清单，适用于生产环境首次部署和后续版本更新。
|
||
- [11.2 环境规划](http://docs.thinkphp8.antdvue.rxthink.cn/zh/deploy/env-plan.html): 本节提供不同规模项目的服务器配置建议和环境规划方案。
|
||
- [11.3 数据库迁移](http://docs.thinkphp8.antdvue.rxthink.cn/zh/deploy/db-migrate.html): 除了 SQL 脚本导入，项目还提供了 php think db:migrate 命令行工具，支持跨数据库自动迁移（MySQL → PostgreSQL 等），自动迁移索引、外键、字段注释、表注释、
|
||
- [11.4 后端部署](http://docs.thinkphp8.antdvue.rxthink.cn/zh/deploy/backend.html): 本节详细说明后端服务的部署配置，包括 Nginx、Apache、PHP 生产优化、定时任务配置，以及多数据库部署注意事项。
|
||
- [11.5 前端部署](http://docs.thinkphp8.antdvue.rxthink.cn/zh/deploy/frontend.html): 本节说明前端项目的构建与部署流程，包括构建命令、Nginx 配置、Gzip 压缩和部署步骤。
|
||
- [11.6 Docker 生产部署](http://docs.thinkphp8.antdvue.rxthink.cn/zh/deploy/docker.html): 本节提供基于 Docker Compose 的生产环境部署方案，包含 Nginx 反向代理、PHP-FPM 应用、MySQL 数据库和 Redis 缓存四个服务的容器编排配置。
|
||
- [11.7 性能调优](http://docs.thinkphp8.antdvue.rxthink.cn/zh/deploy/performance.html): 本节从 PHP、缓存、数据库、前端四个维度提供性能调优建议。
|
||
- [11.8 安全加固清单](http://docs.thinkphp8.antdvue.rxthink.cn/zh/deploy/security.html): 生产环境上线前必须完成的安全配置清单，涵盖认证、权限、文件与网络等加固项并分级列出，逐项对照执行可显著降低被攻击风险。
|
||
- [11.9 备份与恢复](http://docs.thinkphp8.antdvue.rxthink.cn/zh/deploy/backup.html): - 本地保留最近 7 天的备份 - 异地保留最近 30 天的备份 - 每月进行一次恢复测试 - 备份文件加密存储（如含敏感数据）
|
||
- [11.10 故障排查手册](http://docs.thinkphp8.antdvue.rxthink.cn/zh/deploy/troubleshooting.html): 遇到问题时，按以下顺序排查： 1. 查看 PHP 错误日志（/var/log/php_errors.log） 2. 查看 Nginx 错误日志（/var/log/nginx/error.log）
|
||
- [11.11 CI/CD 流水线](http://docs.thinkphp8.antdvue.rxthink.cn/zh/deploy/ci-cd.html): 本节介绍项目的持续集成/持续部署（CI/CD）方案，包括 GitHub Actions 和 GitLab CI 的配置示例，以及自动化测试、构建和部署流程。
|
||
|
||
## 12. 规范标准
|
||
|
||
- [12.1 API 响应规范](http://docs.thinkphp8.antdvue.rxthink.cn/zh/standards/api-response.html): 所有接口返回统一的 JSON 结构，前端可据此判断请求结果。
|
||
- [12.2 分页查询规范](http://docs.thinkphp8.antdvue.rxthink.cn/zh/standards/pagination.html): 所有分页接口遵循统一的参数命名和返回结构，确保前后端一致性。
|
||
- [12.3 Git 提交规范](http://docs.thinkphp8.antdvue.rxthink.cn/zh/standards/git.html): 统一的 Git 提交规范有助于代码审查、版本管理和自动化工具集成。
|
||
- [12.4 数据删除规范](http://docs.thinkphp8.antdvue.rxthink.cn/zh/standards/deletion.html): 所有业务数据统一使用软删除机制，通过 is_delete 字段标记记录状态，不物理删除数据。
|
||
- [12.5 代码审查清单](http://docs.thinkphp8.antdvue.rxthink.cn/zh/standards/code-review.html): 代码审查（Code Review）是保证代码质量的重要环节。
|
||
- [12.6 后端编码规范](http://docs.thinkphp8.antdvue.rxthink.cn/zh/standards/backend-code.html): 本节定义后端 PHP 代码的编写规范，包括 Model、Logic、Controller、Validate 各层的命名和结构规范，确保团队代码风格统一。
|
||
- [12.7 前端编码规范](http://docs.thinkphp8.antdvue.rxthink.cn/zh/standards/frontend-code.html): 前端编码规范涵盖 Vue 组件、TypeScript、API 模块、样式和代码风格等方面。
|
||
|
||
## 附录
|
||
|
||
- [A. 常见问题汇总](http://docs.thinkphp8.antdvue.rxthink.cn/zh/appendix/faq.html): 本页汇总了项目各模块的常见问题及解决方案，按场景分类索引。
|
||
- [B. 数据库表结构速查](http://docs.thinkphp8.antdvue.rxthink.cn/zh/appendix/database-tables.html): 本页速查项目全部数据库表结构与五方言 SQL 脚本目录，按模块分类列出表名、字段与用途，建表迁移或排查数据问题时可快速对照。
|
||
- [C. 配置项速查](http://docs.thinkphp8.antdvue.rxthink.cn/zh/appendix/config-reference.html): .env 文件采用 INI 分组格式，[SECTION] 表示分组，分组下的 KEY = value 对应该分组的配置项。
|
||
- [D. 公共函数速查](http://docs.thinkphp8.antdvue.rxthink.cn/zh/appendix/functions.html): 以下函数定义在 app/common.php 中，可在任何地方直接调用。
|
||
- [E. API 接口速查表](http://docs.thinkphp8.antdvue.rxthink.cn/zh/appendix/api-cheatsheet.html): 本表列出所有 API 路由的完整清单，包含 HTTP 方法、路径和所需权限码。
|
||
- [F. 中间件执行顺序](http://docs.thinkphp8.antdvue.rxthink.cn/zh/appendix/middleware.html): 本页展示请求在框架中的完整中间件执行流程，包括全局中间件和应用中间件的执行顺序，帮助开发者理解请求处理链路。
|
||
- [G. 前端组件速查](http://docs.thinkphp8.antdvue.rxthink.cn/zh/appendix/components.html): 以下组件定义在 ui/src/components/ 目录下，可在页面中直接引入使用。
|
||
- [H. 前端 Store 速查](http://docs.thinkphp8.antdvue.rxthink.cn/zh/appendix/stores.html): 前端使用 Pinia 进行全局状态管理，核心 Store 定义在 ui/src/store/modules/ 目录下。
|
||
- [I. 前端 Enums 速查](http://docs.thinkphp8.antdvue.rxthink.cn/zh/appendix/enums.html): 前端枚举定义在 ui/src/enums/ 目录下，用于统一管理常量值。
|
||
- [J. 术语表](http://docs.thinkphp8.antdvue.rxthink.cn/zh/appendix/glossary.html): 本页汇总项目前后端核心术语，按分类给出英文全称与中文释义，阅读文档遇到生词时可在此快速查对。
|
||
- [K. 贡献指南](http://docs.thinkphp8.antdvue.rxthink.cn/zh/other/contributing.html): 感谢你对本项目的关注！
|
||
- [L. 免责声明](http://docs.thinkphp8.antdvue.rxthink.cn/zh/other/declare.html): 使用本产品前必读的法律声明，明确产品性质、使用限制与责任划分，一旦使用本产品即视为接受本声明全部条款。
|
||
- [M. 广告赞助](http://docs.thinkphp8.antdvue.rxthink.cn/zh/other/sponsor.html): 1. 投放广告不得与官方全系产品存在结构性冲突和竞争 2. 广告内容需符合国家法律法规，不得包含虚假、误导性信息 3. 广告素材需经官方审核通过后方可上线，审核周期 1-3 个工作日 4.
|