PHP開發規格總結

這次帶給大家PHP開發規範總結，PHP開發規範的注意事項有哪些，以下就是實戰案例，一起來看一下。

基本約定

原始檔

#程式碼使用

檔案格式必須是無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     = &#39;不具有权限&#39;;
  const STATUS_EXCEPTION   = 1000002;
  const STATUS_EXCEPTION_MSG = &#39;状态异常&#39;;    
}

資料表檔案如有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對原始碼加密方法總結

#如何實作php刪除固定路徑下資料夾與檔案

以上是PHP開發規格總結的詳細內容。更多資訊請關注PHP中文網其他相關文章！