iOS开发-网络-合理封装请求接口

概述如今大多App都会与网络打交道,作为开发者,合理的对网络后台请求接口进行封装十分重要。本文要介绍的就是一种常见的采用回调函数(方法)的网络接口封装,也算的是一种构架吧。这个构架主要的idea是这样的,把所有的接口封装成一个类,在工程中随时可以调用。并且利用代理Delegate构建回调方法(callBack),工程中随处可以通过回调方法监听网络请求的反馈,也就是说,一旦得到了服务器反馈的数据,回调函数中的代码就(才)会被激活。网络请求基于AFNetworking(AFNetworking,非常有名的网络请求第三方类库),请求均为异步。如此构架,非常灵活很容易扩展和复用。 讲解要想使用本文介绍的构架,你首先需要掌握代理(Delegate),如果你不熟悉代理,这个构架对你来说将会很不解。对于不熟悉代理的同学们,建议你们去看一下资料。网络请求其实说白了就是和服务器做一个数据交互,App把请求数据发给服务器,服务器返回给App一个反馈数据。请先看一下这个构架的示意图,如下:如上图,这个构架的主要节点有三个,封装网络请求的类(接口类)、使用网络请求的类(图中的ViewController)、和服务器。Ok~故事是这样的,一个夜黑风高的...醉醺醺ViewController走在湖边,为了找回被关在云端的Data,他苦练数载终于参透了《接口类》,天地无情,今天是时候做个了断了。于是乎他从怀中拿出了传说中的“接口类”,使用内力,实例化了一个接口类的对象,接着口中念出“接口类实例.delegate=self”,拔出利剑在身旁实现了“接口类”中的一个代理方法。然后调用接口的方法,方法通过内嵌的AFNetworking,向服务器发出了一道请求。又是一阵夜风吹过,三两枯叶瑟瑟落下。ViewController酣意渐浓闭上了眼睛,现在他能做的唯有等待...镜头一转,月色中,在天上,在云端的服务器,ViewController刚才发出的请求正在兴风作浪,云端值夜班的众神丝毫不敢怠慢各个健步如飞,从数据库中搜索着能化解这道请求的神器。此时,ViewController困意渐浓,眼皮似坠了千金重物,意识也渐渐模糊。突然云端显出异像,ViewController顿时醒了过来,隐约可以看到,云端有数据丝丝缕缕的流动,而自己怀中的“接口类”内嵌的AFNetworking也变得炽热起来,HTTP反馈block像是要爆炸一样的颤动着。ViewController豆大的汗珠从额头滚下,再也不能淡定,口中叨咕着,快了,快来了... 一个霹雳,刚才用剑实现的代理方法金光一闪刺得ViewController捂住了双眼。一切都回归安静后,ViewController睁开眼睛,发现Data安静的躺在代理方法的里面... 代码示例下面通过一个例子,来介绍一下。打开Xcode我建了一个SingleViewApp,然后把AFNetworking加载进工程,如下图:我们 OpenWeatherMap提供的天气预报的API作为例子,简单地利用上述构架,做一个天气预报的App我们来看一下这个接口怎么用,很简单:例子:http://api.openweathermap.org/data/2.5/weather?q=beijing参数:q=城市名字返回Json:{"coord":{"lon":116.4,"lat":39.91},"sys":{"type":1,"id":7405,"message":0.013,"country":"CN","sunrise":1435870233,"sunset":1435924003},"weather":[{"id":800,"main":"Clear","description":"Sky is Clear","icon":"01d"}],"base":"stations","main":{"temp":305.43,"pressure":1008,"humidity":28,"temp_min":302.15,"temp_max":308.71},"visibility":10000,"wind":{"speed":2,"deg":0},"clouds":{"all":0},"dt":1435900364,"id":1816670,"name":"Beijing","cod":200}为了简单我们的Demo App就只显示 天气和温度,UI如下图:简单直观,点击不同城市名字命名的按钮,在Label中显示其天气状况,关于UI不是今天讨论的重点,我们主要讨论网络和接口。 现在开始重头戏:接口类新建一个类我把它命名为“Net”类,继承NSObject,并导入"AFNetworking.h"头文件:复制代码////  Net.h//  NetInterface////  Created by Oliver on 15/7/3.//#import#import "AFNetworking.h"@interface Net : NSObject@end复制代码这个类就是我们一直提到的接口类,我们要吧所有的网络接口都写到这个类里面。现在写一个天气预报接口作为例子。为天气预报接口在Net类里声明一个实例方法,由于这个接口需要传得参数只有一个城市名称,在Net类的H文件所以方法声明如下:/** *  获得某城市的天气 * *  @param cityName 城市名称 */-(void)getWeatherInfoWithCity:(NSString *)cityName;一起看起来都很美好对不对?那么现在我要提一点,可能会被大家忽略的因素。由于我们实际开发的App调用接口的次数可能会很多,而且调用接口的类也很多,所以,Net这个类将会被多次的实例化,那么很有可能App的网络层会变得很乱更有甚者会出Bug。所以,像这样的接口类,我们有必要将它做成单例的,整个App共享一个接口类的实例。Ok,下面就来介绍获取单例的方法:在H文件声明获取单例的方法:/** *  获取Net类的单例 * *  @return Net类的单例 实例(对象) */+(Net *)getInstance;接下来我们在Net.m文件实现获取单例方法:(因为所有的接口请求都是HPPT请求,会用到AFNetworking的AFHTTPRequestOperationManager,所以我在getInstace方法里面把Manager也单例了)复制代码#import "Net.h"__strong static AFHTTPRequestOperationManager *AFHTTPMgr;__strong static Net *NetInstance=nil;@implementation Net+(Net *)getInstance{    static dispatch_once_t onceToken;    dispatch_once(&onceToken,^{        NetInstance= [[Net alloc]init];//初始化实例                //一下是AFHTTPOerrationManager的配置        AFHTTPMgr=[AFHTTPRequestOperationManager manager];        //申明返回的结果是json类型        AFHTTPMgr.responseSerializer=[AFJSONResponseSerializer serializer];        //申明请求的数据是json类型        AFHTTPMgr.requestSerializer=[AFJSONRequestSerializer serializer];        //如果报接受类型不一致请替换一致text/xml或别的        //AFHTTPMgr.responseSerializer.acceptableContentTypes= [NSSet setWithObject:@"text/xml"];        //设置超时时间        AFHTTPMgr.requestSerializer.timeoutInterval=5;    });    return NetInstance;}@end复制代码上面代码中,因为很变量的操作是在Block中做的,而block中不能对block外的变量进行重新更改,所以在程序的实现之前,声明了:__strong static AFHTTPRequestOperationManager *AFHTTPMgr;__strong static Net *NetInstance=nil;以便在单例的Block里面对其进行更改。接下啦,我们就可以继续去实现接口的方法getWeatherInfoWithCity:复制代码-(void)getWeatherInfoWithCity:(NSString *)cityName{    //接口地址    NSString *url=[NSString stringWithFormat:@"http://api.openweathermap.org/data/2.5/weather"];    //参数    NSDictionary *parameters=[[NSDictionary alloc]initWithObjectsAndKeys:cityName,@"q", nil];    //发请求    [AFHTTPMgr GET:url parameters:parameters success:^(AFHTTPRequestOperation *operation, id responseObject) {        //请求成功Block    } failure:^(AFHTTPRequestOperation *operation, NSError *error) {        //请求失败Blick    }];}复制代码如上代码所示,这就是我们获取天气预报的接口,AFNetworking的请求成功和请求失败的回调Block我们暂且空着,因为,我们要设置了Delegate再用。为什么我们要用代理而不是直接把想做的事情放在AFNetworking的Block里面呢?答案其实显而易见,Block是轻量级的代码块,虽然使用简单,但是非常的封闭,与外部(Block外)进行数据交换的能力非常的有限。比如我们天气预报的例子,我们的ViewController类希望通过服务器返回的天气信息,改变UILabel的信息,而这个数据又在Net这个类的Block里面,没办法传递给ViewController,这就让局面变得非常尴尬。所以我们要使用代理Delegate。其实Delegate的核心的作用就是来实现类之间的数据传递。现在请你,再次看一下上面的那张架构示意图,我想你会对其有更深的理解。下面,声明Net类的代理,H文件的代码如下:在导入头文件声明和@interface之间 用@protocol声明代理复制代码//  Net.h//  NetInterface#import#import "AFNetworking.h"//代理@protocol NetDelegate/** *  代理回调方法 * *  @param feedbackInfo 服务器返回的数据 */-(void)getWeatherInfoSuccessFeedback:(id)feedbackInfo;-(void)getWeatherInfoFailFeedback:(id)failInfo;@end@interface Net : NSObject@property (nonatomic,strong) iddelegate;/** *  获取Net类的单例 * *  @return Net类的单例 实例(对象) */+(Net *)getInstance;/** *  获得某城市的天气 * *  @param cityName 城市名称 */-(void)getWeatherInfoWithCity:(NSString *)cityName;@end复制代码  如上代码,这是Net类的完整地H文件,我们在代理部分,声明了两个方法,一个请求成功、一个请求失败。在代理中申明的代理方法,我们不用去实现它,而是在M文件总直接使用它。如果自己要使用的代理我们需要将代理声明为自己的成员变量:@property (nonatomic,strong) iddelegate;OK,现在让我们回到getWeatherInfoWithCirt:方法,在Block中使用代理方法。代码如下:复制代码-(void)getWeatherInfoWithCity:(NSString *)cityName{    //接口地址    NSString *url=[NSString stringWithFormat:@"http://api.openweathermap.org/data/2.5/weather"];    //参数    NSDictionary *parameters=[[NSDictionary alloc]initWithObjectsAndKeys:cityName,@"q", nil];    //发请求    [AFHTTPMgr GET:url parameters:parameters success:^(AFHTTPRequestOperation *operation, id responseObject) {        //请求成功Block        //将返回数据传入代理方法        [self.delegate getWeatherInfoSuccessFeedback:responseObject];    } failure:^(AFHTTPRequestOperation *operation, NSError *error) {        //请求失败Blick        //将错误信息传入代理方法        [self.delegate getWeatherInfoFailFeedback:error];    }];}复制代码OK, 如果你一路跟下来,恭喜你,你的方法类构建完成了。你的每一个接口都可以按照以上的方式,写成接口类的方法,然后用代理把它传递给其他类。那么其他类怎么接受通过代理传递过来的数据呢?打开ViewController,导入“Net.h”文件,在继承声明后添加实现代理,如下代码:复制代码//  ViewController.h//  NetInterface#import#import "Net.h"@interface ViewController : UIViewController@end

复制代码

为了使用方便我添加了一个Net类的成员变量,KYNet:

@property Net *KYNet;

接下来我们要在M文件中使用接口喽~~~代码如下:

复制代码

//

//  ViewController.m

//  NetInterface

#import "ViewController.h"

@interface ViewController ()

@end

@implementation ViewController

- (void)viewDidLoad {

[super viewDidLoad];

_KYNet=[Net getInstance];//得到单例

_KYNet.delegate=self; //将KYNet的代理与ViewController连接

}

//北京按钮

- (IBAction)beijingTouched:(id)sender {

[_KYNet getWeatherInfoWithCity:@"Beijing"];

}

//上海按钮

- (IBAction)shanghaiTouched:(id)sender {

[_KYNet getWeatherInfoWithCity:@"Shanghai"];

}

@end

复制代码

如上代码,当我们按下按钮,就会使用我们的接口类发送请求

慢着~怎么接收服务器反馈数据?!

对了,下面我们通过实现Net的代理方法来接受处理数据,并更新到UILabel上,在M文件实现,Delegate的两个方法:

复制代码

-(void)getWeatherInfoSuccessFeedback:(id)feedbackInfo{

//当服务器返回成功数据后,下列代码被激活

NSLog(@"%@",[feedbackInfo class]);

NSDictionary *dic=feedbackInfo;

NSArray *weather1=[dic objectForKey:@"weather"];

NSDictionary *main1=[dic objectForKey:@"main"];

NSDictionary *weather=[weather1 objectAtIndex:0];

NSString *temp=[NSString stringWithFormat:@"%@",[main1 objectForKey:@"temp"]];

NSString *weatherInfo=[NSString stringWithFormat:@"%@",[weather objectForKey:@"description"]];

_condition.text=weatherInfo;

_tem.text=temp;

}

-(void)getWeatherInfoFailFeedback:(id)failInfo{

NSLog(@"%@",failInfo);

}

复制代码

完活~

Hit Run~~~

总结

手指头敲酸了...写博客比写代码累多啦TT。Ok总结一下。

本文的核心思想是把所有的网路请求封装成一个类,向外部提供各个接口的请求方法,以便使用者发送请求;而当服务器返回反馈数据后,外部通过实现代理方法来获得数据。这样的架构的好处是非常灵活,低耦合,扩展简单。实现的代理方法会在服务器返回数据的是时候自动被调用,结合异步的AFNetworking,开发者不用去担心线程问题。这样一来,程序主线的逻辑设计也会变得很简单。用此构架封装好的类,可以轻松的打包成SDK给别人使用。

谢谢大家,希望你们有所收获,一篇文章花了我整整一天时间,如果对你有所帮助请帮忙点赞。如有问题,欢迎评论。若要转载,请注明出处。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 194,390评论 5 459
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 81,821评论 2 371
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 141,632评论 0 319
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 52,170评论 1 263
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 61,033评论 4 355
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 46,098评论 1 272
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,511评论 3 381
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,204评论 0 253
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,479评论 1 290
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,572评论 2 309
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,341评论 1 326
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,213评论 3 312
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 37,576评论 3 298
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 28,893评论 0 17
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,171评论 1 250
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 41,486评论 2 341
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 40,676评论 2 335

推荐阅读更多精彩内容