入门指南 - CandyPHP开源框架

>i 本文档最后修订日期： **2020-05-19** # 前言 ## 版本说明当前文档对应框架版本是`3.0.1`,如果与您使用的框架版本不符，则有可能本文档的部分或者全部内容将`不适用`于您正在使用的框架。在3.x中，我们进行了整体的框架重构，因此与3.x之前的版本不兼容。如果您正在使用2.x或更早的版本，请参看`升级`章节的内容。 ## 综述感谢您了解CandyPHP开源框架。 >d CandyPHP 是标准的 `MVC` 模式框架，理解和使用简单方便，上手迅速。此框架下2.x开始引入PHP引擎 `workerman` 实现常规`Apache`、`Nginx`模式运行和`Cli`模式运行并存特性，3.x开始重构优化进一步规范和提升框架速度和便携行。 * 高内聚的可插拔插件和无限的拓展的模块设计 * 简洁清晰的文件结构 * 完善详细的报错信息标准的`MVC` 模式框架，单入口单项目和单入口多项目两种运行方式，功能和模版分离，自动建立模块等诸多特性只为让您的代码书写更流畅，程序运行更稳定。 ## 运行环境运行环境为`PHP7+`。 ## 性能&安全性 CandyPHP秉承一切输入都不可信原则，内置安全类对一切输入进行过滤和检查，DBServer引入PDO、Mysqli等进行参数绑定和检查。内置函数防注入、XSS、CSRF等安全问题。代码尽量精简和考虑性能优化并且引入`workerman` 框架可以使用常驻内存的`Cli`运行模式进一步提升执行效率。 ## 交流方式 >i CandyPHP官方QQ群：219268056 准备好了吗？接下来，我们将为您详细介绍如何使用CandyPHP框架！ # 目录结构 >i 框架目录结构以下是未初始化之前框架的目录结构 ``` / 根目录 | ├─Candy 框架目录 | ├─Class 框架扩展类库目录 | ├─Core 框架核心类库目录 | ├─Func 框架函数库目录 | ├─Tpl 框架初始化素材库 | ├─Vendor 框架第三方扩展类库 | ├─Init.php 框架根入口 | ├─Server.php 框架sever服务 | └─Version.php 框架版本号 | ├─index.php 默认入口文件 | ├─Rewrite.zip 伪静态规则 | └─service Cli启动文件 ``` >i 项目目录结构以下是项目初始化后的目录结构 ``` / 根目录 | ├─Addons 扩展目录 | └─Demo 演示扩展目录 | ├─Application 项目目录 | └─Home 默认项目目录 | ├─Controls 控制器目录 | ├─Languages 语言库目录 | ├─Models 数据模型目录 | └─Views 默认模版目录(未特殊设定位置时才有) | ├─Candy 框架目录 | ├─Plugins 插件目录 | ├─Demo 演示插件目录 | └─Home 默认项目扩展二开目录 | ├─Public 公共目录 | ├─css 公共样式目录 | ├─images 公共图片目录 | ├─js 公共js目录 | ├─thumbs 默认缩略图目录 | └─uploads 默认上传目录 | ├─Runtime 运行缓存目录 | ├─Cache 缓存目录 | ├─Comps 模版编译目录 | ├─Controls 控制器编译目录 | ├─Data 数据目录 | ├─Logs 记录目录 | ├─Models 模型编译目录 | ├─Tmps 临时缓存目录 | └─init.lock 初始化锁定文件 | ├─Source 项目资源配置目录 | ├─Class 项目扩展类库目录 | ├─Func 项目函数库目录 | ├─Inc 项目配置目录 | ├─Addon.inc.php 扩展配置 | ├─HomeRoute.inc.php Home路由配置 | ├─App.inc.php 项目权限菜单配置 | ├─AttackCode.inc.php 输入过滤配置 | ├─Command.inc.php 框架扩展命令配置 | ├─Config.inc.php 基本配置 | ├─Init.inc.php 初始化配置 | ├─Plug.inc.php 插件配置 | ├─Route.inc.php 全局路由配置 | ├─Sensitive.inc.php 违禁词配置 | ├─Specialclass.inc.php 特殊类库配置 | └─System.inc.php 系统配置 | | └─Vendor 项目第三方扩展类目录 | ├─Template 默认Home模版目录 | └─default 前台默认模版目录 | ├─index.php 默认入口文件 | ├─Rewrite.zip 伪静态规则 | └─service Cli启动文件 ``` # 准备工作和核心配置 ## 准备工作 >w 开始之前请确认PHP引擎支持PATHINFO和伪静态。 `/Rewrite.zip` 下包含了伪静态规则，可根据需要自行调整。 * IIS环境下，请将对应环境版本文件夹内的 `web.config` 文件放置于网站根目录，在安装好URL重写模块之后即可使用。 * Apache环境下，请将对应环境版本文件夹内的 `.htaccess` 文件放置于网站根目录，在Apache的配置文件中开启URL重写选项之后即可使用。 * Nginx环境下，请将对应环境版本文件夹内的 `candyphp.conf` 文件引入到Nginx的配置文件 nginx.conf 中，也可以将candyphp.conf中的代码插入到nginx.conf中的合适位置。 * Cli环境下，不需要任何配置文件，框架内部已自动做相应处理。 * 如果有额外需求，可根据需要自行调整伪静态规则。 >i 规则隐藏了index.php文件名，并屏蔽了对/Core、/Source、/Temp等关键路径的访问，以及当HTTP状态码为4xx或5xx时，展示友好的出错页面。同时将流量牵引至/index.php。 ## 核心配置 >w Apache和Nginx初始化时仅需要对index.php内的几项做简单的修改或者直接默认也是可以的。 * `defined('DEBUG') OR define('DEBUG', 1);` `DEBUG` `(Int)` `1` ：调试模式，`1` 代表开启、`0` 代表关闭，默认开启。当调试模式关闭时，报错等级将调整至最低 **`（意味着某些不重要的错误将会被忽略）`** ，而当调试模式开启时，框架会自动对修改过的模板文件进行编译，并告知浏览器对所有页面都不进行缓存；同时在发生错误时显示详细的报错信息 **`（可能包含文件路径、出错类型或数据库信息）`** 。在调试模式关闭的情况下，系统会自动开启记录日志的配置项，报错信息将会被写入日志中，日志位置`Runtime/Logs/error.log`。 * `$tplpath = 'Home@./Template'`; 项目模版文件夹的位置, 值为字符串，@分开前面为项目名称，后面为路径。自定义时使用，不需要可以注销或删除。框架默认的模版文件夹路径为：`Application/项目名/Views` >w Cli模式下除了以上的配置还需要修改service文件配置 `$servers`数组包含了所有的服务器配置，所以只是修改这个数组就可以。其中`webserver`项目配置WEB服务其中`server`为多服务配置每个子数组表示一组服务其中 `count`表示进程数、`gzip`表示gzip等级0表示不开启、`max-age`表示缓存时间、`list`域名绑定信息。 `rpc` RPC服务配置 `globaldata` 全局变量配置 `task` 自动计划任务配置 # 常量 # 扩展类库 # 配置项 # 语法 # 模版 # 缓存及自动编译 # 文件引入 # 路由 # 重名策略 # 报错机制 # 升级 # 安全规范 # 高性能 # 版权声明&联系方式 > 本框架为免费开源、遵循Apache2开源协议的框架，但不得删除框架内文件的版权信息，违者必究。 This framework is free and open source, following the framework of Apache2 open source protocol, but the copyright information of files are not allowed to be deleted,violators will be prosecuted to the maximum extent possible. ©2020 fingerboy. All rights reserved. >w 反馈Bug，可加入 `QQ群` 或发送邮件至 `fingerboy@qq.cn` 进行反馈。