開發php介面注意點

標籤：balance   包括   失敗   錯誤   資料格式   uid   升級   大量   體驗   

1.制定規範
　　開發前一定要定好一個規範，比如要定好資料返回的通用參數和格式。關於資料格式，用的比較多的有xml和json，我建議用json，因為json比xml的好處更多。

　　2.精簡的返回資料
　　介面資料因符合需要什麼返回什麼的原則，比如要查詢某個使用者的餘額和註冊時間，網頁裡面的做法可能是select * from user where uid=1，但是介面一定要select balance,regtime from user where uid=1。因為介面返回資料是要有開銷的，要流量的，能少返回資料就盡量少返回，這樣可以大大的提高效能。

　　3.資料類型要嚴格
　　要注意資料的類型，整數類型的資料一定要轉為int，因為app用戶端開發的java、object-c語言對資料類型比較嚴格，類型不對會照成app閃退。

　　4.要寫介面文檔
　　一定要寫好介面文檔，並按照模組寫，而且還要書寫規範，最好的格式是：
　　介面請求地址；請求參數（包括參數名、類型、是否必填）；測試參數舉例；返回參數（參數名，並註明每個參數的含義）。
　　這樣哪怕以後項目很大，以不會照成維護困難的問題。

　　5.保證代碼正確性
　　要驗證保證代碼正確無誤，而且產生環境中要屏蔽掉錯誤，避免頭部有額外的輸出，照成返回的json等資料解析失敗而導致app閃退等。

　　6.要最佳化代碼的效能
　　app要求響應迅速，這樣才能給使用者比較好的體驗感。所以移動介面端在處理商務邏輯的時候，要避免不要執行太複雜的sql語句，或者含有大量的迴圈，能做成緩衝的盡量做緩衝，比如將首頁的熱點模組資訊可以存到redis緩衝中。在不考慮網速的情況下，比較理想的介面回應時間應該是200毫秒以內。

　　7.不要隨意更改舊介面
　　app不像網頁，app一旦發布，有人使用之後，介面就不要亂修改了。以後升級也是，修改要在保證介面原有結構之上進行額外的擴充，否則會導致調用舊版介面的app出現bug。

　　8. 注意介面的安全
　　安全高於一切，必須要保證介面的安全。電話號碼等敏感資訊在傳輸的過程中一定要加密，否則可能會被別人抓包到。拿取使用者資訊的介面一定要驗證許可權，以防止介面被惡意調用，泄密使用者資訊，甚至篡改資訊。

開發php介面注意點