mirror of
https://gitee.com/zoujingli/ThinkAdmin.git
synced 2025-04-06 03:58:04 +08:00
Update readme.md
This commit is contained in:
邹景立
parent
97ac2b3bac
commit
b8390aea15
78
readme.md
78
readme.md
@ -1,7 +1,6 @@
|
||||
## 大道至简 · 原生框架
|
||||
|
||||
[](https://packagist.org/packages/zoujingli/thinkadmin)
|
||||
[](https://packagist.org/packages/zoujingli/thinkadmin)
|
||||
[](https://packagist.org/packages/zoujingli/thinkadmin)
|
||||
[](https://packagist.org/packages/zoujingli/thinkadmin)
|
||||
[](https://packagist.org/packages/zoujingli/thinkadmin)
|
||||
@ -9,18 +8,11 @@
|
||||
|
||||
### 项目介绍
|
||||
|
||||
**ThinkAdmin** 是一款遵循 **MIT** 协议开源的快速开发框架，基于最新版本 **ThinkPHP6** 的极简后台管理系统，在使用
|
||||
**ThinkAdmin** 前请认真阅读[《免责声明》](https://thinkadmin.top/disclaimer)并同意该声明。
|
||||
**ThinkAdmin** 是一款遵循 **MIT** 协议开源的快速开发框架，基于最新版本 **ThinkPHP6** 的极简后台管理系统，在使用 **ThinkAdmin** 前请认真阅读[《免责声明》](https://thinkadmin.top/disclaimer)并同意该声明。
|
||||
|
||||
我们致力于快速开发的底层框架，让项目开发变得更容易。框架提供完善的基础组件以及对应的 **API** 支持，基于此框架可以快速开发各种
|
||||
**WEB** 应用。任何一个系统都不能完全满足所有的业务场景，**ThinkAdmin** 免费提供基础底层的功能，这里包括系统权限管理，系统存储配置，微信授权管理，以及其他常用功能集成等……
|
||||
因此 **ThinkAdmin** 也被大家定性为外包二开基线系统。从 **v6.1** 开始我们提供会员尊享组件和定制业务插件服务。目前已经有许多公司及个人在使用
|
||||
**ThinkAdmin**，通过数据聚合统计已有 **3** 万多在线运行的项目。
|
||||
我们致力于快速开发的底层框架，让项目开发变得更容易。框架提供完善的基础组件以及对应的 **API** 支持，基于此框架可以快速开发各种 **WEB** 应用。任何一个系统都不能完全满足所有的业务场景，**ThinkAdmin** 免费提供基础底层的功能，这里包括系统权限管理，系统存储配置，微信授权管理，以及其他常用功能集成等…… 因此 **ThinkAdmin** 也被大家定性为外包二开基线系统。从 **v6.1** 开始我们提供会员尊享组件和定制业务插件服务。目前已经有许多公司及个人在使用 **ThinkAdmin**，通过数据聚合统计已有 **3** 万多在线运行的项目。
|
||||
|
||||
**ThinkAdmin v6** 是基于 **v1**-**v5** 大版本的积累，经历了几次大的调整，结合 **ThinkPHP6**
|
||||
的思维重新构建，减少大量原非必需的组件，自建存储层、服务层及队列任务机制，另外还增加了许多友好指令！当前 **v6**
|
||||
版本已经通过了数个系统实践与测试，过程中不停调整与优化，目前系统模块及微信模块已经趋于稳定，现将系统管理 **`app\admin`**
|
||||
及微信管理 **`app\wechat`** 定为 **v6** 内核两大模块并以 **MIT** 协议发布，后续可能还有其他模块及相关辅助模块更新发布，敬请期待……
|
||||
**ThinkAdmin v6** 是基于 **v1**-**v5** 大版本的积累，经历了几次大的调整，结合 **ThinkPHP6** 的思维重新构建，减少大量原非必需的组件，自建存储层、服务层及队列任务机制，另外还增加了许多友好指令！当前 **v6** 版本已经通过了数个系统实践与测试，过程中不停调整与优化，目前系统模块及微信模块已经趋于稳定，现将系统管理 **`app/admin`** 及微信管理 **`app/wechat`** 定为 **v6** 内核两大模块并以 **MIT** 协议发布，后续可能还有其他模块及相关辅助模块更新发布，敬请期待……
|
||||
|
||||
当前 **ThinkAdmin** 的最新版本为 **v6.1**，从这个版本开始正式进入插件时代，基础组件及扩展插件统一使用 **Composer**
|
||||
管理。现在通过对 **Composer** 深度开发已实现了插件自动安装机制，可以大大减少项目初始化安装的成本。**ThinkAdmin** 与传统
|
||||
@ -28,35 +20,21 @@
|
||||
应用。我们强烈建议不要占用或修改 **`app/admin`** 和 **`app/wechat`** 两个目录里面的代码，这些未来可以通过 **Composer**
|
||||
进行功能及安全升级。
|
||||
|
||||
系统核心组件 **ThinkLibrary** 封装了大量常用操作以及多应用组件，可快速开发各种应用程序，且不影响原 **ThinkPHP**
|
||||
生态，大大简化编码成本；可自行选择集成 **WechatDeveloper** 组件 (
|
||||
支持微信公众号、微信小程序、微信企业号、微信商户支付、支付宝支付接口等 ) 及 **QRcode**
|
||||
二维码生成工具等。里面还内置了ThinkPHP6多应用组件并且完美支持路由；文件存储支持本地服务器存储、七牛云对象存储（支持CDN加速）、又拍云USS存储（支持CDN加速）、阿里云OSS存储（支持CDN加速）、腾讯云COS存储（支持CDN加速）等存储方式；自带异步任务处理机制，可以并列多进程执行任务，任务响应延时小于
|
||||
**0.5**
|
||||
秒，兼容 **windows** 及 **linux**。
|
||||
系统核心组件 **ThinkLibrary** 封装了大量常用操作以及多应用组件，可快速开发各种应用程序，且不影响原 **ThinkPHP** 生态，大大简化编码成本；可自行选择集成 **WechatDeveloper** 组件 ( 支持微信公众号、微信小程序、微信企业号、微信商户支付、支付宝支付等 ) 及 **QRcode** 二维码生成工具等。里面还内置了 **ThinkPHP6** 多应用组件并且完美支持路由；文件存储支持本地服务器存储、七牛云对象存储（支持CDN加速）、又拍云USS存储（支持CDN加速）、阿里云OSS存储（支持CDN加速）、腾讯云COS存储（支持CDN加速）等存储方式；自带异步任务处理机制，可以并列多进程执行任务，任务响应延时小于 **0.5** 秒，兼容 **windows** 及 **linux**。
|
||||
|
||||
温馨提示：如果需要直接查看源代码和数据库 **SQL** 文件，请切换到 `v6` 分支，从 `v6.1` 开始不再直接提供源代码和数据库 **SQL**
|
||||
**温馨提示：** 如果需要直接查看源代码和数据库 **SQL** 文件，请切换到 `v6` 分支，从 `v6.1` 开始不再直接提供源代码和数据库 **SQL**
|
||||
文件，其初始化及安装都由插件实现。使用 **Composer** 时建议安装新版本并使用官方源，目前国内大部分镜像经常出现`404`
|
||||
导致组件下载失败或安装不完整等异常情况！
|
||||
|
||||
使用 **ThinkAdmin** 需要掌握 **ThinkPHP**、**jQuery**、**LayUI**、**RequireJs** 等开发技能，后台`UI`界面基于最新版本的
|
||||
**LayUI** 前端框架以及 **RequireJs** 组件加载方式，默认加载了所有 **LayUI**
|
||||
的组件，框架中可以直接使用组件（独立页面需要注册`js`加载顺序哦），使用 **RequireJs**
|
||||
加载插件，互联网上资源非常多，可自行下载进行二次扩展。目前后台大部分页面为单页程序，页面加载速度非常快速，也因此后台不再支持选项卡模式。
|
||||
使用 **ThinkAdmin** 需要掌握 **ThinkPHP**、**jQuery**、**LayUI**、**RequireJs** 等开发技能，后台 **UI** 界面基于最新版本的 **LayUI** 前端框架以及 **RequireJs** 组件加载方式，默认加载了所有 **LayUI** 的组件，框架中可以直接使用组件（独立页面需要注意 **js** 加载顺序哦），使用 **RequireJs** 加载插件，互联网上资源非常多，可自行下载进行二次扩展。目前后台大部分页面为单页程序，页面加载速度非常快速，也因此后台不再支持选项卡模式。
|
||||
|
||||
### 注意事项
|
||||
|
||||
* **ThinkAdmin** 是基于国内最流行的 `ThinkPHP6` 框架开发，目前对 `PHP` 版本要求不得低于 `PHP 7.2.5`
|
||||
，如果使用低版本的 `PHP` 可能会影响 `Composer` 依赖组件的安装，或将存在一定的安全隐患，具体请阅读 `ThinkPHP` 更新日志及相关文档；
|
||||
* 系统的运行环境必需开启 `PATHINFO` 支持并配置对应的 `rewrite` 规则才能访问，不再支持 `ThinkPHP` 的 `URL` 兼容模式运行 (
|
||||
源于如何优雅地展示 )，可以阅读文档部署章节；
|
||||
* 代码仓库下载的文件不包含 `Composer` 组件包的 `vendor` 目录，下载后需要执行 `composer install` 或 `composer update`
|
||||
安装依赖组件，同时会触发执行数据库 `Phinx` 安装脚本；
|
||||
* 为保持系统可持续在线升级功能，开发时建议不要在`app/admin`,`app/wechat`,`public/static`
|
||||
这三个目录创建或修改文件，可以自行创建其他模块再编写自己的业务代码，自定义样式及脚本可以放置在目录 `public/static/extra`
|
||||
里面。系统是基于严格类型 `PHP` 新特性开发，务必使用专业的 `IDE` ( 如：`PhpStorm`,`NetBeans`,`VsCode`,`Eclipse for PHP`
|
||||
等 ) 进行项目开发以达到更好的体验与更高的效率！
|
||||
* 若后台操作提示 “演示系统禁止操作” 等字样，需要删除演示路由的配置文件(`app/admin/route/demo.php`)；
|
||||
* **ThinkAdmin** 是基于国内最流行的 **ThinkPHP6** 框架开发，要求在不低于 **PHP 7.2.5** 的版本上运行，如果使用低版本的 **PHP** 可能会影响 **Composer** 依赖组件的安装，或将存在一定的安全隐患；
|
||||
* 运行环境必需开启 **PATHINFO** 并将对应的 **rewrite** 规则配置到站点才能访问，系统已不再支持 **ThinkPHP** 的 **URL** 兼容模式运行 ( 源于如何优雅地展示 )，可以阅读 **ThinkAdmin** 的文档[安装部署](https://thinkadmin.top/install)章节；
|
||||
* 代码仓库下载的文件不包含 **Composer** 组件的 **vendor** 目录，下载后需要执行 **composer install** 安装依赖组件，同时会触发执行 **php think migrate:run** 安装数据库 **Phinx** 脚本，如需切换数据库只需要先配置再执行指令即可完成初始化安装数据；
|
||||
* 为保持系统可持续在线升级，建议不要在 **app/admin**、**app/wechat** 、**public/static** 这三个目录创建或修改文件，可以自行创建其他模块再编写自己的业务代码，自定义样式及脚本可以放置在 **public/static/extra** 目录里面。
|
||||
* 系统是基于严格类型 **PHP** 新特性开发，务必使用专业的 **IDE** ( 如：**PhpStorm**、**NetBeans**、**VsCode**、**Eclipse for PHP** 等 ) 进行项目开发以达到更好的体验与更高的效率！
|
||||
|
||||
## 插件生态
|
||||
|
||||
@ -64,7 +42,7 @@
|
||||
|
||||
## 系统安装
|
||||
|
||||
通过 `Composer` 工具安装系统：
|
||||
通过 Composer 工具安装系统, 创建并进入 **ThinkAdmin** 根目录，运行指令安装依赖组件。
|
||||
|
||||
```shell
|
||||
### 创建项目（ 需要在英文目录下面执行 ）
|
||||
@ -101,7 +79,7 @@ php think migrate:run
|
||||
> **B. 数据库初始化安装**
|
||||
>
|
||||
> 使用 `MySql`, `SqlServer`, `Postgres` 等服务型数据库时，需要先创建空的数据库并将参数配置到 `config/database.php`
|
||||
> ，然后执行`composer update`或`php think migrate:run`
|
||||
> ，然后执行 `composer update` 或 `php think migrate:run`
|
||||
> 安装并初始化数据库；开发部署系统时，如果要对数据库添加数据表或修改数据表，可以直接修改数据库或创建 `Phinx`
|
||||
> 脚本后执行 `php think migrate:run` 进行数据库更新升级。另外系统提供 `php think xadmin:package` 指令可以把现有 `MySQl`
|
||||
> 数据库打包为 `Phinx` 脚本，迁移系统时只需要执行前面的安装步骤即可。
|
||||
@ -142,9 +120,11 @@ public function index(){
|
||||
|
||||
## 技术支持
|
||||
|
||||
开发前请认真阅读 ThinkPHP 官方文档和 ThinkAdmin 开发文档，相信会对您有所帮助哦！
|
||||
开发前请认真阅读 ThinkPHP 官方文档，会对您有帮助哦！
|
||||
|
||||
如果实在无法解决您所遇到的问题，可以加入官方群免费交流（需要提交认证信息）。
|
||||
本地开发请使用 `php think run` 运行服务，访问 `http://127.0.0.1:8000` 即可进入项目。
|
||||
|
||||
官方地址及开发指南：https://thinkadmin.top ，如果实在无法解决问题，可以加入官方群免费交流。
|
||||
|
||||
**1.官方QQ交流群：** 513350915
|
||||
|
||||
@ -152,7 +132,7 @@ public function index(){
|
||||
|
||||
**3.官方微信交流群**
|
||||
|
||||
<img src="https://thinkadmin.top/static/img/wx.png" width="250">
|
||||
<img src="https://thinkadmin.top/static/img/wx.png" width="250">
|
||||
|
||||
## 框架指令
|
||||
|
||||
@ -181,18 +161,18 @@ public function index(){
|
||||
|
||||
## 问题修复
|
||||
|
||||
* 增加`CORS`跨域规则配置，配置参数置放于`config/app.php`，需要更新`ThinkLibrary`。
|
||||
* 修复`layui.table`导致基于`ThinkPHP`模板输出自动转义`XSS`过滤机制失效，需要更新`ThinkLibrary`。
|
||||
* 修复在模板中使用`{:input(NAME)}`取值而产生的`XSS`问题，模板取值更换为`{$get.NAME|default=''}`。
|
||||
* 修复`CKEDITOR`配置文件，禁用所有标签的`on`事件，阻止`xss`脚本注入，需要更新`ckeditor/config.js`。
|
||||
* 增加 `CORS` 跨域规则配置，配置参数置放于 `config/app.php`，需要更新 `ThinkLibrary`。
|
||||
* 修复 `layui.table` 导致基于 `ThinkPHP` 模板输出自动转义 `XSS` 过滤机制失效，需要更新 `ThinkLibrary`。
|
||||
* 修复在模板中使用 `{:input(NAME)}` 取值而产生的 `XSS` 问题，模板取值更换为 `{$get.NAME|default=''}`。
|
||||
* 修复 `CKEDITOR` 配置文件，禁用所有标签的 `on` 事件，阻止 `xss` 脚本注入，需要更新 `ckeditor/config.js`。
|
||||
* 修复文件上传入口的后缀验证，读取真实文件后缀与配置对比，阻止不合法的文件上传并存储到本地服务器。
|
||||
* 修改`JsonRpc`接口异常处理机制，当服务端绑定`Exception`时，客户端将能收到`error`消息及异常数据。
|
||||
* 修改`location.hash`访问机制，禁止直接访问外部`URL`资源链接，防止外部`XSS`攻击读取本地缓存数据。
|
||||
* 增加后台主题样式配置，支持全局默认+用户个性配置，需要更新`ThinkLibrary`,`static`,`admin`组件及模块。
|
||||
* 修改 `JsonRpc` 接口异常处理机制，当服务端绑定 `Exception` 时，客户端将能收到 `error` 消息及异常数据。
|
||||
* 修改 `location.hash` 访问机制，禁止直接访问外部 `URL` 资源链接，防止外部 `XSS` 攻击读取本地缓存数据。
|
||||
* 增加后台主题样式配置，支持全局默认+用户个性配置，需要更新 `admin`, `static`, `ThinkLibrary` 组件及模块。
|
||||
* 后台行政区域数据更新，由原来的腾讯地图数据切换为百度地图最新数据，需要更新`static`，数据库版需另行更新。
|
||||
* 增加`Phinx`数据库迁移脚本支持，可根据自己的需求安装对应模块，其中`admin`为改选模块！
|
||||
* 从分离`SystemService`分离出`RuntimeService`服务，精减服务启动入口，优化性能！
|
||||
* 增加插件模式，支持独立封装应用，可以通过`composer`管理并自动安装应用模块！
|
||||
* 增加`Phinx`数据库迁移脚本支持，可根据自己的需求安装对应模块，其中 `admin` 为改选模块！
|
||||
* 从分离 `SystemService` 分离出 `RuntimeService` 服务，精减服务启动入口，优化性能！
|
||||
* 增加插件模式，支持独立封装应用，可以通过 `composer` 管理并自动安装应用模块！
|
||||
|
||||
## 版权信息
|
||||
|
||||
@ -206,7 +186,7 @@ public function index(){
|
||||
|
||||
## 系统版本
|
||||
|
||||
体验账号及密码都是 admin
|
||||
以下系统的体验账号及密码都是 admin
|
||||
|
||||
### ThinkAdmin v6 基于 ThinkPHP6 开发（后台权限基于注解实现）
|
||||
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user