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 <Foundation/Foundation.h>
#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 <Foundation/Foundation.h>
#import "AFNetworking.h"
//代理
@protocol NetDelegate <NSObject>
/**
 *  代理回调方法
 *
 *  @param feedbackInfo 服务器返回的数据
 */
-(void)getWeatherInfoSuccessFeedback:(id)feedbackInfo;
-(void)getWeatherInfoFailFeedback:(id)failInfo;

@end

@interface Net : NSObject

@property (nonatomic,strong) id<NetDelegate> delegate;

/**
 *  获取Net类的单例
 *
 *  @return Net类的单例 实例（对象）
 */
+(Net *)getInstance;


/**
 *  获得某城市的天气
 *
 *  @param cityName 城市名称
 */
-(void)getWeatherInfoWithCity:(NSString *)cityName;

@end

如上代码，这是Net类的完整地H文件，我们在代理部分，声明了两个方法，一个请求成功、一个请求失败。在代理中申明的代理方法，我们不用去实现它，而是在M文件总直接使用它。如果自己要使用的代理我们需要将代理声明为自己的成员变量:

@property (nonatomic,strong) id<NetDelegate> delegate;

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”文件，在继承声明后添加实现<NetDelegate>代理，如下代码：

//  ViewController.h
//  NetInterface
#import <UIKit/UIKit.h>
#import "Net.h"
@interface ViewController : UIViewController <NetDelegate>

@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给别人使用。

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