《PHP編程:PHP中Restful api 錯誤提示返回值實現(xiàn)思路》要點:
本文介紹了PHP編程:PHP中Restful api 錯誤提示返回值實現(xiàn)思路,希望對您有用。如果有疑問,可以聯(lián)系我們。
RESTful架構(gòu)是一種流行的互聯(lián)網(wǎng)軟件架構(gòu),它結(jié)構(gòu)清晰,符合標準,易于理解,擴展方便.
PHP實例
REST是Representational State Transfer的縮寫,翻譯為“表現(xiàn)層狀態(tài)轉(zhuǎn)化”.表現(xiàn)層其實就是資源,因此可以理解為“資源狀態(tài)轉(zhuǎn)化”.
PHP實例
網(wǎng)絡(luò)應(yīng)用上的任何實體都可以看作是一種資源,通過一個URI(統(tǒng)一資源定位符)指向它.PHP實例
序言PHP實例
不管是微博還是淘寶,他們都有本身的錯誤返回值格式規(guī)范,以及錯誤代碼說明,這樣不但手機端用起來方便,給人的感覺也清晰明了,高大上.遇到問題先找母本,大公司的規(guī)范就是我們參照的母本.為此,我仿照了淘寶的錯誤返回值格式,根據(jù)微博錯誤代碼制定的標準自定了本身的錯誤代碼,然后在Restful api 上進行測試.下面我將實現(xiàn)思路以及測試結(jié)果分享給大家.PHP實例
實現(xiàn)思路PHP實例
我利用抽象工廠模式去實現(xiàn)這樣的一個錯誤返回值.選擇這種模式是因為考慮到了這種模式可以提供一個創(chuàng)建一系列相關(guān)或相互依賴對象的接口,與我的需求很接近.PHP實例
代碼分析PHP實例
1、按這個路徑common\hint,我新建了個error文件夾存放我的錯誤提示程序文件.這文件夾中主要有這幾個文件:PHP實例
2、Hint.php入口文件.定義一個抽象類,里邊只寫一個辦法.PHP實例
interface Hint { function Error($_errors,$code); }
3、Template.php 實現(xiàn)Hint這個接口.錯誤返回值的格式就在這里定義.PHP實例
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)建抽象成一個接口.PHP實例
interface createMsg { function Msg(); }
5、用FactoryMsg 類去實現(xiàn)createMsg接口.返回實例化的Template.PHP實例
class FactoryMsg implements createMsg{ function Msg() { return new Template; } }
6、ErrorMsg.php 給Template里邊的Error辦法傳參.PHP實例
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無權(quán)限 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無權(quán)限 20005 if(!empty($result4)){ $M = $Factory->Msg(); $M->Error($_errors,'20005');die; } //默認類型 21000 $M = $Factory->Msg(); $M->Error($_errors,'21000'); } }
7、調(diào)用方式.PHP實例
use common\hint\error\ErrorMsg; ErrorMsg::Info(Yii::t('yii','failure'));
8、測試結(jié)果.PHP實例
{ "error": { "name": "Not Found", "message": "操作失敗", "error_code": "20003" } }
完成.整個實現(xiàn)過程我采用語言包的形式,這樣有利于后期多語言的切換.PHP實例
常見問題PHP實例
1、采用這種字符串模糊搜索很泛,無法達到具體錯誤類型返回對應(yīng)具體代碼的要求.如有更好的建議,歡迎大家提議.PHP實例
$result = strstr($_errors,Yii::t('yii','Not exist'));
2、實現(xiàn)過程中沒有考慮到今后多語言切換的問題,然后直接用傳統(tǒng)的方式傳提示語.好比:ErrorMsg::Info("操作失敗");這樣是無法實現(xiàn)多語言切換的.建議大家用語言包的方式傳參.PHP實例
《PHP編程:PHP中Restful api 錯誤提示返回值實現(xiàn)思路》是否對您有啟發(fā),歡迎查看更多與《PHP編程:PHP中Restful api 錯誤提示返回值實現(xiàn)思路》相關(guān)教程,學(xué)精學(xué)透。維易PHP學(xué)院為您提供精彩教程。
轉(zhuǎn)載請注明本頁網(wǎng)址:
http://www.fzlkiss.com/jiaocheng/6930.html