站長資訊網
一、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視頻教程》
