iOS AFNetWorking原始碼詳解（一）

發表於2016-07-10

首先來介紹下AFNetWorking，官方介紹如下：

AFNetworking is a delightful networking library for iOS and Mac OS X. It’s built on top of theFoundation URL Loading System, extending the powerful high-level networking abstractions built into Cocoa. It has a modular architecture with well-designed, feature-rich APIs that are a joy to use.

Perhaps the most important feature of all, however, is the amazing community of developers who use and contribute to AFNetworking every day. AFNetworking powers some of the most popular and critically-acclaimed apps on the iPhone, iPad, and Mac.

Choose AFNetworking for your next project, or migrate over your existing projects—you’ll be happy you did!

翻譯過來簡單來說就是

AFNetworking是一個適用於iOS和Mac OS X兩個平臺的網路庫，它是基於Foundation URL Loading System上進行了一套封裝，並且提供了豐富且優美的API介面給使用者使用

相信從star數和fork數來看，大家都能明白這個庫是多麼的受歡迎了，所以瞭解這個庫對於一個iOS開發來說是極為重要的！

這個是AFNetworking的github地址：GitHub – AFNetworking/AFNetworking: A delightful networking framework for iOS

在使用前閱讀README是非常重要的，裡面往往包括了這個庫的介紹、安裝和使用等等，對於快速瞭解一個庫來說，這是非常有幫助的

首先我們在AFNetWorking原始碼地址裡download下來，開啟工程檔案，可以看到裡面內容分為兩個部分，一個是AFNetworking，另一個是UIKit+AFNetworking

很明顯，第一個是用來做網路請求相關的，第二個則是和UI使用相關的，我們先看第一個

在看完標頭檔案和README之後，你會發現AFURLSessionManager和AFHTTPSessionManager是裡面比較重要的兩個類

這裡我先講AFURLSessionManager這個類

首先瀏覽完這個類從API，發現其主要提供了資料的請求、上傳和下載功能

在屬性方面：

@property(readonly,nonatomic,strong)NSArray *tasks;

@property(readonly,nonatomic,strong)NSArray *dataTasks;

@property(readonly,nonatomic,strong)NSArray *uploadTasks;

@property(readonly,nonatomic,strong)NSArray *downloadTasks;

@property(readonly,nonatomic,strong)NSArray *tasks;

@property(readonly,nonatomic,strong)NSArray *dataTasks;

@property(readonly,nonatomic,strong)NSArray *uploadTasks;

@property(readonly,nonatomic,strong)NSArray *downloadTasks;

通過這四個屬性，我們分別可以拿到總的任務集合、資料任務集合、上傳任務集合和下載任務集合

@property(nonatomic,assign)BOOL attemptsToRecreateUploadTasksForBackgroundSessions;

1	@property(nonatomic,assign)BOOL attemptsToRecreateUploadTasksForBackgroundSessions;

這個屬性非常重要，註釋裡面寫到，在iOS7中存在一個bug，在建立後臺上傳任務時，有時候會返回nil，所以為了解決這個問題，AFNetworking遵照了蘋果的建議，在建立失敗的時候，會重新嘗試建立，次數預設為3次，所以你的應用如果有場景會有在後臺上傳的情況的話，記得將該值設為YES，避免出現上傳失敗的問題

FOUNDATION_EXPORT NSString * const AFNetworkingTaskDidResumeNotification;

1	FOUNDATION_EXPORT NSString * const AFNetworkingTaskDidResumeNotification;

在對外提供的notification key裡面，使用了FOUNDATION_EXPORT來定義常量，使用FOUNDATION_EXPORT和extern或者define有什麼區別呢？

FOUNDATION_EXPORT在c檔案編譯下是和extern等同，在c++檔案編譯下是和extern “C”等同，在32位機的環境下又是另外編譯情況，在相容性方面，FOUNDATION_EXPORT做的會更好。

這裡還提到了效率方面的問題：iOS開發的一些奇巧淫技3

進入到實現檔案裡面，我們可以看到在外部API呼叫dataTask、uploadTask、downloadTask方法實際上都是completionHanlder block返回出來的，但是我們知道網路請求是delegate返回結果的，AF內部做了巧妙的操作，他對每個task都增加代理設定

- (NSURLSessionDataTask *)dataTaskWithRequest:(NSURLRequest *)request
                               uploadProgress:(nullable void (^)(NSProgress *uploadProgress)) uploadProgressBlock
                             downloadProgress:(nullable void (^)(NSProgress *downloadProgress)) downloadProgressBlock
                            completionHandler:(nullable void (^)(NSURLResponse *response, id _Nullable responseObject,  NSError * _Nullable error))completionHandler {
	__block NSURLSessionDataTask *dataTask = nil;
    url_session_manager_create_task_safely(^{
        dataTask = [self.session dataTaskWithRequest:request];
    });
    
	// 每個task裡面都會呼叫addDelegate方法
    [self addDelegateForDataTask:dataTask uploadProgress:uploadProgressBlock downloadProgress:downloadProgressBlock completionHandler:completionHandler];

    return dataTask;
}

- (NSURLSessionDataTask *)dataTaskWithRequest:(NSURLRequest *)request

uploadProgress:(nullable void (^)(NSProgress *uploadProgress)) uploadProgressBlock

downloadProgress:(nullable void (^)(NSProgress *downloadProgress)) downloadProgressBlock

completionHandler:(nullable void (^)(NSURLResponse *response, id _Nullable responseObject, NSError * _Nullable error))completionHandler {

__block NSURLSessionDataTask *dataTask = nil;

url_session_manager_create_task_safely(^{

dataTask = [self.session dataTaskWithRequest:request];

});

// 每個task裡面都會呼叫addDelegate方法

[self addDelegateForDataTask:dataTask uploadProgress:uploadProgressBlock downloadProgress:downloadProgressBlock completionHandler:completionHandler];

return dataTask;

}

在設定裡面，每個task會在內部建立AFURLSessionManagerTaskDelegate物件，並設定completionHandler、uploadProgressBlock、downloadProgressBlock回撥

- (void)addDelegateForDataTask:(NSURLSessionDataTask *)dataTask
                uploadProgress:(nullable void (^)(NSProgress *uploadProgress)) uploadProgressBlock
              downloadProgress:(nullable void (^)(NSProgress *downloadProgress)) downloadProgressBlock
             completionHandler:(void (^)(NSURLResponse *response, id responseObject, NSError *error))completionHandler
{
    // 初始化delegate物件
    AFURLSessionManagerTaskDelegate *delegate = [[AFURLSessionManagerTaskDelegate alloc] init];
    delegate.manager = self;
    // 將task的completionHandler賦給delegate，系統網路請求delegate 呼叫該block，返回結果
    delegate.completionHandler = completionHandler;

    dataTask.taskDescription = self.taskDescriptionForSessionTasks;
    // 對task進行delegate
    [self setDelegate:delegate forTask:dataTask];
	// 設定上傳和下載進度回撥
    delegate.uploadProgressBlock = uploadProgressBlock;
    delegate.downloadProgressBlock = downloadProgressBlock;
}

- (void)addDelegateForDataTask:(NSURLSessionDataTask *)dataTask

uploadProgress:(nullable void (^)(NSProgress *uploadProgress)) uploadProgressBlock

downloadProgress:(nullable void (^)(NSProgress *downloadProgress)) downloadProgressBlock

completionHandler:(void (^)(NSURLResponse *response, id responseObject, NSError *error))completionHandler

{

// 初始化delegate物件

AFURLSessionManagerTaskDelegate *delegate = [[AFURLSessionManagerTaskDelegate alloc] init];

delegate.manager = self;

// 將task的completionHandler賦給delegate，系統網路請求delegate 呼叫該block，返回結果

delegate.completionHandler = completionHandler;

dataTask.taskDescription = self.taskDescriptionForSessionTasks;

// 對task進行delegate

[self setDelegate:delegate forTask:dataTask];

// 設定上傳和下載進度回撥

delegate.uploadProgressBlock = uploadProgressBlock;

delegate.downloadProgressBlock = downloadProgressBlock;

}

然後delegate物件利用kvo將task對一些方法進行監聽，並且監聽到變化時，通過block返回，將delegate轉成block出去

- (void)setDelegate:(AFURLSessionManagerTaskDelegate *)delegate
            forTask:(NSURLSessionTask *)task
{
    // 斷言
    NSParameterAssert(task);
    NSParameterAssert(delegate);

    [self.lock lock];
    self.mutableTaskDelegatesKeyedByTaskIdentifier[@(task.taskIdentifier)] = delegate;
    // task使用kvo對一些方法監聽，返回上傳或者下載的進度
    [delegate setupProgressForTask:task];
    // sessionManager對暫停task和恢復task進行註冊通知
    [self addNotificationObserverForTask:task];
    [self.lock unlock];
}

- (void)setDelegate:(AFURLSessionManagerTaskDelegate *)delegate

forTask:(NSURLSessionTask *)task

{

// 斷言

NSParameterAssert(task);

NSParameterAssert(delegate);

[self.lock lock];

self.mutableTaskDelegatesKeyedByTaskIdentifier[@(task.taskIdentifier)] = delegate;

// task使用kvo對一些方法監聽，返回上傳或者下載的進度

[delegate setupProgressForTask:task];

// sessionManager對暫停task和恢復task進行註冊通知

[self addNotificationObserverForTask:task];

[self.lock unlock];

}

在原先IM的設計時，因為介面的數量並不多，所以在AsyncSocket的delegate回撥後，我們依舊是採用delegate回撥給業務層，但是隨著介面數量的增加，業務層對於回撥的處理更加困難和不可控，在重構IM的時候，我們也參考學習了AF的做法，我們通過對唯一標識和每個請求做一一繫結，將請求的上下文關聯起來，這樣讓socket長連線的請求的也想http請求一樣，都由block回去，對於業務層的處理也方便更多

setupProgressForTask方法主要是對task和progress設定監聽

- (void)setupProgressForTask:(NSURLSessionTask *)task {
    __weak __typeof__(task) weakTask = task;

    // 設定上傳和下載的大小
    
    // 設定上傳和下載中允許取消和暫停
  
  	// 設定上傳和下載響應恢復處理方法後恢復上傳或下載
    
    // task對接收到的位元組數、期望接收到的位元組數、傳送的位元組數、期望傳送的位元組數設定監聽
    [task addObserver:self
           forKeyPath:NSStringFromSelector(@selector(countOfBytesReceived))
              options:NSKeyValueObservingOptionNew
              context:NULL];
    [task addObserver:self
          forKeyPath:NSStringFromSelector(@selector(countOfBytesExpectedToReceive))
              options:NSKeyValueObservingOptionNew
              context:NULL];

    [task addObserver:self
           forKeyPath:NSStringFromSelector(@selector(countOfBytesSent))
              options:NSKeyValueObservingOptionNew
              context:NULL];
    [task addObserver:self
           forKeyPath:NSStringFromSelector(@selector(countOfBytesExpectedToSend))
              options:NSKeyValueObservingOptionNew
              context:NULL];
	// 上傳和下載設定完成的分數監聽
    [self.downloadProgress addObserver:self
                            forKeyPath:NSStringFromSelector(@selector(fractionCompleted))
                               options:NSKeyValueObservingOptionNew
                               context:NULL];
    [self.uploadProgress addObserver:self
                          forKeyPath:NSStringFromSelector(@selector(fractionCompleted))
                             options:NSKeyValueObservingOptionNew
                             context:NULL];
}

- (void)setupProgressForTask:(NSURLSessionTask *)task {

__weak __typeof__(task) weakTask = task;

// 設定上傳和下載的大小

// 設定上傳和下載中允許取消和暫停

// 設定上傳和下載響應恢復處理方法後恢復上傳或下載

// task對接收到的位元組數、期望接收到的位元組數、傳送的位元組數、期望傳送的位元組數設定監聽

[task addObserver:self

forKeyPath:NSStringFromSelector(@selector(countOfBytesReceived))