從" ThinkPHP 開發規范 "看 PHP 的命名規范和開發建議


稍稍水一篇博客,摘抄自 Think PHP 的開發規范,很有引導性,我們可以將這些規范實踐到原生 PHP 中。

命名規范

使用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目錄;


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM