摘要:為此,我仿照了淘寶的錯誤返回值格式,根據微博錯誤代碼制定的標準自定了自己的錯誤代碼,然后在上進行測試。實現思路我利用抽象工廠模式去實現這樣的一個錯誤返回值。錯誤返回值的格式就在這里定義。
序言
不管是微博還是淘寶,他們都有自己的錯誤返回值格式規范,以及錯誤代碼說明,這樣不但手機端用起來方便,給人的感覺也清晰明了,高大上。遇到問題先找母本,大公司的規范就是我們參照的母本。為此,我仿照了淘寶的錯誤返回值格式,根據微博錯誤代碼制定的標準自定了自己的錯誤代碼,然后在Restful api 上進行測試。下面我將實現思路以及測試結果分享給大家。
實現思路我利用抽象工廠模式去實現這樣的一個錯誤返回值。選擇這種模式是因為考慮到了這種模式可以提供一個創建一系列相關或相互依賴對象的接口,與我的需求很接近。
代碼分析1、按這個路徑commonhint,我新建了個error文件夾存放我的錯誤提示程序文件。這文件夾中主要有這幾個文件:
2、Hint.php入口文件。定義一個抽象類,里邊只寫一個方法。
interface Hint { function Error($_errors,$code); }
3、Template.php 實現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 再創建一個createMsg抽象類。將對象的創建抽象成一個接口。
interface createMsg { function Msg(); }
5、用FactoryMsg 類去實現createMsg接口。返回實例化的Template。
class FactoryMsg implements createMsg{ function Msg() { return new Template; } }
6、ErrorMsg.php 給Template里邊的Error方法傳參。
class ErrorMsg { // 抽象工廠里的靜態方法 public static function Info($_errors) { $Factory = new FactoryMsg; $result = strstr($_errors,Yii::t("yii","Not exist")); //數據不存在 20001 $result1 = strstr($_errors,Yii::t("yii","Null")); //參數不能為空 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 //數據不存在 20001 if(!empty($result)){ $M = $Factory->Msg(); $M->Error($_errors,"20001");die; } //參數不能為空 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、調用方式。
use commonhinterrorErrorMsg; ErrorMsg::Info(Yii::t("yii","failure"));
8、測試結果。
{ "error": { "name": "Not Found", "message": "操作失敗", "error_code": "20003" } }
完成。整個實現過程我采用語言包的形式,這樣有利于后期多語言的切換。
常見問題1、采用這種字符串模糊搜索很泛,無法達到具體錯誤類型返回對應具體代碼的要求。如有更好的建議,歡迎大家提議。
$result = strstr($_errors,Yii::t("yii","Not exist"));
2、實現過程中沒有考慮到今后多語言切換的問題,然后直接用傳統的方式傳提示語。比如:ErrorMsg::Info("操作失敗");這樣是無法實現多語言切換的。建議大家用語言包的方式傳參。
相關資料1、微博開放平臺:http://open.weibo.com/wiki/Error_code
2、淘寶開放平臺:http://open.taobao.com/doc2/apiDetail.ht...
3、PHP簡單工廠模式、工廠方法模式和抽象工廠模式比較:http://www.phpddt.com/php/php-factory.ht...
文章版權歸作者所有,未經允許請勿轉載,若此文章存在違規行為,您可以聯系管理員刪除。
轉載請注明本文地址:http://specialneedsforspecialkids.com/yun/21528.html
簡介 隨著移動開發和前端開發的崛起,越來越多的 Web 后端應用都傾向于實現 Restful API。Restful API 是一個簡單易用的前后端分離方案,它只需要對客戶端請求進行處理,然后返回結果即可, 無需考慮頁面渲染,一定程度上減輕了后端開發人員的負擔。然而,正是由于 Restful API 不需要考慮頁面渲染,導致它不能在頁面上展示錯誤信息。那就意著當出現錯誤的時候,它只能通過返回一個錯...
摘要:區間表示參數錯誤區間表示用戶錯誤區間表示接口異常這樣前端開發人員在得到返回值后,根據狀態碼就可以知道,大概什么錯誤,再根據相關的信息描述,可以快速定位。享學課堂特邀作者:老顧前言在移動互聯網,分布式、微服務盛行的今天,現在項目絕大部分都采用的微服務框架,前后端分離方式,(題外話:前后端的工作職責越來越明確,現在的前端都稱之為大前端,技術棧以及生態圈都已經非常成熟;以前后端人員瞧不起前端人員,...
摘要:設計風格協議與用戶的通信協議,總是使用協議域名應該盡量將部署在專用域名之下,如果確定很簡單,不會有進一步的擴展,可以考慮放在主域名之下。數據庫中的表示記錄同種數據的集合,所以中的名詞也應該使用復數。 showImg(https://segmentfault.com/img/bVbdXlE?w=1560&h=913); RESTful Api設計風格 協議:API與用戶的通信協議,總是使...
閱讀 3893·2021-09-27 13:35
閱讀 1075·2021-09-24 09:48
閱讀 2904·2021-09-22 15:42
閱讀 2345·2021-09-22 15:28
閱讀 3151·2019-08-30 15:43
閱讀 2618·2019-08-30 13:52
閱讀 2976·2019-08-29 12:48
閱讀 1455·2019-08-26 13:55