本文主要和大家分享PHP開發規範實例詳解,希望能幫助大家。
程式碼使用3912fcd8e8d5c1346dfc1bd5d3011cff
檔案格式必須是無BOM UTF-8格式
一個檔案只宣告一種類型,如class和interface不能混合在一個原始檔中
使用4個空格來縮進,IDE可以設定
每行120個字元
所有關鍵字都是小寫,如true、false
#類別名為大駝峰法,如UserModel
類別方法名為小駝峰法,如getUserId()
函數使用小寫字母加上_組合,如get_cookie()
變數名稱使用小駝峰法,如$userId
常數定義為大寫字母加_組合,如IS_DEBUG
類別文件中對類別、方法、屬性進行註釋,使用@param @return @throwns
@param註釋寫出詳解,如@param string $username 用戶名
路由為小寫字母加_組成,如/api/get_user_info
#View層負責資料展示
Controller層負責輸入參數校驗,最外層捕捉異常,呼叫Logic和View視圖層
Logic層負責特定業務邏輯,呼叫Model層,回傳處理資料
Model層負責資料表查詢與關聯關係
異常類別需分清功能,如ParamException表示參數錯誤,UserException表示自訂異常
異常需分類定義code,使用PHP類常數代替,如
<?php namespace app\exceptions\codes; class UserExceptionCode extends BaseExceptionCode { const NO_AUTH = 1000001; const NO_AUTH_MSG = '不具有权限'; const STATUS_EXCEPTION = 1000002; const STATUS_EXCEPTION_MSG = '状态异常'; }
資料表檔案如有Enum型別,使用PHP類別常數代替,如
<?php namespace app\enums; class UserEnum extends BaseEnum { const STATUS_DELETED = -1;// 已删除 const STATUS_DISABLE = 0;// 禁用 const STATUS_ENABLE = 1;// 正常 const AUTH_GUEST = 1;// 匿名用户 const AUTH_GENERAL_ADMIN = 2;// 普通管理员 const AUTH_SUPER_ADMIN = 3;// 超级管理员 }
其中STATUS和AUTH為資料表映射字段名
Api介面輸出,範例
{ "code" : 0, "msg" : "success", "data" : { "userId" : 100 } }
其中code與msg為必填字段, data為空的情況下不填,範例
{ "code" : 100001, "msg" : "不具有权限" }
數組,鍵為字串時候使用單引號,只有一個鍵時候使用單行,範例
$arr = [ 'userId' => 100 ];
多個鍵時候使用多行,範例
$arr = [ 'id' => 100, 'username' => 'admin', ];
字串使用單引號'
相關推薦:
以上是PHP開發規範實例詳解的詳細內容。更多資訊請關注PHP中文網其他相關文章!