快捷導(dǎo)航

PHP中Restful api 錯(cuò)誤提示返回值實(shí)現(xiàn)思路

更新時(shí)間：2016年04月12日 11:47:39 作者：SegmentFault

REST是Representational State Transfer的縮寫(xiě)，翻譯為“表現(xiàn)層狀態(tài)轉(zhuǎn)化”。表現(xiàn)層其實(shí)就是資源，因此可以理解為“資源狀態(tài)轉(zhuǎn)化”。接下來(lái)通過(guò)本文給大家介紹Restful api 錯(cuò)誤提示返回值實(shí)現(xiàn)思路，感興趣的朋友一起學(xué)習(xí)吧

RESTful架構(gòu)是一種流行的互聯(lián)網(wǎng)軟件架構(gòu)，它結(jié)構(gòu)清晰，符合標(biāo)準(zhǔn)，易于理解，擴(kuò)展方便。

REST是Representational State Transfer的縮寫(xiě)，翻譯為“表現(xiàn)層狀態(tài)轉(zhuǎn)化”。表現(xiàn)層其實(shí)就是資源，因此可以理解為“資源狀態(tài)轉(zhuǎn)化”。

網(wǎng)絡(luò)應(yīng)用上的任何實(shí)體都可以看作是一種資源，通過(guò)一個(gè)URI(統(tǒng)一資源定位符)指向它。

序言

不管是微博還是淘寶，他們都有自己的錯(cuò)誤返回值格式規(guī)范，以及錯(cuò)誤代碼說(shuō)明，這樣不但手機(jī)端用起來(lái)方便，給人的感覺(jué)也清晰明了，高大上。遇到問(wèn)題先找母本，大公司的規(guī)范就是我們參照的母本。為此，我仿照了淘寶的錯(cuò)誤返回值格式，根據(jù)微博錯(cuò)誤代碼制定的標(biāo)準(zhǔn)自定了自己的錯(cuò)誤代碼，然后在Restful api 上進(jìn)行測(cè)試。下面我將實(shí)現(xiàn)思路以及測(cè)試結(jié)果分享給大家。

實(shí)現(xiàn)思路

我利用抽象工廠模式去實(shí)現(xiàn)這樣的一個(gè)錯(cuò)誤返回值。選擇這種模式是因?yàn)榭紤]到了這種模式可以提供一個(gè)創(chuàng)建一系列相關(guān)或相互依賴對(duì)象的接口，與我的需求很接近。

代碼分析

1、按這個(gè)路徑common\hint，我新建了個(gè)error文件夾存放我的錯(cuò)誤提示程序文件。這文件夾中主要有這幾個(gè)文件：

2、Hint.php入口文件。定義一個(gè)抽象類，里邊只寫(xiě)一個(gè)方法。

interface Hint {
function Error($_errors,$code);
}

3、Template.php 實(shí)現(xiàn)Hint這個(gè)接口。錯(cuò)誤返回值的格式就在這里定義。

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)建一個(gè)createMsg抽象類。將對(duì)象的創(chuàng)建抽象成一個(gè)接口。

interface createMsg { 
function Msg(); 
}

5、用FactoryMsg 類去實(shí)現(xiàn)createMsg接口。返回實(shí)例化的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無(wú)權(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無(wú)權(quán)限 20005
if(!empty($result4)){ 
$M = $Factory->Msg();
$M->Error($_errors,'20005');die;
}
//默認(rèn)類型 21000
$M = $Factory->Msg();
$M->Error($_errors,'21000');
}
}

7、調(diào)用方式。

use common\hint\error\ErrorMsg;
ErrorMsg::Info(Yii::t('yii','failure'));

8、測(cè)試結(jié)果。

{
"error": {
"name": "Not Found",
"message": "操作失敗",
"error_code": "20003"
}
}

完成。整個(gè)實(shí)現(xiàn)過(guò)程我采用語(yǔ)言包的形式，這樣有利于后期多語(yǔ)言的切換。

常見(jiàn)問(wèn)題

1、采用這種字符串模糊搜索很泛，無(wú)法達(dá)到具體錯(cuò)誤類型返回對(duì)應(yīng)具體代碼的要求。如有更好的建議，歡迎大家提議。

$result = strstr($_errors,Yii::t('yii','Not exist'));

2、實(shí)現(xiàn)過(guò)程中沒(méi)有考慮到今后多語(yǔ)言切換的問(wèn)題，然后直接用傳統(tǒng)的方式傳提示語(yǔ)。比如：ErrorMsg::Info("操作失敗");這樣是無(wú)法實(shí)現(xiàn)多語(yǔ)言切換的。建議大家用語(yǔ)言包的方式傳參。

您可能感興趣的文章: