thinkphp5學習(一)——thinkphp5的目錄結構與開發規範
阿新 • • 發佈:2017-10-23
控制 配置 helper ole url database 數據 tab 工具配置
開發規範:
目錄和文件
- 目錄使用小寫+下劃線;
- 類庫、函數文件統一以
.php
為後綴; - 類的文件名均以命名空間定義,並且命名空間的路徑和類庫文件所在路徑一致;
- 類文件采用駝峰法命名(首字母大寫),其它文件采用小寫+下劃線命名;
- 類名和類文件名保持一致,統一采用駝峰法命名(首字母大寫);
函數和類、屬性命名
- 類的命名采用駝峰法(首字母大寫),例如
UserType
,默認不需要添加後綴,例如User
; - 函數的命名使用小寫字母和下劃線(小寫字母開頭)的方式,例如
getUserName
; - 方法的命名使用駝峰法(首字母小寫),例如
getUserName
; - 屬性的命名使用駝峰法(首字母小寫),例如
instance
- 以雙下劃線“__”打頭的函數或方法作為魔術方法,例如
__autoload
;
常量和配置
- 常量以大寫字母和下劃線命名,例如
THINK_PATH
; - 配置參數以小寫字母和下劃線命名,例如
url_convert
;
數據表和字段
- 數據表和字段采用小寫加下劃線方式命名,並註意字段名不要以下劃線開頭,例如
user_name
字段,不建議使用駝峰和中文作為數據表字段命名
目錄和文件
- 目錄使用小寫+下劃線;
- 類庫、函數文件統一以
User
、UserController
應該直接命名為get_client_ip
; - 方法的命名使用駝峰法(首字母小寫),例如
tableName
、__call
APP_PATH
和url_route_on
和think_user
表和project 應用部署目錄 ├─application 應用目錄(可設置)
│ ├─common 公共模塊目錄(可更改)
│ ├─index 模塊目錄(可更改)
│ │ ├─config.php 模塊配置文件
│ │ ├─common.php 模塊函數文件
│ │ ├─controller 控制器目錄
│ │ ├─model 模型目錄
│ │ ├─view 視圖目錄
│ │ └─ ... 更多類庫目錄
│ ├─command.php 命令行工具配置文件
│ ├─common.php 應用公共(函數)文件
│ ├─config.php 應用(公共)配置文件
│ ├─database.php 數據庫配置文件
│ ├─tags.php 應用行為擴展定義文件
│ └─route.php 路由配置文件
├─extend 擴展類庫目錄(可定義)
├─public WEB 部署目錄(對外訪問目錄)
│ ├─static 靜態資源存放目錄(css,js,image)
│ ├─index.php 應用入口文件
│ ├─router.php 快速測試文件
│ └─.htaccess 用於 apache 的重寫
├─runtime 應用的運行時目錄(可寫,可設置)
├─vendor 第三方類庫目錄(Composer)
├─thinkphp 框架系統目錄
│ ├─lang 語言包目錄
│ ├─library 框架核心類庫目錄
│ │ ├─think Think 類庫包目錄
│ │ └─traits 系統 Traits 目錄
│ ├─tpl 系統模板目錄
│ ├─.htaccess 用於 apache 的重寫
│ ├─.travis.yml CI 定義文件
│ ├─base.php 基礎定義文件
│ ├─composer.json composer 定義文件
│ ├─console.php 控制臺入口文件
│ ├─convention.php 慣例配置文件
│ ├─helper.php 助手函數文件(可選)
│ ├─LICENSE.txt 授權說明文件
│ ├─phpunit.xml 單元測試配置文件
│ ├─README.md README 文件
│ └─start.php 框架引導文件
├─build.php 自動生成定義文件(參考)
├─composer.json composer 定義文件
├─LICENSE.txt 授權說明文件
├─README.md README 文件
├─think 命令行入口文件
thinkphp5學習(一)——thinkphp5的目錄結構與開發規範