/*************************************************************************************************/
/* RTAPIManagerValidator */
/*************************************************************************************************/
//驗(yàn)證器,用于驗(yàn)證API的返回或者調(diào)用API的參數(shù)是否正確
使用場(chǎng)景:
當(dāng)我們確認(rèn)一個(gè)api是否真正調(diào)用成功時(shí),要看的不光是status态罪,還有具體的數(shù)據(jù)內(nèi)容是否為空辕宏。由于每個(gè)api中的內(nèi)容對(duì)應(yīng)的key都不一定一樣豺型,甚至于其數(shù)據(jù)結(jié)構(gòu)也不一定一樣灌旧,因此對(duì)每一個(gè)api的返回?cái)?shù)據(jù)做判斷是必要的步绸,但又是難以組織的。
為了解決這個(gè)問(wèn)題坑赡,manager有一個(gè)自己的validator來(lái)做這些事情烙如,一般情況下,manager的validator可以就是manager自身毅否。
1.有的時(shí)候可能多個(gè)api返回的數(shù)據(jù)內(nèi)容的格式是一樣的亚铁,那么他們就可以共用一個(gè)validator。
2.有的時(shí)候api有修改螟加,并導(dǎo)致了返回?cái)?shù)據(jù)的改變徘溢。在以前要針對(duì)這個(gè)改變的數(shù)據(jù)來(lái)做驗(yàn)證,是需要在每一個(gè)接收api回調(diào)的地方都修改一下的捆探。但是現(xiàn)在就可以只要在一個(gè)地方修改判斷邏輯就可以了然爆。
3.有一種情況是manager調(diào)用api時(shí)使用的參數(shù)不一定是明文傳遞的,有可能是從某個(gè)變量或者跨越了好多層的對(duì)象中來(lái)獲得參數(shù)徐许,那么在調(diào)用api的最后一關(guān)會(huì)有一個(gè)參數(shù)驗(yàn)證施蜜,當(dāng)參數(shù)不對(duì)時(shí)不訪問(wèn)api,同時(shí)自身的errorType將會(huì)變?yōu)镽TAPIManagerErrorTypeParamsError雌隅。這個(gè)機(jī)制可以?xún)?yōu)化我們的app翻默。
william補(bǔ)充(2013-12-6):
4.特殊場(chǎng)景:租房發(fā)房,用戶(hù)會(huì)被要求填很多參數(shù)恰起,這些參數(shù)都有一定的規(guī)則修械,比如郵箱地址或是手機(jī)號(hào)碼等等,我們可以在validator里判斷郵箱或者電話(huà)是否符合規(guī)則检盼,比如描述是否超過(guò)十個(gè)字肯污。從而manager在調(diào)用API之前可以驗(yàn)證這些參數(shù),通過(guò)manager的回調(diào)函數(shù)告知上層controller吨枉。避免無(wú)效的API請(qǐng)求蹦渣。加快響應(yīng)速度,也可以多個(gè)manager共用.
@protocol RTAPIManagerValidator <NSObject>
@required
/*
所有的callback數(shù)據(jù)都應(yīng)該在這個(gè)函數(shù)里面進(jìn)行檢查貌亭,事實(shí)上柬唯,到了回調(diào)delegate的函數(shù)里面是不需要再額外驗(yàn)證返回?cái)?shù)據(jù)是否為空的。
因?yàn)榕袛噙壿嫸荚谶@里做掉了圃庭。
而且本來(lái)判斷返回?cái)?shù)據(jù)是否正確的邏輯就應(yīng)該交給manager去做锄奢,不要放到回調(diào)到controller的delegate方法里面去做。
*/
- (BOOL)manager:(RTAPIBaseManager *)manager isCorrectWithCallBackData:(NSDictionary *)data;
/*
“
william補(bǔ)充(2013-12-6):
4.特殊場(chǎng)景:租房發(fā)房剧腻,用戶(hù)會(huì)被要求填很多參數(shù)拘央,這些參數(shù)都有一定的規(guī)則,比如郵箱地址或是手機(jī)號(hào)碼等等书在,我們可以在validator里判斷郵箱或者電話(huà)是否符合規(guī)則灰伟,比如描述是否超過(guò)十個(gè)字。從而manager在調(diào)用API之前可以驗(yàn)證這些參數(shù)儒旬,通過(guò)manager的回調(diào)函數(shù)告知上層controller袱箱。避免無(wú)效的API請(qǐng)求遏乔。加快響應(yīng)速度,也可以多個(gè)manager共用.
”
所以不要以為這個(gè)params驗(yàn)證不重要发笔。當(dāng)調(diào)用API的參數(shù)是來(lái)自用戶(hù)輸入的時(shí)候盟萨,驗(yàn)證是很必要的。
當(dāng)調(diào)用API的參數(shù)不是來(lái)自用戶(hù)輸入的時(shí)候了讨,這個(gè)方法可以寫(xiě)成直接返回true捻激。反正哪天要真是參數(shù)錯(cuò)誤,QA那一關(guān)肯定過(guò)不掉前计。
不過(guò)我還是建議認(rèn)真寫(xiě)完這個(gè)參數(shù)驗(yàn)證胞谭,這樣能夠省去將來(lái)代碼維護(hù)者很多的時(shí)間。
*/
- (BOOL)manager:(RTAPIBaseManager *)manager isCorrectWithParamsData:(NSDictionary *)data;
@end