15621857753

Thinkphp开发规范与单应用模式的目录结构

来源:齐鲁CMS 栏目:Thinkphp 阅读: 日期:2024-10-12

目录使用小写+下划线;类库、函数文件统一以.php为后缀;类的文件名均以命名空间定义,并且命名空间的路径和类库文件所在路径一致;类(包含接口和Trait)文件采用驼峰法命名(首字母大写),其它文件采用小写+下划线命名;类名(包括接口和Trait)和文件名保持一致,统一采用驼峰法命名(首字母大写);

【开发规范】

目录和文件

目录使用小写+下划线;

类库、函数文件统一以.php为后缀;

类的文件名均以命名空间定义,并且命名空间的路径和类库文件所在路径一致;

类(包含接口和Trait)文件采用驼峰法命名(首字母大写),其它文件采用小写+下划线命名;

类名(包括接口和Trait)和文件名保持一致,统一采用驼峰法命名(首字母大写);

函数和类、属性命名

类的命名采用驼峰法(首字母大写),例如 User、UserType;

函数的命名使用小写字母和下划线(小写字母开头)的方式,例如 get_client_ip;

方法的命名使用驼峰法(首字母小写),例如 getUserName;

属性的命名使用驼峰法(首字母小写),例如 tableName、instance;

特例:以双下划线__打头的函数或方法作为魔术方法,例如 __call 和 __autoload;

常量和配置

常量以大写字母和下划线命名,例如 APP_PATH;

配置参数以小写字母和下划线命名,例如 url_route_on 和url_convert;

环境变量定义使用大写字母和下划线命名,例如APP_DEBUG;

数据表和字段

数据表和字段采用小写加下划线方式命名,并注意字段名不要以下划线开头,例如 think_user 表和 user_name字段,不建议使用驼峰和中文作为数据表及字段命名。

【单应用模式】

www  WEB部署目录(或者子目录)
├─app           应用目录
│  ├─controller      控制器目录
│  ├─model           模型目录
│  ├─ ...            更多类库目录
│  │
│  ├─common.php         公共函数文件
│  └─event.php          事件定义文件

├─config                配置目录
│  ├─app.php            应用配置
│  ├─cache.php          缓存配置
│  ├─console.php        控制台配置
│  ├─cookie.php         Cookie配置
│  ├─database.php       数据库配置
│  ├─filesystem.php     文件磁盘配置
│  ├─lang.php           多语言配置
│  ├─log.php            日志配置
│  ├─middleware.php     中间件配置
│  ├─route.php          URL和路由配置
│  ├─session.php        Session配置
│  ├─trace.php          Trace配置
│  └─view.php           视图配置

├─view            视图目录
├─route                 路由定义目录
│  ├─route.php          路由定义文件
│  └─ ...   

├─public                WEB目录(对外访问目录)
│  ├─index.php          入口文件
│  ├─router.php         快速测试文件
│  └─.htaccess          用于apache的重写

├─extend                扩展类库目录
├─runtime               应用的运行时目录(可写,可定制)
├─vendor                Composer类库目录
├─.example.env          环境变量示例文件
├─composer.json         composer 定义文件
├─LICENSE.txt           授权说明文件
├─README.md             README 文件
├─think                 命令行入口文件