分享一份PHP開發內部規範

藏色散人
發布: 2023-04-10 19:48:01
轉載
3464 人瀏覽過

一、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、「預發布分支」禁止合併到「開發分支」
PHP開發內部規範,歡迎提出最佳化建議~
推薦學習:《PHP影片教學

以上是分享一份PHP開發內部規範的詳細內容。更多資訊請關注PHP中文網其他相關文章!

相關標籤:
來源:learnku.com
本網站聲明
本文內容由網友自願投稿,版權歸原作者所有。本站不承擔相應的法律責任。如發現涉嫌抄襲或侵權的內容,請聯絡admin@php.cn
熱門教學
更多>
最新下載
更多>
網站特效
網站源碼
網站素材
前端模板