PHP開發(fā)內(nèi)部規(guī)范有哪些

本篇內(nèi)容介紹了“PHP開發(fā)內(nèi)部規(guī)范有哪些”的有關(guān)知識(shí)，在實(shí)際案例的操作過(guò)程中，不少人都會(huì)遇到這樣的困境，接下來(lái)就讓小編帶領(lǐng)大家學(xué)習(xí)一下如何處理這些情況吧！希望大家仔細(xì)閱讀，能夠?qū)W有所成！                        

一、PHP注意事項(xiàng)

• 1、URL請(qǐng)求地址采用”-“分割。（已執(zhí)行，部分人未按標(biāo)準(zhǔn)執(zhí)行）

• 2、方法名采用駝峰法。（已執(zhí)行，部分人未按標(biāo)準(zhǔn)執(zhí)行）

• 3、參數(shù)必須小寫和下劃線分割，嚴(yán)禁使用駝峰或者其它格式，且提交參數(shù)與返回字段名一致。 （已執(zhí)行，部分人未按標(biāo)準(zhǔn)執(zhí)行）

• 4、獲取數(shù)據(jù)采用GET, 添加，修改必須POST 。（已執(zhí)行，部分人未按標(biāo)準(zhǔn)執(zhí)行）

• 5、API返回格式必須調(diào)用jsonResult基礎(chǔ)方法。（已執(zhí)行）
  6、錯(cuò)誤碼必須調(diào)用ErrCode，不能直接寫錯(cuò)誤碼數(shù)字。（已執(zhí)行）

• 7、分頁(yè)采用框架自帶的， 自建二維數(shù)組必須[‘data’ => $arr], 分頁(yè)條目必須使用limit參數(shù)。（已執(zhí)行）

• 8、接口返回備注信息（msg）,必須寫在config.msg文件。（新增）

• 9、redis的key必須寫在config.redis_key文件。（已執(zhí)行，部分人未按標(biāo)準(zhǔn)執(zhí)行）

• 10、composer安裝新依賴必須寫doc/composer.txt文件中，并說(shuō)明用途。（已執(zhí)行）

• 11、新增定時(shí)任務(wù)，進(jìn)程必須寫doc/crontab.txt文件中，并說(shuō)明用途。（已執(zhí)行）

• 12、redis必須有設(shè)置過(guò)期時(shí)間。否則存mysql，再緩存（新增）

• 13、model名字與表名一致（如：表q_user  MODEL：QUser ）

• 14、請(qǐng)求外網(wǎng)地址，必須設(shè)置請(qǐng)求時(shí)長(zhǎng)2s

• 15、redis不存儲(chǔ)長(zhǎng)期數(shù)據(jù)， 只用于緩存和臨時(shí)數(shù)據(jù)存儲(chǔ)（后期轉(zhuǎn)移非常容易導(dǎo)致數(shù)據(jù)丟失）

二、mysql注意事項(xiàng)
新增表（負(fù)責(zé)人：劉軍）

• 1、字符集utf8mb4 排序規(guī)范utf8mb4_unicode_ci（已執(zhí)行，部分人未按標(biāo)準(zhǔn)執(zhí)行）

• 2、數(shù)據(jù)庫(kù)字段必須小寫+下劃線（已執(zhí)行，部分人未按標(biāo)準(zhǔn)執(zhí)行）

• 3、新表字段必須有status,created_at,updated_at（關(guān)聯(lián)表經(jīng)常漏掉三個(gè)字段）

• 4、status狀態(tài)必須1啟用， 0禁用

• 5、盡量不使用NULL
  查詢

• 1、查詢sql字段必須加上表名（線上已出現(xiàn)過(guò)問(wèn)題）

• 2、嚴(yán)禁使用*號(hào)查詢

• 3、sql語(yǔ)句必須寫model，不能寫在控制器
  更新、插入、刪除

• 1、更新、插入、刪除多條數(shù)據(jù)，非日志類型必須“采用事務(wù)”（保證一致性）

三、YAPI文檔注意事項(xiàng)

• 1、字段說(shuō)明必須與產(chǎn)品文檔保持一致（前端反饋核對(duì)字段不清晰）

• 2、迭代版本接口需新增版本目錄 （防止混亂）

• 3、接口有變更，必須同步更新接口文檔

四、合并分支事項(xiàng)

• 1、必須以master創(chuàng)建分支開發(fā)，且?guī)献约旱拿郑╫rigin/hotfix/huang/slowOpt）

• 2、發(fā)布至master，必須先合master到開發(fā)分支

• 3、“測(cè)試分支”禁止合并到“開發(fā)分支”

• 4、“預(yù)發(fā)布分支”禁止合并到“開發(fā)分支”

“PHP開發(fā)內(nèi)部規(guī)范有哪些”的內(nèi)容就介紹到這里了，感謝大家的閱讀。如果想了解更多行業(yè)相關(guān)的知識(shí)可以關(guān)注億速云網(wǎng)站，小編將為大家輸出更多高質(zhì)量的實(shí)用文章！