一、AFN框架基本使用
- 1.1 AFN内部结构
AFN结构体
- NSURLConnection
+ AFURLConnectionOperation(已经被废弃)
+ AFHTTPRequestOperation(已经被废弃)
+ AFHTTPRequestOperationManager(封装了常用的 HTTP 方法)(已经被废弃)
* 属性
* baseURL :AFN建议开发者针对 AFHTTPRequestOperationManager 自定义个一个单例子类,
设置 baseURL, 所有的网络访问,都只使用相对路径即可
* requestSerializer :请求数据格式/默认是二进制的 HTTP
* responseSerializer :响应的数据格式/默认是 JSON 格式
* operationQueue
* reachabilityManager :网络连接管理器
* 方法
* manager :方便创建管理器的类方法
* HTTPRequestOperationWithRequest :在访问服务器时,如果要告诉服务器一些附加信息,
都需要在 Request 中设置
* GET
* POST
- NSURLSession
+ AFURLSessionManager
+ AFHTTPSessionManager(封装了常用的 HTTP 方法)
* GET
* POST
* UIKit + AFNetworking 分类
* NSProgress :利用KVO
- 半自动的序列化&反序列化的功能
+ AFURLRequestSerialization :请求的数据格式/默认是二进制的
+ AFURLResponseSerialization :响应的数据格式/默认是JSON格式
- 附加功能
+ 安全策略
* HTTPS
* AFSecurityPolicy
+ 网络检测
* 对苹果的网络连接检测做了一个封装
* AFNetworkReachabilityManager
建议:
可以学习下AFN对 UIKit 做了一些分类, 对自己能力提升是非常有帮助的
- 1.2 AFN的基本使用
(1)发送POST请求的方式
-(void)post
{
//1.创建会话管理者
//AFHTTPSessionManager内部是基于NSURLSession实现的
AFHTTPSessionManager *manager = [AFHTTPSessionManager manager];
//2.创建参数
NSDictionary *dict = @{
@"username":@"520it",
@"pwd":@"520it",
};
//3.发送POST请求
/*
http://120.25.226.186:32812/login?username=ee&pwd=ee&type=JSON
第一个参数:NSString类型的请求路径,AFN内部会自动将该路径包装为一个url并创建请求对象
第二个参数:请求参数,以字典的方式传递,AFN内部会判断当前是POST请求还是GET请求,
以选择直接拼接还是转换为NSData放到请求体中传递
第三个参数:进度回调 此处为nil
第四个参数:请求成功之后回调Block
第五个参数:请求失败回调Block
*/
[manager POST:@"http://120.25.226.186:32812/login"
parameters:dict
progress:nil
success:^(NSURLSessionDataTask * _Nonnull task,
id _Nullable responseObject) {
//注意:responseObject:请求成功返回的响应结果(AFN内部已经把响应体转换为OC对象,通常是字典或数组)
NSLog(@"请求成功---%@",responseObject);
} failure:^(NSURLSessionDataTask * _Nullable task,
NSError * _Nonnull error) {
NSLog(@"请求失败---%@",error);
}];
}
(2)使用AFN下载文件
-(void)download
{
//1.创建会话管理者
AFHTTPSessionManager *manager = [AFHTTPSessionManager manager];
//2.创建请求对象
NSURLRequest *request = [NSURLRequest requestWithURL:[NSURL URLWithString:@"http://120.25.226.186:32812/resources/images/minion_13.png"]];
//3.创建下载Task
/*
第一个参数:请求对象
第二个参数:进度回调
downloadProgress.completedUnitCount :已经下载的数据
downloadProgress.totalUnitCount:数据的总大小
第三个参数:destination回调,该block需要返回值(NSURL类型),告诉系统应该把文件剪切到什么地方
targetPath:文件的临时保存路径
response:响应头信息
第四个参数:completionHandler请求完成后回调
response:响应头信息
filePath:文件的保存路径,即destination回调的返回值
error:错误信息
*/
NSURLSessionDownloadTask *downloadTask = [manager downloadTaskWithRequest:request progress:^(NSProgress * _Nonnull downloadProgress) {
NSLog(@"%f",1.0 * downloadProgress.completedUnitCount / downloadProgress.totalUnitCount);
} destination:^NSURL * _Nonnull(NSURL * _Nonnull targetPath, NSURLResponse * _Nonnull response) {
NSString *fullPath = [[NSSearchPathForDirectoriesInDomains(NSCachesDirectory, NSUserDomainMask, YES) lastObject] stringByAppendingPathComponent:response.suggestedFilename];
NSLog(@"%@\n%@",targetPath,fullPath);
return [NSURL fileURLWithPath:fullPath];
} completionHandler:^(NSURLResponse * _Nonnull response, NSURL * _Nullable filePath, NSError * _Nullable error) {
NSLog(@"%@",filePath);
}];
//4.执行Task
[downloadTask resume];
}
二、AFN使用技巧
1.在开发的时候可以创建一个工具类,继承自我们的AFN中的请求管理者,再控制器中真正发请求的代码使用自己封装的工具类。
2.这样做的优点是以后如果修改了底层依赖的框架,那么我们修改这个工具类就可以了,而不用再一个一个的去修改。
3.该工具类一般提供一个单例方法,在该方法中会设置一个基本的请求路径。
4.该方法通常还会提供对GET或POST请求的封装。
5.在外面的时候通过该工具类来发送请求
6.单例方法:
+ (instancetype)shareNetworkTools
{
static NetworkTools *instance;
static dispatch_once_t onceToken;
dispatch_once(&onceToken, ^{
// 注意: BaseURL中一定要以/结尾
instance = [[self alloc] initWithBaseURL:[NSURL URLWithString:@"http://120.25.226.186:32812/"]];
});
return instance;
}
利用AFN取消请求
// 取消所有请求
for (NSURLSessionTask *task in self.manager.tasks) {
[task cancel];
}
// 取消所有请求
[self.manager.tasks makeObjectsPerformSelector:@selector(cancel)];
// 关闭NSURLSession + 取消所有请求
// NSURLSession一旦被关闭了, 就不能再发请求
[self.manager invalidateSessionCancelingTasks:YES];
注意: 一个请求任务被取消了(cancel), 会自动调用AFN请求的failure这个block,
block中传入error参数的code是NSURLErrorCancelled
三、AFN文件上传
1.文件上传拼接数据的第一种方式
[formData appendPartWithFileData:data
name:@"file"
fileName:@"xxoo.png"
mimeType:@"application/octet-stream"];
2.文件上传拼接数据的第二种方式
[formData appendPartWithFileURL:fileUrl
name:@"file"
fileName:@"xx.png"
mimeType:@"application/octet-stream"
error:nil];
3.文件上传拼接数据的第三种方式
[formData appendPartWithFileURL:fileUrl name:@"file" error:nil];
4.【注】在资料中已经提供了一个用于文件上传的分类。
/*文件上传相关的代码如下*/
-(void)upload1
{
//1.创建会话管理者
AFHTTPSessionManager *manager = [AFHTTPSessionManager manager];
//2.处理参数(非文件参数)
NSDictionary *dict = @{
@"username":@"123"
};
//3.发送请求上传文件
/*
第一个参数:请求路径(NSString类型)
第二个参数:非文件参数,以字典的方式传递
第三个参数:constructingBodyWithBlock 在该回调中拼接文件参数
第四个参数:progress 进度回调
uploadProgress.completedUnitCount:已经上传的数据大小
uploadProgress.totalUnitCount:数据的总大小
第五个参数:success 请求成功的回调
task:上传Task
responseObject:服务器返回的响应体信息(已经以JSON的方式转换为OC对象)
第六个参数:failure 请求失败的回调
task:上传Task
error:错误信息
*/
[manager POST:@"http://120.25.226.186:32812/upload"
parameters:dict
constructingBodyWithBlock:^(id<AFMultipartFormData> _Nonnull formData) {
UIImage *image = [UIImage imageNamed:@"Snip20160117_1"];
NSData *imageData = UIImagePNGRepresentation(image);
//在该block中拼接要上传的文件参数
/*
第一个参数:要上传的文件二进制数据
第二个参数:文件参数对应的参数名称,此处为file是该台服务器规定的(通常会在接口文档中提供)
第三个参数:该文件上传到服务后以什么名称保存
第四个参数:该文件的MIMeType类型
*/
[formData appendPartWithFileData:imageData
name:@"file"
fileName:@"123.png"
mimeType:@"image/png"];
} progress:^(NSProgress * _Nonnull uploadProgress) {
NSLog(@"%f",1.0 * uploadProgress.completedUnitCount / uploadProgress.totalUnitCount);
} success:^(NSURLSessionDataTask * _Nonnull task, id _Nullable responseObject) {
NSLog(@"请求成功----%@",responseObject);
} failure:^(NSURLSessionDataTask * _Nullable task, NSError * _Nonnull error) {
NSLog(@"请求失败----%@",error);
}];
}
-(void)upload2
{
//1.创建会话管理者
AFHTTPSessionManager *manager = [AFHTTPSessionManager manager];
//2.处理参数(非文件参数)
NSDictionary *dict = @{
@"username":@"123"
};
//3.发送请求上传文件
/*
第一个参数:请求路径(NSString类型)
第二个参数:非文件参数,以字典的方式传递
第三个参数:constructingBodyWithBlock 在该回调中拼接文件参数
第四个参数:progress 进度回调
uploadProgress.completedUnitCount:已经上传的数据大小
uploadProgress.totalUnitCount:数据的总大小
第五个参数:success 请求成功的回调
task:上传Task
responseObject:服务器返回的响应体信息(已经以JSON的方式转换为OC对象)
第六个参数:failure 请求失败的回调
task:上传Task
error:错误信息
*/
[manager POST:@"http://120.25.226.186:32812/upload"
parameters:dict
constructingBodyWithBlock:^(id<AFMultipartFormData> _Nonnull formData) {
NSURL *fileUrl = [NSURL fileURLWithPath:@"/Users/abc/Desktop/Snip20160117_1.png"];
//在该block中拼接要上传的文件参数
//第一种拼接方法
/*
第一个参数:要上传的文件的URL路径
第二个参数:文件参数对应的参数名称,此处为file是该台服务器规定的(通常会在接口文档中提供)
第三个参数:该文件上传到服务后以什么名称保存
第四个参数:该文件的MIMeType类型
第五个参数:错误信息,传地址
*/
[formData appendPartWithFileURL:fileUrl
name:@"file"
fileName:@"1234.png"
mimeType:@"image/png"
error:nil];
//第二种拼接方法:简写方法
/*
第一个参数:要上传的文件的URL路径
第二个参数:文件参数对应的参数名称,此处为file
第三个参数:错误信息
说明:AFN内部自动获得路径URL地址的最后一个节点作为文件的名称,内部调用C语言的API获得文件的类型
*/
[formData appendPartWithFileURL:fileUrl name:@"file" error:nil];
} progress:^(NSProgress * _Nonnull uploadProgress) {
NSLog(@"%f",1.0 * uploadProgress.completedUnitCount / uploadProgress.totalUnitCount);
} success:^(NSURLSessionDataTask * _Nonnull task, id _Nullable responseObject) {
NSLog(@"请求成功----%@",responseObject);
} failure:^(NSURLSessionDataTask * _Nullable task, NSError * _Nonnull error) {
NSLog(@"请求失败----%@",error);
}];
}
四、使用AFN进行序列化处理
/*
1.AFN它内部默认把服务器响应的数据当做json来进行解析,所以如果服务器返回给我的不是JSON数据那么请求报错,
这个时候需要设置AFN对响应信息的解析方式。AFN提供了三种解析响应信息的方式,分别是:
1)AFXMLParserResponseSerializer----XML
2) AFHTTPResponseSerializer---------默认二进制响应数据
3)AFJSONResponseSerializer---------JSON
2.还有一种情况就是服务器返回给我们的数据格式不太一致(开发者工具Content-Type:text/xml),
那么这种情况也有可能请求不成功。解决方法:
1) 直接在源代码中修改,添加相应的Content-Type
2) 拿到这个属性,添加到它的集合中
3.相关代码
-(void)srializer
{
//1.创建请求管理者,内部基于NSURLSession
AFHTTPSessionManager *manager = [AFHTTPSessionManager manager];
/* 知识点1:设置AFN采用什么样的方式来解析服务器返回的数据*/
//如果返回的是XML,那么告诉AFN,响应的时候使用XML的方式解析
manager.responseSerializer = [AFXMLParserResponseSerializer serializer];
//如果返回的就是二进制数据,那么采用默认二进制的方式来解析数据
//manager.responseSerializer = [AFHTTPResponseSerializer serializer];
//采用JSON的方式来解析数据
//manager.responseSerializer = [AFJSONResponseSerializer serializer];
/*知识点2 告诉AFN,再序列化服务器返回的数据的时候,支持此种类型
[AFJSONResponseSerializer serializer].acceptableContentTypes = [NSSet setWithObject:@"text/xml"];
//2.把所有的请求参数通过字典的方式来装载,GET方法内部会自动把所有的键值对取出以&符号拼接
并最后用?符号连接在请求路径后面
NSDictionary *dict = @{
@"username":@"223",
@"pwd":@"ewr",
@"type":@"XML"
};
//3.发送GET请求
[manager GET:@"http://120.25.226.186:32812/login"
parameters:dict
success:^(NSURLSessionDataTask * _Nonnull task,
id _Nonnull responseObject) {
//4.请求成功的回调block
NSLog(@"%@",[responseObject class]);
} failure:^(NSURLSessionDataTask * _Nonnull task,
NSError * _Nonnull error) {
//5.请求失败的回调,可以打印error的值查看错误信息
NSLog(@"%@",error);
}];
}
五、使用AFN来检测网络状态
/*
说明:可以使用AFN框架中的AFNetworkReachabilityManager来监听网络状态的改变,
也可以利用苹果提供的Reachability来监听。建议在开发中直接使用AFN框架处理。
*/
//使用AFN框架来检测网络状态的改变
-(void)AFNReachability
{
//1.创建网络监听管理者
AFNetworkReachabilityManager *manager = [AFNetworkReachabilityManager sharedManager];
//2.监听网络状态的改变
/*
AFNetworkReachabilityStatusUnknown = 未知
AFNetworkReachabilityStatusNotReachable = 没有网络
AFNetworkReachabilityStatusReachableViaWWAN = 3G
AFNetworkReachabilityStatusReachableViaWiFi = WIFI
*/
[manager setReachabilityStatusChangeBlock:^(AFNetworkReachabilityStatus status) {
switch (status) {
case AFNetworkReachabilityStatusUnknown:
NSLog(@"未知");
break;
case AFNetworkReachabilityStatusNotReachable:
NSLog(@"没有网络");
break;
case AFNetworkReachabilityStatusReachableViaWWAN:
NSLog(@"3G");
break;
case AFNetworkReachabilityStatusReachableViaWiFi:
NSLog(@"WIFI");
break;
default:
break;
}
}];
//3.开始监听
[manager startMonitoring];
}
------------------------------------------------------------
//使用苹果提供的Reachability来检测网络状态,如果要持续监听网络状态的概念,需要结合通知一起使用。
//提供下载地址:https://developer.apple.com/library/ios/samplecode/Reachability/Reachability.zip
-(void)touchesBegan:(NSSet<UITouch *> *)touches withEvent:(UIEvent *)event
{
//1.注册一个通知
[[NSNotificationCenter defaultCenter] addObserver:self
selector:@selector(networkChange)
name:kReachabilityChangedNotification
object:nil];
//2.拿到一个对象,然后调用开始监听方法
Reachability *r = [Reachability reachabilityForInternetConnection];
[r startNotifier];
//持有该对象,不要让该对象释放掉
self.r = r;
}
//当控制器释放的时候,移除通知的监听
-(void)dealloc
{
[[NSNotificationCenter defaultCenter] removeObserver:self];
}
-(void)networkChange
{
//获取当前网络的状态
if ([Reachability reachabilityForInternetConnection].currentReachabilityStatus == ReachableViaWWAN)
{
NSLog(@"当前网络状态为3G");
return;
}
if ([Reachability reachabilityForLocalWiFi].currentReachabilityStatus == ReachableViaWiFi)
{
NSLog(@"当前网络状态为wifi");
return;
}
NSLog(@"当前没有网络");
}
六、NSURLSessionConfiguration
NSURLSessionConfiguration对象用于初始化NSURLSession对象。
展开请求级别中与NSMutableURLRequest相关的可供选择的方案,我们可以看到NSURLSessionConfiguration对于会话如何产生请求,
提供了相当多的控制和灵活性。从网络访问性能,到cookie,安全性,缓存策略,自定义协议,启动事件设置,
以及用于移动设备优化的几个新属性,你会发现你一直在寻找的,正是NSURLSessionConfiguration。
会话在初始化时复制它们的配置,NSURLSession有一个只读的配置属性,使得该配置对象上的变化对这个会话的政策无效。
配置在初始化时被读取一次,之后都是不会变化的。
1.构造方法:
NSURLSessionConfiguration有三个类构造函数,这很好地说明了NSURLSession是为不同的用例而设计的。
+ "defaultSessionConfiguration"返回标准配置,这实际上与NSURLConnection的网络协议栈是一样的,
具有相同的共享NSHTTPCookieStorage,共享NSURLCache和共享NSURLCredentialStorage。
+ "ephemeralSessionConfiguration"返回一个预设配置,没有持久性存储的缓存,Cookie或证书。
这对于实现像"秘密浏览"功能的功能来说,是很理想的。
+ "backgroundSessionConfiguration":独特之处在于,它会创建一个后台会话。后台会话不同于常规的,
普通的会话,它甚至可以在应用程序挂起,退出,崩溃的情况下运行上传和下载任务。
初始化时指定的标识符,被用于向任何可能在进程外恢复后台传输的守护进程提供上下文。
想要查看更多关于后台会话的信息,可以查看WWDC Session 204: “What’s New with Multitasking”
2.NSURLSessionConfiguration的属性:
NSURLSessionConfiguration拥有20个属性。熟练掌握这些属性的用处,将使应用程序充分利用其网络环境。
最重要的属性:
# 替代 request 中的 forHTTPHeaderField 告诉服务器有关客户端的附加信息
"HTTPAdditionalHeaders"
指定了一组默认的可以设置出站请求的数据头。
这对于跨会话共享信息,如内容类型,语言,用户代理,身份认证,是很有用的。
# WebDav的身份验证
NSString *userPasswordString = [NSString stringWithFormat:@"%@:%@", user, password];
NSData * userPasswordData = [userPasswordString dataUsingEncoding:NSUTF8StringEncoding];
NSString *base64EncodedCredential = [userPasswordData base64EncodedStringWithOptions:0];
NSString *authString = [NSString stringWithFormat:@"Basic: %@", base64EncodedCredential];
# 设置客户端类型
NSString *userAgentString = @"iPhone AppleWebKit";
configuration.HTTPAdditionalHeaders = @{@"Accept": @"application/json",
@"Accept-Language": @"en",
@"Authorization": authString,
@"User-Agent": userAgentString};
"networkServiceType(网络服务类型)"
对标准的网络流量,网络电话,语音,视频,以及由一个后台进程使用的流量进行了区分。
大多数应用程序都不需要设置这个
"allowsCellularAccess(允许蜂窝访问)"和"discretionary(自行决定)"
被用于节省通过蜂窝连接的带宽。建议在使用后台传输的时候,使用discretionary属性,
而不是allowsCellularAccess属性,因为它会把WiFi和电源可用性考虑在内
"timeoutIntervalForRequest"和"timeoutIntervalForResource"
指定了请求以及该资源的超时时间间隔。
许多开发人员试图使用timeoutInterval去限制发送请求的总时间,但这误会了timeoutInterval的意思:报文之间的时间。
timeoutIntervalForResource实际上提供了整体超时的特性,这应该只用于后台传输,而不是用户实际上可能想要等待的任何东西
"HTTPMaximumConnectionsPerHost"
是 Foundation 框架中URL加载系统的一个新的配置选项。它曾经被用于NSURLConnection管理私人连接池。
现在有了NSURLSession,开发者可以在需要时限制连接到特定主机的数量
"HTTPShouldUsePipelining"也出现在NSMutableURLRequest,
它可以被用于开启HTTP管道,这可以显着降低请求的加载时间,但是由于没有被服务器广泛支持,默认是禁用的
"sessionSendsLaunchEvents"
是另一个新的属性,该属性指定该会话是否应该从后台启动
"connectionProxyDictionary"
指定了会话连接中的代理服务器。
同样地,大多数面向消费者的应用程序都不需要代理,所以基本上不需要配置这个属性
关于连接代理的更多信息可以在 CFProxySupport Reference 找到。
"Cookie Policies"
-"HTTPCookieStorage" 是被会话使用的cookie存储。
默认情况下,NSHTTPCookieShorage的 + sharedHTTPCookieStorage会被使用,这与NSURLConnection是相同的
-"HTTPCookieAcceptPolicy" 决定了该会话应该接受从服务器发出的cookie的条件
-"HTTPShouldSetCookies" 指定了请求是否应该使用会话HTTPCookieStorage的cookie
"Security Policies"URLCredentialStorage
是会话使用的证书存储。
默认情况下,NSURLCredentialStorage 的+ sharedCredentialStorage 会被使用使用,这与NSURLConnection是相同的
"TLSMaximumSupportedProtocol" 和 "TLSMinimumSupportedProtocol"
确定是否支持SSLProtocol版本的会话
"Caching Policies"
URLCache 是会话使用的缓存。
默认情况下,NSURLCache 的 + sharedURLCache 会被使用,这与NSURLConnection是相同的
requestCachePolicy 指定了一个请求的缓存响应应该在什么时候返回。这相当于NSURLRequest 的-cachePolicy方法
"Custom Protocols"
protocolClasses是注册NSURLProtocol类的特定会话数组