PHP中Restful api 錯誤提示返回值實現(xiàn)思路
RESTful架構是一種流行的互聯(lián)網(wǎng)軟件架構,它結構清晰,符合標準,易于理解,擴展方便。
REST是Representational State Transfer的縮寫,翻譯為“表現(xiàn)層狀態(tài)轉化”。表現(xiàn)層其實就是資源,因此可以理解為“資源狀態(tài)轉化”。
網(wǎng)絡應用上的任何實體都可以看作是一種資源,通過一個URI(統(tǒng)一資源定位符)指向它。
序言
不管是微博還是淘寶,他們都有自己的錯誤返回值格式規(guī)范,以及錯誤代碼說明,這樣不但手機端用起來方便,給人的感覺也清晰明了,高大上。遇到問題先找母本,大公司的規(guī)范就是我們參照的母本。為此,我仿照了淘寶的錯誤返回值格式,根據(jù)微博錯誤代碼制定的標準自定了自己的錯誤代碼,然后在Restful api 上進行測試。下面我將實現(xiàn)思路以及測試結果分享給大家。
實現(xiàn)思路
我利用抽象工廠模式去實現(xiàn)這樣的一個錯誤返回值。選擇這種模式是因為考慮到了這種模式可以提供一個創(chuàng)建一系列相關或相互依賴對象的接口,與我的需求很接近。
代碼分析
1、按這個路徑common\hint,我新建了個error文件夾存放我的錯誤提示程序文件。這文件夾中主要有這幾個文件:
2、Hint.php入口文件。定義一個抽象類,里邊只寫一個方法。
interface Hint { function Error($_errors,$code); }
3、Template.php 實現(xiàn)Hint這個接口。錯誤返回值的格式就在這里定義。
class Template implements Hint{ function Error($_errors,$code) { if (empty($_errors)) { print_r(json_encode([])); } else { $errors['error']['name'] = 'Not Found'; $errors['error']['message'] = $_errors; $errors['error']['error_code'] = $code; print_r(json_encode($errors)); } } }
4、createMsg.php 再創(chuàng)建一個createMsg抽象類。將對象的創(chuàng)建抽象成一個接口。
interface createMsg { function Msg(); }
5、用FactoryMsg 類去實現(xiàn)createMsg接口。返回實例化的Template。
class FactoryMsg implements createMsg{ function Msg() { return new Template; } }
6、ErrorMsg.php 給Template里邊的Error方法傳參。
class ErrorMsg { // 抽象工廠里的靜態(tài)方法 public static function Info($_errors) { $Factory = new FactoryMsg; $result = strstr($_errors,Yii::t('yii','Not exist')); //數(shù)據(jù)不存在 20001 $result1 = strstr($_errors,Yii::t('yii','Null')); //參數(shù)不能為空 20002 $result2 = strstr($_errors,Yii::t('yii','Fail')); //新增、更新、刪除失敗 20003 $result3 = strstr($_errors,Yii::t('yii','Not right')); //XX不正確 20004 $result4 = strstr($_errors,Yii::t('yii','Robc')); //XX無權限 20005 //數(shù)據(jù)不存在 20001 if(!empty($result)){ $M = $Factory->Msg(); $M->Error($_errors,'20001');die; } //參數(shù)不能為空 20002 if(!empty($result1)){ $M = $Factory->Msg(); $M->Error($_errors,'20002');die; } //新增、更新、刪除失敗 20003 if(!empty($result2)){ $M = $Factory->Msg(); $M->Error($_errors,'20003');die; } //XX不正確 20004 if(!empty($result3)){ $M = $Factory->Msg(); $M->Error($_errors,'20004');die; } //XX無權限 20005 if(!empty($result4)){ $M = $Factory->Msg(); $M->Error($_errors,'20005');die; } //默認類型 21000 $M = $Factory->Msg(); $M->Error($_errors,'21000'); } }
7、調(diào)用方式。
use common\hint\error\ErrorMsg; ErrorMsg::Info(Yii::t('yii','failure'));
8、測試結果。
{ "error": { "name": "Not Found", "message": "操作失敗", "error_code": "20003" } }
完成。整個實現(xiàn)過程我采用語言包的形式,這樣有利于后期多語言的切換。
常見問題
1、采用這種字符串模糊搜索很泛,無法達到具體錯誤類型返回對應具體代碼的要求。如有更好的建議,歡迎大家提議。
$result = strstr($_errors,Yii::t('yii','Not exist'));
2、實現(xiàn)過程中沒有考慮到今后多語言切換的問題,然后直接用傳統(tǒng)的方式傳提示語。比如:ErrorMsg::Info("操作失敗");這樣是無法實現(xiàn)多語言切換的。建議大家用語言包的方式傳參。
相關文章
CI框架源碼解讀之URI.php中_fetch_uri_string()函數(shù)用法分析
這篇文章主要介紹了CI框架源碼解讀之URI.php中_fetch_uri_string()函數(shù)用法,結合實例形式分析了CI框架中URL路由機制的原理與相關的config配置文件設置方法,需要的朋友可以參考下2016-05-05用php實現(xiàn)百度網(wǎng)盤圖片直鏈的代碼分享
華為網(wǎng)盤有個直鏈功能,不過需要錢買。我有百度網(wǎng)盤,不過百度的網(wǎng)盤外鏈不能在網(wǎng)頁里直接使用圖片 華為的直鏈功能可以做到。百度哪天也能有這功能就好了。2012-11-11使用PHP抓取微博數(shù)據(jù)實現(xiàn)demo及原理解析
這篇文章主要為大家介紹了使用PHP抓取微博數(shù)據(jù)實現(xiàn)demo及原理解析,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進步,早日升職加薪2023-05-05