本文將從四個層面講解 iOS 開發中常用的 AFNetworking 框架:
一、什麼是 AFN
二、為什麼要使用 AFN
三、AFN 怎麼用
四、AFN 和 ASI 的區別
AFN 全名為 AFNetworking,是一個建構在 NSURLConnection、NSOperation 以及其他熟悉的 Foundation 技術之上的第三方網路框架。
AFN 對網路請求部分做了很好的封裝,架構良好、API 豐富,並採用模組化的建構方式,使用起來非常輕鬆。
AFN 主要用在兩個場景:一是發送網路請求,二是即時監測網路狀態。
AFHTTPRequestOperationManager:內部封裝的是 NSURLConnection,是網路請求管理類,負責發送網路請求,是使用最多的一個類。
AFHTTPSessionManager:內部封裝的是 NSURLSession,同樣是網路請求管理類,也是使用最多的類之一。
這兩個網路請求管理類定義的 API 完全相同:
[[AFHTTPRequestOperationManager manager] GET:nil parameters:nil success:^(AFHTTPRequestOperation *operation, id responseObject) { // } failure:^(AFHTTPRequestOperation *operation, NSError *error) { // }]; [[AFHTTPSessionManager manager] GET:nil parameters:nil success:^(NSURLSessionDataTask *task, id responseObject) { // } failure:^(NSURLSessionDataTask *task, NSError *error) { // }];
一些主要的工具類:
AFNetworkReachabilityManager.h:即時監測網路狀態改變的管理類。
AFSecurityPolicy.h:HTTPS 需要使用。
AFURLRequestSerialization:資料解析時會使用。
AFHTTPRequestSerializer:萬能解析器,對伺服器返回的資料不做任何處理。
AFJSONResponseSerializer:JSON 解析器。
AFXMLParserResponseSerializer:XML 解析器。
AFHTTPRequestOperationManager 對 NSURLConnection 的封裝;AFHTTPSessionManager 對 NSURLSession 的封裝。
1. 建立管理者
AFHTTPSessionManager *manager = [AFHTTPSessionManager manager];
2. 設定管理者的資料解析類型,預設為 JSON 格式的解析,可手動修改為其他類型,如 XML:
manager.responseSerializer = [AFXMLParserResponseSerializer serializer];
3. 發送網路請求
NSDictionary *dict = @{@"username":@"zhangsan",@"password":@"zhang"}; [[AFHTTPSessionManager manager] POST:@"https://localhost/login/login.php" parameters:dict progress:^(NSProgress * _Nonnull uploadProgress) { // } success:^(NSURLSessionDataTask * _Nonnull task, id _Nullable responseObject) { // NSLog(@"responseObject:%@",responseObject); } failure:^(NSURLSessionDataTask * _Nullable task, NSError * _Nonnull error) { // NSLog(@"error:%@",error); }]; [[AFHTTPSessionManager manager] GET:@"https://localhost/login/login.php" parameters:dict progress:^(NSProgress * _Nonnull downloadProgress) { NSLog(@"下載進度:%@",downloadProgress); } success:^(NSURLSessionDataTask * _Nonnull task, id _Nullable responseObject) { NSLog(@"responseObject:%@",responseObject); } failure:^(NSURLSessionDataTask * _Nullable task, NSError * _Nonnull error) { NSLog(@"error:%@",error); }];
3.1 首先要明確發送的是什麼類型的請求(GET/POST/HEAD……)
3.2 AFN 3.0 之後的網路介面相比之前多了一個參數:網路進度。
參數說明:
1. urlString:網路介面位址。
2. parameters:參數字典,key 為伺服器接收普通參數的 key 值,value 為參數內容。
3. progress:網路進度。
4. success:成功回調。
5. failure:失敗回調。
3.3 AFN 根據 response.MIMEType 來判斷伺服器返回資料的類型。如果類型不匹配,但實際上又是 JSON 資料,解決方案有兩種:
1. 把解析器類型改為萬能解析器 → 手動解析 JSON:
manager.responseSerializer = [AFHTTPResponseSerializer serializer];
2. 改變判斷條件的類型,使其匹配(acceptableContentTypes 預設情況下沒有 text/plain 類型):
manager.responseSerializer.acceptableContentTypes = [NSSet setWithObjects:@"application/json", @"text/json", @"text/javascript",@"text/plain",nil];
註:如果沒有使用第三方框架(CocoaPods)來管理第三方框架,可以直接修改第三方框架的原始碼;一般開發中,不要隨意修改第三方原始碼。
1. 建立管理者
AFHTTPRequestOperationManager *mgr = [AFHTTPRequestOperationManager manager];
2. 封裝請求參數
NSMutableDictionary *params = [NSMutableDictionary dictionary]; params[@"username"] = @"哈哈哈"; params[@"pwd"] = @"123";
3. 發送請求
NSString *url = @"https://localhost:8080/Server/login"; [mgr POST:url parameters:params success:^(AFHTTPRequestOperation *operation, id responseObject) { // 請求成功的時候調用這個block NSLog(@"請求成功---%@", responseObject); } failure:^(AFHTTPRequestOperation *operation, NSError *error) { // 請求失敗的時候調用調用這個block NSLog(@"請求失敗"); }]; // GET請求 [mgr GET:url parameters:params success:^(AFHTTPRequestOperation *operation, id responseObject) { // 請求成功的時候調用這個block NSLog(@"請求成功---%@", responseObject); } failure:^(AFHTTPRequestOperation *operation, NSError *error) { // 請求失敗的時候調用調用這個block NSLog(@"請求失敗"); }];
1. AFN 可以自動對伺服器返回的資料進行解析,預設將伺服器返回的資料當做 JSON 來解析。
2. 設定對伺服器返回資料的解析方式:
1> 當做 JSON 來解析(預設做法):mgr.responseSerializer = [AFJSONResponseSerializer serializer];,此時 responseObject 的類型是 NSDictionary 或 NSArray。
2> 當做 XML 來解析:mgr.responseSerializer = [AFXMLParserResponseSerializer serializer];,此時 responseObject 的類型是 NSXMLParser。
3> 直接返回 data:即告訴 AFN 不要解析資料、保持原樣即可,mgr.responseSerializer = [AFHTTPResponseSerializer serializer];。
3. 注意:伺服器返回的資料一定要跟 responseSerializer 對得上。JSON 資料可用 AFJSONResponseSerializer 或 AFHTTPResponseSerializer;XML 資料可用 AFXMLParserResponseSerializer 或 AFHTTPResponseSerializer;其他資料則用 AFHTTPResponseSerializer。
可利用 AFN 即時監測網路狀態。
AFNetworkReachabilityManager 實時檢測網絡狀態改變的類 AFNetworkReachabilityManager *manager = [AFNetworkReachabilityManager sharedManager]; // 設置網絡狀態改變之後的操作 [manager setReachabilityStatusChangeBlock:^(AFNetworkReachabilityStatus status) { // status :當前的網絡狀態. // AFNetworkReachabilityStatusUnknown // AFNetworkReachabilityStatusNotReachable // AFNetworkReachabilityStatusReachableViaWWAN // AFNetworkReachabilityStatusReachableViaWiFi switch (status) { case AFNetworkReachabilityStatusUnknown: NSLog(@"未知的網絡狀態"); break; case AFNetworkReachabilityStatusNotReachable: NSLog(@"沒有網絡"); break; case AFNetworkReachabilityStatusReachableViaWWAN: NSLog(@"蜂窩移動網絡"); break; case AFNetworkReachabilityStatusReachableViaWiFi: NSLog(@"WIFI網絡"); break; default: break; } }]; // 開始檢測網絡狀態 [manager startMonitoring];
HTTPS = HTTP(超文本傳輸協定)+ SSL(安全連接層),是 HTTP 的安全版本。
HTTPS 會專門建立一個安全的資料傳輸通道來傳輸資料,外界拿不到任何資料,是現階段最安全的協定。目前 HTTP 模式下三大電信商發送的惡意廣告泛濫,並可能取得使用者個人資訊,網路上有專門文章講解如何向主管機關投訴的內容。
HTTPS 需要數字驗證,目前很多大公司使用的數字驗證都是預設支援的。
[manager GET:@"https://mail.itcast.cn" parameters:nil progress:^(NSProgress * _Nonnull downloadProgress) { // } success:^(NSURLSessionDataTask * _Nonnull task, id _Nullable responseObject) { NSData *data = responseObject; // NSLog(@"成功:%@",[[NSString alloc] initWithData:data encoding:NSUTF8StringEncoding]); } failure:^(NSURLSessionDataTask * _Nullable task, NSError * _Nonnull error) { // NSLog(@"失敗:%@",error); }];
AFN 預設情況下支援 HTTPS 存取,但如果用 HTTPS 方式存取未受信任的網站就會報錯,解決方案是修改對 SSL 的檢測:
AFN 3.0 之前:
manager.securityPolicy.allowInvalidCertificates = YES;
AFN 3.0 之後:
manager.securityPolicy.validatesDomainName = NO;
一、底層實作
1> AFN 的底層基於 OC 的 NSURLConnection 和 NSURLSession;
2> ASI 的底層基於純 C 語言的 CFNetwork 框架;
3> ASI 的運行效能高於 AFN。
二、對伺服器返回資料的處理
1> ASI 沒有直接提供對伺服器資料處理的方式,直接返回 data/string;
2> AFN 提供了多種對伺服器資料處理的方式:JSON 處理、XML 處理、其他處理。
三、監聽請求的過程
1> AFN 提供了 success 和 failure 兩個 block 來監聽請求過程(只能監聽成功與失敗,3.0 以後加入了進度);
2> ASI 提供了三套方案,每一套都能監聽請求的完整過程(請求開始、接收到響應頭資訊、接收到具體資料、接收完畢、請求失敗):成為代理並遵守協定、成為代理不遵守協定自訂代理方法、設定 block。
四、檔案下載與上傳的使用難易度
1> AFN:不容易監聽下載與上傳進度、不容易實作斷點續傳,一般只用來下載不大的檔案。
2> ASI:非常容易實作下載與上傳、非常容易監聽進度、非常容易實作斷點續傳,下載大小檔案皆可。
五、ASI 提供了更多實用功能
1> 控制圈圈要不要在請求過程中轉;
2> 可以輕鬆設定請求之間的依賴:每個請求都是一個 NSOperation 物件;
3> 可以統一管理所有請求(還專門提供了一個 ASINetworkQueue 來管理所有請求物件):暫停/恢復/取消所有請求、監聽整個佇列中所有請求的下載與上傳進度。