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