跳到主要内容

影云管理平台（YingyunAdmin）

项目说明书​

  • 项目名称：影云管理平台（YingyunAdmin）
  • 版本号：v1.0
  • 发布日期：2025年12月24日
  • 许可证：Apache License 2.0
  • 版权所有：© 2025 影云网络科技（石家庄）有限公司

一、项目简介​

影云管理平台（YingyunAdmin）是一款面向企业级应用场景的现代化后台管理系统，基于 ThinkPHP 8.0 框架构建，深度融合 OAuth2.0 单点登录（SSO）、分布式部署架构 与 插件化扩展机制，旨在为开发者提供一个安全、高效、可扩展的一站式管理平台解决方案。

平台采用 前后端分离架构：

  • 后端：以高性能 PHP 框架 ThinkPHP 8.0 为核心；
  • 前端：基于 Vue.js 3 + Element Plus 构建响应式用户界面。

适用于政府、教育、金融、电商等多个行业场景，支持快速定制与集成。

二、核心特性​

类别功能亮点
架构先进性遵循 PSR 规范，代码结构清晰，便于团队协作与长期维护
统一身份认证完整支持 OAuth2.0（Client/Server 模式），实现多系统单点登录（SSO）
高可用部署支持分布式与微服务架构，兼容 Redis 集群，便于横向扩展
模块化扩展提供标准化插件开发规范，支持热插拔功能模块，降低系统耦合度
安全防护内置防 CSRF、XSS、SQL 注入等 Web 安全机制，保障系统稳定运行
多端适配响应式前端设计，完美兼容 PC、平板、手机等设备
国际化支持内置 i18n 多语言框架，支持快速扩展新语种
权限体系细粒度 RBAC 权限模型，支持角色、菜单、操作三级控制
开放集成提供完整的 RESTful API 接口，便于与第三方系统无缝对接

三、技术栈​

后端技术​

  • 语言：PHP ≥ 8.0（推荐 8.1+）
  • 框架：ThinkPHP 8.0
  • 数据库：MySQL ≥ 5.7（支持主从复制、读写分离）
  • 依赖管理：Composer
  • 缓存中间件：Redis（支持集群模式）
  • 认证协议：OAuth2.0（授权码、密码、客户端凭证等模式）

前端技术​

  • 框架：Vue.js 3.x（组合式 API）
  • UI 组件库：Element Plus
  • 构建工具：Vite（默认）或 Webpack
  • 状态管理：Pinia（推荐） / Vuex（可选）

运维与部署​

  • 支持 Docker 容器化部署
  • 兼容 Nginx / Apache
  • 支持 CI/CD 流水线（如 GitLab CI、GitHub Actions）

四、系统功能模块​

4.1 核心功能​

  • 用户管理：增删改查、状态启用/禁用、个人信息维护
  • 角色管理：自定义角色，支持多角色分配与继承
  • 菜单管理：动态生成多级菜单，支持权限绑定与排序
  • 部门管理：树形组织架构，支持无限级嵌套
  • 操作日志：记录关键操作行为，支持按用户、时间、模块筛选
  • 系统配置：全局参数配置中心，支持动态生效，无需重启服务

4.2 扩展功能（插件化实现）​

  • 任务调度中心：基于 think-crontab 的定时任务管理，支持启停与日志查看
  • 文件管理中心：统一上传接口，支持本地存储及主流云存储（如阿里云 OSS、腾讯云 COS）
  • 消息通知系统：集成站内信、邮件、短信（通过插件扩展）
  • 数据可视化：内置 ECharts 图表，支持自定义报表与仪表盘
  • 轻量工作流引擎：支持审批流、状态流转等业务流程配置（以插件形式提供）

五、快速安装指南​

环境要求​

  • PHP ≥ 8.0（建议 8.1+）
  • MySQL ≥ 5.7
  • Composer 已安装
  • Redis（可选，用于缓存与会话共享）

安装步骤​

1. 克隆项目​

git clone https://github.com/sjzyingyun/YingyunAdmin.git

2. 安装依赖​

composer install --optimize-autoloader --no-dev

3. 配置环境​

cp .env.example .env

编辑 .env 文件，填写数据库、Redis、应用密钥等配置

4. 初始化数据库​

php think migrate:run
php think seed:run

5. 启动开发服务​

php think run --host=0.0.0.0 --port=8000

6. 访问系统​

生产部署建议：使用 Nginx + PHP-FPM，并配置 HTTPS 与反向代理。

六、插件开发机制​

影云平台采用 "插件即应用" 的设计理念，所有扩展功能均可通过插件实现，无需修改核心代码。

插件开发流程​

  1. 在 addons/ 目录下创建插件目录（如 addons/SmsNotify）
  2. 创建主类 SmsNotify.php，继承 addonsAbstractPlugin
  3. 实现钩子方法（如 onUserRegister, onSystemBoot）
  4. 添加 config.php 描述插件元信息（名称、版本、作者、依赖等）
  5. 开发前后端逻辑（可包含独立路由、控制器、视图、API）
  6. 在后台「插件管理」中启用插件

📘 详细开发文档：插件开发指南

七、贡献与协作​

本项目由 石家庄影云网络科技开源团队 主导开发，欢迎社区开发者参与共建。

贡献方式​

  • 提交 Issue 反馈 Bug 或提出功能建议
  • 提交 Pull Request 修复问题或新增功能
  • 编写文档、翻译多语言包、优化 UI/UX

提交规范​

  1. 遵循 PSR-12 编码规范
  2. 新增功能需附带单元测试或集成测试
  3. 修改涉及用户界面或 API 的内容，需同步更新文档
  4. 提交前请确保通过本地测试与代码风格检查

八、许可证声明​

本项目采用 Apache License 2.0 开源许可证。

✅ 允许商业使用、修改、分发
✅ 包含专利授权条款
⚠️ 修改后的文件必须保留原始版权声明
⚠️ 若分发二进制形式，需包含 NOTICE 文件
❌ 不提供任何形式的担保

完整条款请查阅：LICENSE

九、联系方式​

影云科技 · 让企业后台更简单