用AFNetworking3.0封装网络请求

525 阅读7分钟
原文链接: www.jianshu.com

前言

由于之前一直是用别人封装好的网络请求,一来版本太旧,二来觉得太臃肿很多功能代码不知道是干嘛的,所以想尝试自己封装一个网络请求,可能比较简单比较入门,很多问题肯定考虑不周,而且网上关于AFNetworking3.0库的教程也不多,所以大家当成3.0的小教程就好。

配置AFNetworking环境

AFNetworking更新了3.0,之前的工程一直用的2.63。这两个版本变化还是比较大的,以前的AFNetworking是NSURLConnection + NSOperation,但是3.0版本移除了对NSURLConnectionOperation的支持,这意味着之前版本的“主力军”被移除了,所以若是原封不动的用之前工程网络请求部分的代码一般都会报错,所以大家都要尝试用新版的AFNetworking来更新自己的网络请求了。取消了NSURLConnectionOperation,AFNetworking是用iOS7中新的网络接口NSURLSessionOperation来代替的。NSURLSessionOperation在程序进入后台后会比NSURLConnectionOperation更加灵活,更先进。

为了使用AFNetworking3.0,还有一个比较坑爹的是你必须使用Xcode7以上的版本。因为AFNetworking3.0 使用了nullable新特性,而低版本的Xcode并不识别,所以用低版本的Xcode运行3.0会报错。更坑爹的是要用Xcode7还要更新你OS X到EI Capitan版本,光更新这两个我就花了一天的时间(其实笔者下载了两次Xcode7才发现要先更新操作系统才行)。更新操作系统踩坑点这里

有了Xcode7,就可以用cococapods下载配置最新的AFNetworking了。

platform :ios, '8.0'
pod 'AFNetworking', '~> 3.0'

坑爹的事还有,在iOS 9中 苹果将原http协议改成了https协议 使用 TLS1.2 SSL加密请求数据,所以我们不能直接请求http协议下的数据了。

解决办法也很简单,用编辑器打开工程文件下的Info.plist文件添加下面的代码就可以了

<key>NSAppTransportSecurity</key>  
    <dict>  
      <key>NSAllowsArbitraryLoads</key><true/>  
    </dict>  

stackoverflow的回答点这里

这样一来我们就配置好环境了。

使用AFNetworking

很多人对AFNetworking都不陌生,这一段可能有点老生常谈的感觉。

用AFNetworking第一步都是一样的,即创建一个manager。关于self-manager的扩展可以看这篇文章学习一下。

在AFNetworking中创建manager的方法是这样的

AFHTTPSessionManager *manager = [AFHTTPSessionManager manager];

在AppDelegate中你需要开启你的网络监听器,这样AFStringFromNetworkReachabilityStatus属性就有了值显示你的网络状态。

[[AFNetworkReachabilityManager sharedManager] startMonitoring];

如果你需要上传或者下载数据,那么还需要创建一个NSURLSessionConfiguration类,本文只讲述普通的请求数据,所以先不涉及NSURLSessionConfiguration。

请求数据大部分情况下就是像服务器发送GET或者POST请求,然后服务器会返回你一串JSON格式的数据,你需要解析这段JSON数据然后呈现在你的UI上。

GET - 从指定的资源请求数据。

POST - 向指定的资源提交要被处理的数据

AFNetworking请求数据的代码也很简单。

[manager GET:@"http://httpbin.org/get" parameters:nil progress:nil success:^(NSURLSessionTask *task, id responseObject) {
    NSLog(@"JSON: %@", responseObject);
} failure:^(NSURLSessionTask *operation, NSError *error) {
    NSLog(@"Error: %@", error);
}];

这段代码非常易懂,这也是AFNetworking的强大之处。parameters:后面跟着的是你需要给后台传送的参数。而id responseObject是后台返给你的数据。我输出了一下[responseObject class]发现responseObject是一个NSDictionary,那么以后在字典中用的方法也适用于responseObject,后面的代码中我也做了修改。

这样我们就成功请求到了数据。接下来要做的就是封装了。

网络请求的封装

记得学习软件工程的时候我们老师给我们反复强调了代码复用的重要性,我当时也深受启发。而网络请求在我们的应用开发中我觉得是最常用的需要代码复用的部分,因为他使用次数多,且代码都差不多,不受别的模块代码干扰,即低耦合,高内聚。

上文提到了我们进行网络请求要先创建一个manager,就是说每次请求我们都需要创建manager。那么我们先对这一步进行封装。

先创建一个新的继承于AFHTTPSessionManager的类,我这里就叫cbsNetWork了。在我的封装中,一开始我是先创建一个类方法。

+ (instancetype)sharedManager {
static cbsNetWork *manager = nil;
static dispatch_once_t pred;
dispatch_once(&pred, ^{
    manager = [[self alloc] initWithBaseURL:[NSURL URLWithString:@"http://httpbin.org/"]];
});
return manager;
}

这是每次执行网络请求库的时候都要执行的方法。在这个方法中,其实就是初始化了一个manager,但与一般的创建不同,这里用到了dispatch_once也就是iOS ARC中创建单例模式的方法。为何这里要用到单例模式?因为这个manager应该是系统中唯一的实例。而dispatch_once中的方法不管多少次调用都只会运行一次。更多的关于单例模式点这个网站吧。

接下来就是重写父类的初始化方法initWithBaseURL。在父类(也就是AFNetworking)中initWithBaseURL只是拼接了基URL和后来的路径,并且规定了默认的请求序列和响应序列。而在我们的实际工程中肯定需要更多的属性设置,例如延时要求,缓存要求等。这里的属性设置具体原因不用细究,只要知道这个方法的作用就好。

-(instancetype)initWithBaseURL:(NSURL *)url
{
self = [super initWithBaseURL:url];
if (self) {
    // 请求超时设定
    self.requestSerializer.timeoutInterval = 5;
    self.requestSerializer.cachePolicy = NSURLRequestReloadIgnoringLocalCacheData;
    [self.requestSerializer setValue:@"application/json" forHTTPHeaderField:@"Accept"];
    [self.requestSerializer setValue:url.absoluteString forHTTPHeaderField:@"Referer"];
    
    self.responseSerializer.acceptableContentTypes = [NSSet setWithObjects:@"application/json", @"text/plain", @"text/javascript", @"text/json", @"text/html", nil];
    
    self.securityPolicy.allowInvalidCertificates = YES;
}
return self;
}

然后就是封装AFNetworking的部分了。这里我只是封装了一个请求数据的方法,比较简单,当然不能下载和上传,以后我会完善。

首先我们要在文件头定义两个block,在请求中我们需要用block回调数据来使用,因为AFNetworking请求数据方法中success块是没有返回值的,所以我们需要自己声明块来回调请求到的json数据再进行解析。

块定义如下

//请求成功回调block
typedef void (^requestSuccessBlock)(NSDictionary *dic);

//请求失败回调block
typedef void (^requestFailureBlock)(NSError *error);

为了分辨方法,我也定了也一个HTTP方法类来封装方法。

//请求方法define
typedef enum {
GET,
POST,
PUT,
DELETE,
HEAD
} HTTPMethod;

接下来就是方法封装了

- (void)requestWithMethod:(HTTPMethod)method
             WithPath:(NSString *)path
           WithParams:(NSDictionary*)params
     WithSuccessBlock:(requestSuccessBlock)success
      WithFailurBlock:(requestFailureBlock)failure
{
switch (method) {
    case GET:{
         [self GET:path parameters:params progress:nil success:^(NSURLSessionTask *task, NSDictionary * responseObject) {
               NSLog(@"JSON: %@", responseObject);
               success(responseObject);
         } failure:^(NSURLSessionTask *operation, NSError *error) {
               NSLog(@"Error: %@", error);
               failure(error);
            }];
            break;
       }
    case POST:{
         [self POST:path parameters:params progress:nil success:^(NSURLSessionTask *task, NSDictionary * responseObject) {
              NSLog(@"JSON: %@", responseObject);
               success(responseObject);
            } failure:^(NSURLSessionTask *operation, NSError *error) {
                NSLog(@"Error: %@", error);
                UIAlertView *alert = [[UIAlertView alloc] initWithTitle:@"提示" message:error.localizedDescription delegate:nil cancelButtonTitle:@"确定" otherButtonTitles:nil, nil];
               [alert show];
                failure(error);
            }];
            break;
        }
    default:
        break;
    }    
}

我只是简单的封装了GET和POST两个方法,成功会讲请求到的json数据存储到一个字典responseObject中,然后通过回调方法在页面中使用,失败的话则回调了NSError *error

在ViewController中,我们即可用一个方法完成网络请求。

[[cbsNetWork sharedManager] requestWithMethod:GET WithPath:@"get" WithParams:nil WithSuccessBlock:^(NSDictionary *dic) {
    Model *model = [MTLJSONAdapter modelOfClass:[Model class] fromJSONDictionary:dic error:nil];
    NSLog(@"%@", model.origin);
} WithFailurBlock:^(NSError *error) {
    
}];

PS:我的model是用Mantle解析的,所以想复制代码的同学自己用自己的办法写model吧,这不是重点。

这样简单的网络请求就封装好了,当然还可以更加完善可以再加一层专门写model解析数据这样你的ViewController代码会更简洁。

这篇文章写的代码我会传到我的github上,有需要的可以点开来下载看。

学艺不精,有错误的地方还请指出,我将万分感谢。也欢迎来我的博客看看。