琯琯博客 纸上得来终觉浅,绝知此事要躬行。

ThinkPHP 的目录结构设计经验总结

琯琯
2016-06-24

用thinkphp开发了好些项目了;

最近准备抽空写一些经验总结;

希望能给刚开始接触tp的童鞋们提供一些开发的方案;

少走一些弯路;

少踩一些坑;

这些绝对都是些精华干货;

耐着性子阅读;

相信肯定是会有收获的;

可以结合git项目对照研究:https://github.com/baijunyao/thinkphp-bjyadmin 先从thinkphp的目录架构开始吧;

thinkphp-bjyadmin
├─Application 项目逻辑目录
│  ├─Common 公共模块
│  │  ├─Common  公共函数目录
│  │  │  ├─functioin.php 公共函数php文件
│  │  ├─Conf  公共配置文件目录
│  │  │  ├─config.php  tp的配置 用于覆盖框架默认配置项
│  │  │  ├─db.php  数据库配置 用户名 密码等
│  │  │  ├─webconfig.php  项目的配置;
网站名;
是否开启网站等
│  │  ├─Controller  公共控制器目录
│  │  │  ├─BaseController.class.php 应用最基础的控制器
│  │  │  ├─HomeBaseController.class.php  Home基础控制器继承BaseController
│  │  │  ├─AdminBaseController.class.php  Admin基础控制器继承BaseController
│  │  │  ├─UserBaseController.class.php  User基础控制器继承BaseController
│  │  │  ├─...
│  │  ├─Model  公共模型目录
│  │  │  ├─BaseModel.class.php  应用最基础的Model
│  │  │  ├─ArticleModel.class.php 文章model  继承BaseModel
│  │  │  ├─UserModel.class.php  用户model 继承BaseModel
│  │  │  ├─...
│  │  ├─Tag  公共标签目录
│  │  │  ├─My.class.php  自定义的标签库
│  │  │  ├─...
│  ├─Home  Home模块
│  │  ├─Controller  Home控制器目录 继承HomeBaseController
│  │  │  ├─ArticleController.class.php 文章控制器目录
│  │  │  ├─IndexController.class.php  首页控制器
│  │  │  ├─ ...
│  ├─Admin  Admin模块
│  │  ├─Controller  Admin控制器目录 继承AdminBaseController
│  │  │  ├─IndexController.class.php  后台管理首页控制器
│  │  │  ├─ ...
│  ├─User  User模块
│  │  ├─Controller  User控制器目录 继承UserBaseController
│  │  │  ├─IndexController.class.php  用户个人中心首页控制器
│  │  │  ├─ ...
├─Public 资源文件目录
│  ├─install      安装引导目录
│  ├─statics      静态资源目录
│  │  ├─bootstrap bootstrap框架
│  │  ├─ueditor   ueditor编辑器
│  │  ├─js        jquery等第三方js存放的目录
│  │  ├─css       animate.css等第三方css目录
│  │  ├─ ...
├─tpl 视图文件目录
│  ├─Public  公共目录
│  │  ├─js  公共js目录
│  │  │  ├─base.js 全站都引用的js文件
│  │  │  ├─ ...
│  │  ├─css  公共css目录
│  │  │  ├─base.css 全站都引用的css文件
│  │  │  ├─ ...
│  │  ├─images 公共图片目录
│  │  ├─public_head.html  全站通用的公共头部
│  │  ├─public_foot.html  全站通用的公共底部
│  │  ├─...
│  ├─Home  前台Home视图目录
│  │  ├─Public 前台Home的公共目录
│  │  │  ├─js  home下调用的js文件目录
│  │  │  ├─css  home下调用的css文件目录
│  │  │  ├─images  home下调用的图片文件目录
│  │  ├─Index  首页文件目录
│  │  │  ├─index.html 首页
│  │  │  ├─ ...
│  ├─Admin  同Home
│  ├─User   同Home
├─Upload  公共上传目录
│  ├─images   上传的图片目录
│  │  ├─avatar  头像目录
│  │  ├─ueditor ueditor编辑器上传的图片目录
│  │  │ ...
│  │ ...
├─Runtime 缓存目录
├─ThinkPHP 框架系统目录

/Application/Common/Common/function.php 这个作为常用公共函数文件;

平时经常用的自定义函数都可以放里面;

比如说 之前写过的p函数 以符合人类阅读的方式打印php数组 然后还建议写:判断用户是否登陆的函数、获取当前登陆用户id的函数、上传函数、图片处理函数、验证码函数、分页函数等等;

/Application/Common/Conf 公共配置项目录下 我建议至少创建如下3个文件 config.php、db.php、webconfig.php 为什么要创建3个配置项文件呢?我来详细的讲解这三个文件的作用;

config.php里面都是系统的配置项;

我们这个文件主要是用来覆盖框架默认的配置项;

这个文件好理解些;

db.php 数据库的账号密码等;

单独放一个文件是因为很多时候;

这个文件需要根据应用安装的时候填写的数据库账号密码生成的文件;

具体可以查看文章中的使用:thinkphp安装引导程序 webconfig.php 这个文件放置一些可以在后台更改的配置;

比如说是否关闭网站、网站的关键字之类的;

这个文件独立出来的原因同上;

/Application/Common/Controller 公共控制器目录 为了开发维护升级的方便 以及尽量避免改动框架的文件的原则;

不改动框架的Controller.class.php 所以呢; 这个目录下一定要建一个BaseController.class.php;

以后所有的Controller都继承它;

这样只要在BaseController里面写的方法;

所有的控制器都继承到了; 都可以用到;

就例如我们可以写一些$this->success() $this->error() $this->display()类似的所有Controller都可以用的方法;

但是呢; 我们开发的项目可能会比较复杂;

只有一个BaseController会比较杂乱;

所以我们还可以根据业务需求再建很多XXBaseContr.class.php来继承BaseController; 我们来构建一种场景;

我想能分别控制:关闭整站的访问、只关闭后台管理员的访问、只关闭普通用户的访问;

因为所有的Controller都继承了BaseController.class.php;

所有我只需要在BaseController.class.php的_initialize或者__construct构造函数中写一个die; 这样无论怎么访问都会被die掉而无法继续执行; 这个过程一般是在后台配置的;

再因为后台的的controller都继承了AdminBaseController.class.php所有关闭的道理同上了;

当然只是用来关闭就太低级了; AdminBaseController.class.php 可以在__construct构造函数中判断如果不是管理员; 禁止访问;

我们只需要所有把所有需要有管理员权限才可访问的控制器全部继承 AdminBaseController;

这样这些控制器就不需要每个都判断是否是管理员了;

具体可以看 thinkphp集成系列之rbac的升级版auth权限管理系统demo UserBaseController.class.php 等其他xxBaseController同样道理;

比如说用户的个人中心必须是登陆状态才可访问等等;

还有个HomeController.class.php不用我说就知道可以干嘛了吧;

/Application/Common/Model 公共模型目录 这个目录一定要建一个BaseModel.class.php 为什么呢? 巴拉巴拉。。。 巴拉巴拉。。。 好吧; 我在组织语言的时候;

发现越写越多;

所以我准备单独开一片文章来写BaseModel的问题;

传送门: thinkphp的model模型的设计经验总结

/Application/Common/Tag 公共标签目录 为了方便开发; 我们还是必须要建一个自定义的标签库; My.class.php 什么是标签库呢?我们会发现在模板中tp内置好多标签很好用; 比如说foreach、volist、eq;

官方的文档传送门:内置标签 什么?不知道怎么自定义标签? 好吧; 再来个传送门:thinkphp自定义模板标签

/Public 资源文件目录 可以把boostrap、jquery等第三方插件扔到这里面

/tpl视图目录 建议把每个模块的View都移到这个目录中集中管理;

不然开发的时候各种点目录切换; 那酸爽; 谁用谁知道;

而且方便使用gulp等前端自动化构建工具;

thinkphp把模板文件View 独立出来 /tpl/default/Home/Public/js/base.js 和/tpl/default/Home/Public/css/base.css 强烈建议全站都引用;

里面写一些全站都可以用的样式或函数;

比如css的reset;

其他的看上面的目录就可以看明白的;

就不多啰嗦了;

/Runtime 运行时目录 和tpl一样; 建议都移到最外层;

方便我们删除缓存;

好吧; 认真写博客真的很耗时;

这篇博客写了整整3个小时;

但愿能帮到童鞋们;

thinkphp目录

(完)

原文链接


相关文章

评论

内容导航