AFNetworking說明書

圖片來之網(wǎng)絡

AFNetworking是為iOS和Mac OS X系統(tǒng)提供的一個簡單方便的網(wǎng)絡庫扮叨。它是建立在基礎URL加載系統(tǒng)沉桌,擴展為非常高級的網(wǎng)絡抽象,成為Cocoa的組成部分浴滴。它有一個設計完美的模塊化架構(gòu)拓萌,有個很多方便使用并功能多樣的接口。也許最重要的特色升略,無論如何微王,應該是為每天使用AFNetworking或給AFNetworking提供幫助的開發(fā)者提供令人驚喜的社區(qū)屡限。AFNetworking在iPhone,iPad和Mac上被一些最受歡迎和受人好評的應用使用炕倘。
在你的下一個項目或移植你的當前項目選擇使用AFNetworking钧大,你將會非常高興你現(xiàn)在的選擇。

怎么開始

交流

  • 如果你需要幫助啊央,使用Stack Overflow。(標簽‘a(chǎn)fnetworking’)
  • 如果你想問問題涨醋,使用Stack Overflow瓜饥。
  • 如果你發(fā)現(xiàn)bug并且能夠提供重現(xiàn)的步驟,請新開一個issue浴骂。
  • 如果你有一個新特性請求乓土,請新開一個issue。
  • 如果你想為AFNetworking添磚加瓦溯警,請?zhí)峤灰粋€pull請求趣苏。

安裝

在工程中使用AFNetworking庫,AFNetworking提供了多種安裝方法梯轻。

PODFILE

使用CocoaPods繼承AFNetworking到你的Xcode工程中拦键,在你的Podfile中添加以下內(nèi)容:

source 'https://github.com/CocoaPods/Specs.git'
platform :ios, '8.0'
 
pod 'AFNetworking', '~> 3.0'

然后,執(zhí)行以下命令:
pod install

要求

AFNetworking版本 iOS最低版本 OS X最低版本 watchOS最低版本 tvOS最低版本 注意
3.x iOS 7 OSX 10.9 watchOS 2.0 tvOS 9.0 必須使用Xcode7及以上.NSURLConnectionOperation已經(jīng)移除
2.6->2.6.3 iOS 7 OS X 10.9 watchOS 2.0 n/a 必須使用Xcode7及以上
2.0->2.5.4 iOS 6 OS X10.8 n/a n/a 必須使用Xcode5及以上檩淋。NSURLSession需要iOS 7 或 OS X10.9
1.x iOS 5 Mac OS X 10.7 n/a n/a
0.10.x iOS 4 Mac OS X 10.6 n/a n/a

(OS X必須支持64位的Cocoa runtime)如果項目是使用Swift編寫,請嘗試使用Alamofire.

架構(gòu)

NSURLSession

  • AFURLSessionManager
  • AFHTTPSessionManager

序列化

<AFURLRequestSerialization>

  • AFHTTPRequestSerializer
  • AFJSONRequestSerializer
  • AFPropertyListRequestSerializer

<AFURLResponseSerialization>

  • AFHTTPResponseSerializer
  • AFJSONResponseSerializer
  • AFXMLParserResponseSerializer
  • AFXMLDocumentResponseSerializer (Mac OS X)
  • AFPropertyListResponseSerializer
  • AFImageResponseSerializer
  • AFCompoundResponseSerializer

額外方法

  • AFSecurityPolicy
  • AFNetworkReachabilityManager

使用

AFURLSessionManager

AFURLSessionManager創(chuàng)建和管理一個在NSURLSeesionConfigutarion對象基礎上的NSURLSession對象萄金,并遵循<NSURLSessionTaskDelegate>蟀悦,<NSURLSessionDataDelegate>,<NSURLSessionDownloadDelegate>和 <NSURLSessionDelegate>協(xié)議氧敢。

創(chuàng)建一個下載任務

NSURLSessionConfiguration *configuration = [NSURLSessionConfiguration defaultSessionConfiguration];
AFURLSessionManager *manager = [[AFURLSessionManager alloc] initWithSessionConfiguration:configuration];

NSURL *URL = [NSURL URLWithString:@"http://example.com/download.zip"];
NSURLRequest *request = [NSURLRequest requestWithURL:URL];

NSURLSessionDownloadTask *downloadTask = [manager downloadTaskWithRequest:request progress:nil destination:^NSURL *(NSURL *targetPath, NSURLResponse *response) {
    NSURL *documentsDirectoryURL = [[NSFileManager defaultManager] URLForDirectory:NSDocumentDirectory inDomain:NSUserDomainMask appropriateForURL:nil create:NO error:nil];
    return [documentsDirectoryURL URLByAppendingPathComponent:[response suggestedFilename]];
} completionHandler:^(NSURLResponse *response, NSURL *filePath, NSError *error) {
    NSLog(@"File downloaded to: %@", filePath);
}];
[downloadTask resume];

創(chuàng)建一個上傳任務

NSURLSessionConfiguration *configuration = [NSURLSessionConfiguration defaultSessionConfiguration];
AFURLSessionManager *manager = [[AFURLSessionManager alloc] initWithSessionConfiguration:configuration];

NSURL *URL = [NSURL URLWithString:@"http://example.com/upload"];
NSURLRequest *request = [NSURLRequest requestWithURL:URL];

NSURL *filePath = [NSURL fileURLWithPath:@"file://path/to/image.png"];
NSURLSessionUploadTask *uploadTask = [manager uploadTaskWithRequest:request fromFile:filePath progress:nil completionHandler:^(NSURLResponse *response, id responseObject, NSError *error) {
    if (error) {
        NSLog(@"Error: %@", error);
    } else {
        NSLog(@"Success: %@ %@", response, responseObject);
    }
}];
[uploadTask resume];

創(chuàng)建一個上傳多重部分請求的任務日戈,并顯示上傳進度

NSMutableURLRequest *request = [[AFHTTPRequestSerializer serializer] multipartFormRequestWithMethod:@"POST" URLString:@"http://example.com/upload" parameters:nil constructingBodyWithBlock:^(id<AFMultipartFormData> formData) {
        [formData appendPartWithFileURL:[NSURL fileURLWithPath:@"file://path/to/image.jpg"] name:@"file" fileName:@"filename.jpg" mimeType:@"image/jpeg" error:nil];
    } error:nil];

AFURLSessionManager *manager = [[AFURLSessionManager alloc] initWithSessionConfiguration:[NSURLSessionConfiguration defaultSessionConfiguration]];

NSURLSessionUploadTask *uploadTask;
uploadTask = [manager
              uploadTaskWithStreamedRequest:request
              progress:^(NSProgress * _Nonnull uploadProgress) {
                  // This is not called back on the main queue.
                  // You are responsible for dispatching to the main queue for UI updates
                  dispatch_async(dispatch_get_main_queue(), ^{
                      //Update the progress view
                      [progressView setProgress:uploadProgress.fractionCompleted];
                  });
              }
              completionHandler:^(NSURLResponse * _Nonnull response, id  _Nullable responseObject, NSError * _Nullable error) {
                  if (error) {
                      NSLog(@"Error: %@", error);
                  } else {
                      NSLog(@"%@ %@", response, responseObject);
                  }
              }];

[uploadTask resume];

創(chuàng)建一個獲取數(shù)據(jù)的任務

NSURLSessionConfiguration *configuration = [NSURLSessionConfiguration defaultSessionConfiguration];
AFURLSessionManager *manager = [[AFURLSessionManager alloc] initWithSessionConfiguration:configuration];

NSURL *URL = [NSURL URLWithString:@"http://httpbin.org/get"];
NSURLRequest *request = [NSURLRequest requestWithURL:URL];

NSURLSessionDataTask *dataTask = [manager dataTaskWithRequest:request completionHandler:^(NSURLResponse *response, id responseObject, NSError *error) {
    if (error) {
        NSLog(@"Error: %@", error);
    } else {
        NSLog(@"%@ %@", response, responseObject);
    }
}];
[dataTask resume];

請求序列化

請求序列化從URL字符串創(chuàng)建請求,編碼參數(shù)成為一個查詢字符串或HTTP內(nèi)容孙乖。

NSString *URLString = @"http://example.com";
NSDictionary *parameters = @{@"foo": @"bar", @"baz": @[@1, @2, @3]};

查詢字符串參數(shù)編碼

[[AFHTTPRequestSerializer serializer] requestWithMethod:@"GET" URLString:URLString parameters:parameters error:nil];

編碼后為

GET http://example.com?foo=bar&baz[]=1&baz[]=2&baz[]=3

URL格式參數(shù)編碼

[[AFHTTPRequestSerializer serializer] requestWithMethod:@"POST" URLString:URLString parameters:parameters error:nil];

編碼后為

POST http://example.com/
Content-Type: application/x-www-form-urlencoded

foo=bar&baz[]=1&baz[]=2&baz[]=3

JSON參數(shù)編碼

[[AFJSONRequestSerializer serializer] requestWithMethod:@"POST" URLString:URLString parameters:parameters error:nil];

編碼后為

POST http://example.com/
Content-Type: application/json

{"foo": "bar", "baz": [1,2,3]}

網(wǎng)絡可達性管理

AFNetworkReachabilityManager監(jiān)控域和IP地址通過WWAN和WiFi網(wǎng)絡是否可達浙炼。

  • 不要使用可達性去判斷原始請求是否需要發(fā)送。(應該嘗試的發(fā)送
  • 你可以使用可達性去判斷唯袄,一個請求是否應該自動重發(fā)弯屈。(雖然它可能仍然失敗,但是收到網(wǎng)絡連接可用的可達性通知后恋拷,非常合適再去重試發(fā)送
  • 網(wǎng)絡可達性是判斷一個請求失敗的原因的最好工具资厉。(當一個網(wǎng)絡請求失敗后,告訴用戶已經(jīng)離線了比顯示一個比如“請求超時”的技術(shù)信息好蔬顾,所以提示很正確
    你也可以看WWDC 2012 706講 “網(wǎng)絡最好實踐”.

共享的網(wǎng)絡可達性

[[AFNetworkReachabilityManager sharedManager] setReachabilityStatusChangeBlock:^(AFNetworkReachabilityStatus status) {
    NSLog(@"Reachability: %@", AFStringFromNetworkReachabilityStatus(status));
}];

[[AFNetworkReachabilityManager sharedManager] startMonitoring];

安全策略

AFSecurityPolicy通過X.509證書和公共密鑰安全連接宴偿,來評估服務器的可靠性湘捎。
添加固定的SSL證書到你的應用中,幫忙保護中間人攻擊和其他弱點窄刘。應用處理敏感的用戶數(shù)據(jù)或財務信息窥妇,強烈建議所有的通訊通過SSL固定證書并且已經(jīng)使能的HTTPS鏈接。

允許無效的SSL證書

AFHTTPSessionManager *manager = [AFHTTPSessionManager manager];
manager.securityPolicy.allowInvalidCertificates = YES; // not recommended for production

單元測試

AFNetworking在Tests子目錄中包含一系列的單元測試娩践。這些單元測試可以很方便的運行活翩,你會喜歡在framework平臺上可以執(zhí)行測試事件。

信用

Alamofire軟件基金會擁有和維護AFNetworking欺矫。
GowallaiPhone開發(fā)部門的Scott RaymondMattt Thompson創(chuàng)建了最初的AFNetworking版本纱新。
Alan Defibaugh設計了AFNetworking的圖標。
總之穆趴,感謝AFNetworking的貢獻者.

安全公開

如果你確信你已經(jīng)鑒定AFNetworking存在安全缺陷脸爱,請盡快的發(fā)送通過郵件發(fā)送到security@alamofire.org. 請不要將它發(fā)送為一個公開的問題跟蹤。

許可證

AFNetworking遵守MIT許可證未妹。詳見LICENSE簿废。


類說明


協(xié)議說明


擴展說明


常量說明


// END 2017年7月18日 中午

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市络它,隨后出現(xiàn)的幾起案子族檬,更是在濱河造成了極大的恐慌,老刑警劉巖化戳,帶你破解...
    沈念sama閱讀 217,907評論 6 506
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件单料,死亡現(xiàn)場離奇詭異,居然都是意外死亡点楼,警方通過查閱死者的電腦和手機扫尖,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,987評論 3 395
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來掠廓,“玉大人换怖,你說我怎么就攤上這事◇扒疲” “怎么了沉颂?”我有些...
    開封第一講書人閱讀 164,298評論 0 354
  • 文/不壞的土叔 我叫張陵,是天一觀的道長悦污。 經(jīng)常有香客問我铸屉,道長,這世上最難降的妖魔是什么切端? 我笑而不...
    開封第一講書人閱讀 58,586評論 1 293
  • 正文 為了忘掉前任抬探,我火速辦了婚禮,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘小压。我一直安慰自己线梗,他們只是感情好,可當我...
    茶點故事閱讀 67,633評論 6 392
  • 文/花漫 我一把揭開白布怠益。 她就那樣靜靜地躺著仪搔,像睡著了一般。 火紅的嫁衣襯著肌膚如雪蜻牢。 梳的紋絲不亂的頭發(fā)上烤咧,一...
    開封第一講書人閱讀 51,488評論 1 302
  • 那天,我揣著相機與錄音抢呆,去河邊找鬼煮嫌。 笑死,一個胖子當著我的面吹牛抱虐,可吹牛的內(nèi)容都是我干的昌阿。 我是一名探鬼主播,決...
    沈念sama閱讀 40,275評論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼恳邀,長吁一口氣:“原來是場噩夢啊……” “哼懦冰!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起谣沸,我...
    開封第一講書人閱讀 39,176評論 0 276
  • 序言:老撾萬榮一對情侶失蹤刷钢,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后乳附,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體内地,經(jīng)...
    沈念sama閱讀 45,619評論 1 314
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 37,819評論 3 336
  • 正文 我和宋清朗相戀三年赋除,在試婚紗的時候發(fā)現(xiàn)自己被綠了阱缓。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 39,932評論 1 348
  • 序言:一個原本活蹦亂跳的男人離奇死亡贤重,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出清焕,到底是詐尸還是另有隱情并蝗,我是刑警寧澤,帶...
    沈念sama閱讀 35,655評論 5 346
  • 正文 年R本政府宣布秸妥,位于F島的核電站滚停,受9級特大地震影響,放射性物質(zhì)發(fā)生泄漏粥惧。R本人自食惡果不足惜键畴,卻給世界環(huán)境...
    茶點故事閱讀 41,265評論 3 329
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧起惕,春花似錦涡贱、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,871評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至嘀粱,卻和暖如春激挪,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背锋叨。 一陣腳步聲響...
    開封第一講書人閱讀 32,994評論 1 269
  • 我被黑心中介騙來泰國打工垄分, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人娃磺。 一個月前我還...
    沈念sama閱讀 48,095評論 3 370
  • 正文 我出身青樓薄湿,卻偏偏與公主長得像,于是被迫代替她去往敵國和親豌鸡。 傳聞我的和親對象是個殘疾皇子嘿般,可洞房花燭夜當晚...
    茶點故事閱讀 44,884評論 2 354

推薦閱讀更多精彩內(nèi)容

  • 繼承:NSObject 遵照:NSCopying,NSSecureCoding涯冠,NSURLSessionDataD...
    _阿南_閱讀 1,795評論 1 2
  • 呵呵噠炉奴,一直想全面的了解下AFN。并聽說AFN的代碼是標準的MVC模式編寫的蛇更。同時也是對網(wǎng)絡的熟悉吧瞻赶。所以試著查看...
    蝴蝶之夢天使閱讀 332評論 0 3
  • 1.官網(wǎng)文檔外加點中文注釋AFNetworking官網(wǎng)(點擊進入) AFNetworking翻譯注釋Archite...
    小名一峰閱讀 3,718評論 5 25
  • Spring Cloud為開發(fā)人員提供了快速構(gòu)建分布式系統(tǒng)中一些常見模式的工具(例如配置管理,服務發(fā)現(xiàn)派任,斷路器砸逊,智...
    卡卡羅2017閱讀 134,656評論 18 139
  • 二、 詳細介紹 1. AFNetworking 這是 AFNetworking 的主要部分掌逛,包括 6 個功能部分共...
    隨風飄蕩的小逗逼閱讀 4,417評論 0 2