一. AFNetworking简单介绍
通过前面学习的HTTP协议的基本知识,GET/POST请求的区别,NSURLConnection 和 NSURLSession的使用,已经基本了解了网络请求的方法,但是相对使用比较麻烦,AFNetworking是对NSURLConnection 和 NSURLSession的封装,使网络请求更加简单轻松,是一款非常有用的第三方框架。AFNetworking3.0以后移除了对NSURLConnection的支持。
看一下AFNetworking 历史版本 以及框架
这些在GitHub上都可以看到,可以去GitHub上查看。
二. AFNetworking使用
1. GET请求
AFHTTPSessionManager *manager =[AFHTTPSessionManager manager];
NSDictionary *dict = @{
@"username":@"520it",
@"pwd":@"520it"
};
// parameters 参数字典
[manager GET:@"http://120.25.226.186:32812/login" parameters:dict progress:^(NSProgress * _Nonnull downloadProgress) {
//进度
//进度
} success:^(NSURLSessionDataTask * _Nonnull task, id _Nullable responseObject) {
// task 我们可以通过task拿到响应头
// responseObject:请求成功返回的响应结果(AFN内部已经把响应体转换为OC对象,通常是字典或数组)
} failure:^(NSURLSessionDataTask * _Nullable task, NSError * _Nonnull error) {
// error 错误信息
}];
2. POST请求
AFHTTPSessionManager *manager =[AFHTTPSessionManager manager];
NSDictionary *dict = @{
@"username":@"520it",
@"pwd":@"520it"
};
[manager POST:@"http://120.25.226.186:32812/login" parameters:dict progress:^(NSProgress * _Nonnull downloadProgress) {
// 进度
} success:^(NSURLSessionDataTask * _Nonnull task, id _Nullable responseObject) {
// 请求成功
} failure:^(NSURLSessionDataTask * _Nullable task, NSError * _Nonnull error) {
// 请求失败
}];
注意:我们发现GET和POST请求一模一样,仅仅换了一个名字,GET请求也可以将参数放在字典中,也可以将参数拼接在url之后parameters传nil。另外不需要开启Task,因为AFN内部已经帮我们开启了
另外:AFN默认会把服务器返回给我们的数据当做是JSNO数据,并且AFN内部已经把响应体JSON数据转换为OC对象,通常是字典或数组。
那么如果服务器返回的XML呢?这时我们需要自己设置AFN解析方式
manager.responseSerializer = [AFXMLParserResponseSerializer serializer];
返回的是NSXMLParser,需要我们自己解析
如果返回的数据既不是JSON也不是XML那么需要设置
manager.responseSerializer = [AFHTTPResponseSerializer serializer];
AFN默认接收的ContentTypes 有以下三种
如果服务器返回的ContentType不是这三种中的一种,我们就需要设置
manager.responseSerializer.acceptableContentTypes = [NSSet setWithObject:@"text/html"];
也可以直接在AFN源码中添加(不建议使用,这种方式比较隐蔽,当更新过AFN之后这里会还原,出现问题比较难找)
3. 文件下载
// 1.创建一个管理者
AFHTTPSessionManager *manager = [AFHTTPSessionManager manager];
// 2. 创建请求对象
NSURL *url = [NSURL URLWithString:@"http://120.25.226.186:32812/resources/images/minion_03.png"];
NSURLRequest *request =[NSURLRequest requestWithURL:url];
// 3. 下载文件
NSURLSessionDownloadTask *downloadTask = [manager downloadTaskWithRequest:request progress:^(NSProgress * _Nonnull downloadProgress) {
// downloadProgress.completedUnitCount 当前下载大小
// downloadProgress.totalUnitCount 总大小
NSLog(@"%f", 1.0 * downloadProgress.completedUnitCount / downloadProgress.totalUnitCount);
} destination:^NSURL * _Nonnull(NSURL * _Nonnull targetPath, NSURLResponse * _Nonnull response) {
// targetPath 临时存储地址
NSLog(@"targetPath:%@",targetPath);
NSString *path =[NSSearchPathForDirectoriesInDomains(NSCachesDirectory, NSUserDomainMask, YES) lastObject];
NSString *filePath = [path stringByAppendingPathComponent:response.suggestedFilename];
NSURL *url = [NSURL fileURLWithPath:filePath];
NSLog(@"path:%@",filePath);
// 返回url 我们想要存储的地址
// response 响应头
return url;
} completionHandler:^(NSURLResponse * _Nonnull response, NSURL * _Nullable filePath, NSError * _Nullable error) {
// 下载完成之后调用
// response 响应头
// filePath 下载存储地址
NSLog(@"filePath:%@",filePath);
}];
// 需要手动开启
[downloadTask resume];
注意:
1. 下载文件需要获取NSURLSessionDownloadTask对象手动开启
2. 第一个block块:downloadProgress 有两个属性completedUnitCount(已经下载文件大小)、totalUnitCount(文件总大小)。
3. 第二个block块:需要返回一个url,表示想要将文件存储的地方。targetPath:表示临时存储地址在tmp临时文件中。response:响应头 可以拿到一些文件信息
4. 第三个block块:下载完成之后调用。response:响应头。filePath:文件存储地址,与第二个block块中返回的url是一个地址
4. 文件上传
关于文件上传使用AFN就简单多了,也不需要我们去拼接请求体和请求文件参数啦,AFN内部已经帮我们拼接好了
方法一:formData 添加data形式数据
AFHTTPSessionManager *manager = [AFHTTPSessionManager manager];
NSString *url =@"http://120.25.226.186:32812/upload";
[manager POST:url parameters:nil constructingBodyWithBlock:^(id<AFMultipartFormData> _Nonnull formData) {
// formData 将要上传的数据
UIImage *image =[UIImage imageNamed:@"123"];
NSData *data =UIImagePNGRepresentation(image);
// 方法一
/**
data:上传文件二进制数据
name:接口的名字
fileName:文件上传到服务器之后叫什么名字
mineType:上传文件的类型,可以上传任意二进制mineType.
*/
[formData appendPartWithFileData:data name:@"file" fileName:@"123.png" mimeType:@"image/png"];
// 方法二
/**
data:上传文件二进制数据
name:接口的名字
这种方法内部会将文件名当做上传到服务器之后的名字,并自动获取其类型
*/
[formData appendPartWithFormData:data name:@"file"];
} progress:^(NSProgress * _Nonnull uploadProgress) {
// 上传进度
} success:^(NSURLSessionDataTask * _Nonnull task, id _Nullable responseObject) {
// 上传成功
NSLog(@"上传成功");
} failure:^(NSURLSessionDataTask * _Nullable task, NSError * _Nonnull error) {
// 上传失败
NSLog(@"上传失败");
}];
方法二:formData直接添加url
AFHTTPSessionManager *manager = [AFHTTPSessionManager manager];
NSString *url =@"http://120.25.226.186:32812/upload";
[manager POST:url parameters:nil constructingBodyWithBlock:^(id<AFMultipartFormData> _Nonnull formData) {
// formData 将要上传的数据
// 直接传URL
NSURL *url =[NSURL fileURLWithPath:@"/Users/yangboxing/Desktop/Snip20160905_7.png"];
// 方法一
[formData appendPartWithFileURL:url name:@"file" fileName:@"hhaha.png" mimeType:@"image/png" error:nil];
// 方法二
/**
这个方法会自动截取url最后一块的文件名作为上传到服务器的文件名
也会自动获取mimeType,如果没有办法获取mimeType 就使用@"application/octet-stream" 表示任意的二进制数据 ,当我们不在意文件类型的时候 也可以用这个。
*/
[formData appendPartWithFileURL:url name:@"file" error:nil];
} progress:^(NSProgress * _Nonnull uploadProgress) {
// 上传进度
} success:^(NSURLSessionDataTask * _Nonnull task, id _Nullable responseObject) {
// 上传成功
NSLog(@"上传成功");
} failure:^(NSURLSessionDataTask * _Nullable task, NSError * _Nonnull error) {
// 上传失败
NSLog(@"上传失败");
}];
注意:
mimeType表示文件的类型,关于mimeType类型可以自行百度,我们也可以通过发送请求获取mineType
// 通过发送请求获取mimeType
-(NSString *)connectSync:(NSString *)path
{
//1.确定请求路径
NSURL *url = [NSURL fileURLWithPath:path];
//2.创建可变的请求对象
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:url];
NSHTTPURLResponse *res = nil;
[NSURLConnection sendSynchronousRequest:request returningResponse:&res error:nil];
NSLog(@"%@",res.MIMEType);
return res.MIMEType;
}
我们通过[formData appendPartWithFileURL:url name:@"file" error:nil];
来看看AFN是如何获取mimeType的
进入方法内部
因此以后我们要获取mimeType的时候也可以直接从AFN中复制拿去用喽。
5. AFN网络状态的检测
使用AFN进行网络状态的检测非常简单,并且可以持续监听网络状态,每当网络状态发生改变的时候,都会调用setReachabilityStatusChangeBlock方法
AFNetworkReachabilityManager *manager = [AFNetworkReachabilityManager sharedManager];
/*
AFNetworkReachabilityStatusUnknown = -1, 未知
AFNetworkReachabilityStatusNotReachable = 0, 没有网络
AFNetworkReachabilityStatusReachableViaWWAN = 1, 蜂窝流量
AFNetworkReachabilityStatusReachableViaWiFi = 2, 无线
*/
// 监听网络状态的变化
[manager setReachabilityStatusChangeBlock:^(AFNetworkReachabilityStatus status) {
switch (status) {
case AFNetworkReachabilityStatusUnknown:
NSLog(@"未知");
break;
case AFNetworkReachabilityStatusNotReachable:
NSLog(@"没有网络");
break;
case AFNetworkReachabilityStatusReachableViaWWAN:
NSLog(@"3G");
break;
case AFNetworkReachabilityStatusReachableViaWiFi:
NSLog(@"无线");
break;
default:
break;
}
}];
// 开启
[manager startMonitoring];
6. AFN向HTTPS发送请求。
我们知道HTTPS在HTTP的基础上加入了SSL协议,SSL依靠证书来验证服务器的身份,并为浏览器和服务器之间的通信加密。
当使用NSURLSession来向HTTPS发送请求时,需要在NSURLSessionDataDelegate
的代理方法didReceiveChallenge
中,信任服务器并且创建证书返回服务器。
而AFN对此进行了很好的封装,内部已经帮我们做好这些,因此向HTTPS发送请求方法与向HTTP发送请求是一样的。
我们来看AFN内部封装的方法
那么当我们用NSURLSession向HTTPS发送请求的时候,直接复制过来稍作修改就可以用啦
-(void)URLSession:(NSURLSession *)session didReceiveChallenge:(NSURLAuthenticationChallenge *)challenge completionHandler:(void (^)(NSURLSessionAuthChallengeDisposition, NSURLCredential * _Nullable))completionHandler
{
NSLog(@"--didReceiveChallenge--%@",challenge.protectionSpace);
/*
NSURLSessionAuthChallengeUseCredential = 0, 使用
NSURLSessionAuthChallengePerformDefaultHandling = 1, 忽略(默认)
NSURLSessionAuthChallengeCancelAuthenticationChallenge = 2,忽略(会取消请求)
NSURLSessionAuthChallengeRejectProtectionSpace = 3, 忽略(下次继续询问)
*/
// NSURLAuthenticationMethodServerTrust 服务器信任
if ([challenge.protectionSpace.authenticationMethod isEqualToString:NSURLAuthenticationMethodServerTrust]) {
//创建证书
NSURLCredential *credentoal = [[NSURLCredential alloc]initWithTrust:challenge.protectionSpace.serverTrust];
completionHandler(NSURLSessionAuthChallengeUseCredential,credentoal);
}
}
三. 总结
我们一般在使用AFN的时候会将他封装到一个工具类中,使工具类成为一个中间层,这样便于我们使用和对代码的管理,以后当AFN更新或者我们要换网络请求第三方类库的时候,直接更改工具类就可以了,其他类中的的网络请求方法都不用改变,这使我们以后维护代码更加简单快捷方便。
关于网络请求的基础知识请参考iOS-网络编程(一)HTTP协议、iOS-网络编程(二)文件上传和断点离线下载。
✨本文借鉴了很多前辈的文章,如果有不对的地方请指正,欢迎大家一起交流学习 xx_cc 。