PHP開發內部規範,歡迎提出優化建議

huangYX發表於2021-11-12

一、PHP注意事項

  • 1、URL請求地址採用”-“分割。(已執行,部分人未按標準執行)
  • 2、方法名採用駝峰法。(已執行,部分人未按標準執行)
  • 3、引數必須小寫和下劃線分割,嚴禁使用駝峰或者其它格式,且提交引數與返回欄位名一致。 (已執行,部分人未按標準執行)
  • 4、獲取資料採用GET, 新增,修改必須POST 。(已執行,部分人未按標準執行)
  • 5、API返回格式必須呼叫jsonResult基礎方法。(已執行)
    6、錯誤碼必須呼叫ErrCode,不能直接寫錯誤碼數字。(已執行)
  • 7、分頁採用框架自帶的, 自建二維陣列必須[‘data’ => $arr], 分頁條目必須使用limit引數。(已執行)
  • 8、介面返回備註資訊(msg),必須寫在config.msg檔案。(新增)
  • 9、redis的key必須寫在config.redis_key檔案。(已執行,部分人未按標準執行)
  • 10、composer安裝新依賴必須寫doc/composer.txt檔案中,並說明用途。(已執行)
  • 11、新增定時任務,程式必須寫doc/crontab.txt檔案中,並說明用途。(已執行)
  • 12、redis必須有設定過期時間。否則存mysql,再快取(新增)
  • 13、model名字與表名一致(如:表q_user MODEL:QUser )
  • 14、請求外網地址,必須設定請求時長2s
  • 15、redis不儲存長期資料, 只用於快取和臨時資料儲存(後期轉移非常容易導致資料丟失)

二、mysql注意事項
新增表(負責人:劉軍)

  • 1、字符集utf8mb4 排序規範utf8mb4_unicode_ci(已執行,部分人未按標準執行)
  • 2、資料庫欄位必須小寫+下劃線(已執行,部分人未按標準執行)
  • 3、新表欄位必須有status,created_at,updated_at(關聯表經常漏掉三個欄位)
  • 4、status狀態必須1啟用, 0禁用
  • 5、儘量不使用NULL
    查詢
  • 1、查詢sql欄位必須加上表名(線上已出現過問題)
  • 2、嚴禁使用*號查詢
  • 3、sql語句必須寫model,不能寫在控制器
    更新、插入、刪除
  • 1、更新、插入、刪除多條資料,非日誌型別必須“採用事務”(保證一致性)

三、YAPI文件注意事項

  • 1、欄位說明必須與產品文件保持一致(前端反饋核對欄位不清晰)
  • 2、迭代版本介面需新增版本目錄 (防止混亂)
  • 3、介面有變更,必須同步更新介面文件

四、合併分支事項

  • 1、必須以master建立分支開發,且帶上自己的名字(origin/hotfix/huang/slowOpt)
  • 2、釋出至master,必須先合master到開發分支
  • 3、“測試分支”禁止合併到“開發分支”
  • 4、“預釋出分支”禁止合併到“開發分支”
本作品採用《CC 協議》,轉載必須註明作者和本文連結

相關文章