# 開發規范
[上一頁](# "上一頁")[下一頁](# "下一頁")
### 命名規范
使用ThinkPHP開發的過程中應該盡量遵循下列命名規范:
> - 類文件都是以.class.php為后綴(這里是指的ThinkPHP內部使用的類庫文件,不代表外部加載的類庫文件),使用駝峰法命名,并且首字母大寫,例如 `DbMysql.class.php`;
> - 類的命名空間地址和所在的路徑地址一致,例如 `Home\Controller\UserController`類所在的路徑應該是 `Application/Home/Controller/UserController.class.php`;
> - 確保文件的命名和調用大小寫一致,是由于在類Unix系統上面,對大小寫是敏感的(而ThinkPHP在調試模式下面,即使在Windows平臺也會嚴格檢查大小寫);
> - 類名和文件名一致(包括上面說的大小寫一致),例如 `UserController`類的文件命名是`UserController.class.php`, InfoModel類的文件名是`InfoModel.class.php`, 并且不同的類庫的類命名有一定的規范;
> - 函數、配置文件等其他類庫文件之外的一般是以`.php`為后綴(第三方引入的不做要求);
> - 函數的命名使用小寫字母和下劃線的方式,例如 `get_client_ip`;
> - 方法的命名使用駝峰法,并且首字母小寫或者使用下劃線“_”,例如 `getUserName`,`_parseType`,通常下劃線開頭的方法屬于私有方法;
> - 屬性的命名使用駝峰法,并且首字母小寫或者使用下劃線“_”,例如 `tableName`、`_instance`,通常下劃線開頭的屬性屬于私有屬性;
> - 以雙下劃線“__”打頭的函數或方法作為魔法方法,例如 `__call` 和 `__autoload`;
> - 常量以大寫字母和下劃線命名,例如 `HAS_ONE`和 `MANY_TO_MANY`;
> - 配置參數以大寫字母和下劃線命名,例如`HTML_CACHE_ON`;
> - 語言變量以大寫字母和下劃線命名,例如`MY_LANG`,以下劃線打頭的語言變量通常用于系統語言變量,例如 `_CLASS_NOT_EXIST_`;
> - 對變量的命名沒有強制的規范,可以根據團隊規范來進行;
> - ThinkPHP的模板文件默認是以`.html` 為后綴(可以通過配置修改);
> - 數據表和字段采用小寫加下劃線方式命名,并注意字段名不要以下劃線開頭,例如 `think_user` 表和 `user_name`字段是正確寫法,類似 `_username` 這樣的數據表字段可能會被過濾。
特例:在ThinkPHP里面,有一個函數命名的特例,就是單字母大寫函數,這類函數通常是某些操作的快捷定義,或者有特殊的作用。例如:A、D、S、L 方法等等,他們有著特殊的含義,后面會有所了解。
> 由于ThinkPHP默認全部使用UTF-8編碼,所以請確保你的程序文件采用UTF-8編碼格式保存,并且去掉BOM信息頭(去掉BOM頭信息有很多方式,不同的編輯器都有設置方法,也可以用工具進行統一檢測和處理),否則可能導致很多意想不到的問題。
### 開發建議
在使用ThinkPHP進行開發的過程中,我們給出如下建議,會讓你的開發變得更輕松:
> - 遵循框架的命名規范和目錄規范;
> - 開發過程中盡量開啟調試模式,及早發現問題;
> - 多看看日志文件,查找隱患問題;
> - 養成使用I函數獲取輸入變量的好習慣;
> - 更新或者環境改變后遇到問題首要問題是清空Runtime目錄;
[上一頁](# "上一頁")[下一頁](# "下一頁")
- 序言
- 基礎
- 獲取ThinkPHP
- 環境要求
- 目錄結構
- 入口文件
- 自動生成
- 模塊
- 控制器
- 開發規范
- 配置
- 配置格式
- 配置加載
- 讀取配置
- 動態配置
- 擴展配置
- 批量配置
- 架構
- 模塊化設計
- URL模式
- 多層MVC
- CBD模式
- 命名空間
- 自動加載
- 應用模式
- 項目編譯
- 系統流程
- 路由
- 路由定義
- 規則路由
- 正則路由
- 靜態路由
- 閉包支持
- 實例說明
- 控制器
- 控制器定義
- 前置和后置操作
- Action參數綁定
- 偽靜態
- URL大小寫
- URL生成
- AJAX返回
- 跳轉和重定向
- 輸入變量
- 請求類型
- 空操作
- 空控制器
- 操作綁定到類
- 模型
- 模型定義
- 模型實例化
- 字段定義
- 連接數據庫
- 切換數據庫
- 分布式數據庫支持
- 連貫操作
- WHERE
- TABLE
- ALIAS
- DATA
- FIELD
- ORDER
- LIMIT
- PAGE
- GROUP
- HAVING
- JOIN
- UNION
- DISTINCT
- LOCK
- CACHE
- COMMENT
- RELATION
- 命名范圍
- CURD操作
- 數據創建
- 數據寫入
- 數據讀取
- 數據更新
- 數據刪除
- ActiveRecord
- 字段映射
- 查詢語言
- 查詢方式
- 表達式查詢
- 快捷查詢
- 區間查詢
- 組合查詢
- 統計查詢
- SQL查詢
- 動態查詢
- 子查詢
- 自動驗證
- 自動完成
- 參數綁定
- 虛擬模型
- 模型分層
- 視圖模型
- 關聯模型
- 高級模型
- Mongo模型
- 視圖
- 模板定義
- 模板主題
- 模板賦值
- 模板渲染
- 獲取模板地址
- 獲取內容
- 模板引擎
- 模板
- 變量輸出
- 系統變量
- 使用函數
- 默認值輸出
- 使用運算符
- 標簽庫
- 模板繼承
- 修改定界符
- 三元運算
- 包含文件
- 內置標簽
- Volist標簽
- Foreach標簽
- For標簽
- Switch標簽
- 比較標簽
- 范圍判斷標簽
- IF標簽
- Present標簽
- Empty標簽
- Defined標簽
- Assign標簽
- Define標簽
- 標簽嵌套
- import標簽
- 使用PHP代碼
- 原樣輸出
- 模板注釋
- 模板布局
- 模板替換
- 調試
- 調試模式
- 異常處理
- 日志記錄
- 頁面Trace
- Trace方法
- 變量調試
- 性能調試
- 錯誤調試
- 模型調試
- 緩存
- 數據緩存
- 快速緩存
- 查詢緩存
- SQL解析緩存
- 靜態緩存
- 安全
- 輸入過濾
- 表單合法性檢測
- 表單令牌
- 防止SQL注入
- 目錄安全文件
- 保護模板文件
- 上傳安全
- 防止XSS攻擊
- 其他安全建議
- 擴展
- 類庫擴展
- 驅動擴展
- 緩存驅動
- 數據庫驅動
- 日志驅動
- Session驅動
- 存儲驅動
- 模板引擎驅動
- 標簽庫驅動
- 行為擴展
- 標簽擴展
- Widget擴展
- 應用模式
- 部署
- PATH_INFO支持
- URL重寫
- 模塊部署
- 域名部署
- 入口綁定
- 替換入口
- 專題
- SESSION支持
- Cookie支持
- 多語言支持
- 數據分頁
- 文件上傳
- 驗證碼
- 圖像處理
- RESTFul
- RPC
- SAE
- IP獲取和定位
- 附錄
- 常量參考
- 配置參考
- 升級指導
- 更新日志
- 鳴謝
- 關于