AFNetworking 3.0 原始碼解讀（六）之 AFHTTPSessionManager

weixin_34321977發表於2016-08-20

原始碼HTTPSession

AFHTTPSessionManager相對來說比較好理解，程式碼也比較短。但卻是我們平時可能使用最多的類。

AFNetworking 3.0 原始碼解讀（一）之 AFNetworkReachabilityManager

AFNetworking 3.0 原始碼解讀（二）之 AFSecurityPolicy

AFNetworking 3.0 原始碼解讀（三）之 AFURLRequestSerialization

AFNetworking 3.0 原始碼解讀（四）之 AFURLResponseSerialization

AFNetworking 3.0 原始碼解讀（五）之 AFURLSessionManager

前言

AFHTTPSessionManager是AFURLSessionManager的子類，是專門為HTTP請求設計的。裡邊涉及到了GET,POST,PUT,DELETE 等等HTTPMehtod。因此我們要想正確的使用各種方法，就要理解每個method的含義。
可以通過這篇文章來了解HTTP Method詳細解讀(GET HEAD POST OPTIONS PUT DELETE TRACE CONNECT)

1.相對路徑(relative)

假如有一個基礎路徑NSURL *baseURL = [NSURL URLWithString:@"http://example.com/v1/"];我們暫時命名為baseURL.所謂相對肯定跟這個baseURL有關係。

我們可以通過NSURL +URLWithString:relativeToURL:這個方法來獲取一個路徑，至於怎麼使用，我們通過一個例子來說明：

NSURL *baseURL = [NSURL URLWithString:@"http://example.com/v1/"];
[NSURL URLWithString:@"foo" relativeToURL:baseURL];                  // http://example.com/v1/foo
[NSURL URLWithString:@"foo?bar=baz" relativeToURL:baseURL];          // http://example.com/v1/foo?bar=baz
[NSURL URLWithString:@"/foo" relativeToURL:baseURL];                 // http://example.com/foo
[NSURL URLWithString:@"foo/" relativeToURL:baseURL];                 // http://example.com/v1/foo
[NSURL URLWithString:@"/foo/" relativeToURL:baseURL];                // http://example.com/foo/
[NSURL URLWithString:@"http://example2.com/" relativeToURL:baseURL]; // http://example2.com/

至於 絕對路徑 和 相對路徑 的定義，使用方法，優缺點，這裡就不提了，大家可以自行了解。說一下為什麼使用相對路徑吧。

在真實開發中，一般都會有一個線上的伺服器和一下測試伺服器，當然也可能多個。在ios開發中切換開發環境有好幾種方法，

通過target
自定義一個欄位HTTPURL，用它來控制路徑
通過相對路徑來切換介面

2.GET

// 使用GET 方法獲取資料，不帶進度
- (NSURLSessionDataTask *)GET:(NSString *)URLString
                   parameters:(id)parameters
                      success:(void (^)(NSURLSessionDataTask *task, id responseObject))success
                      failure:(void (^)(NSURLSessionDataTask *task, NSError *error))failure
{

    return [self GET:URLString parameters:parameters progress:nil success:success failure:failure];
}
// 使用GET 方法獲取資料，帶進度
- (NSURLSessionDataTask *)GET:(NSString *)URLString
                   parameters:(id)parameters
                     progress:(void (^)(NSProgress * _Nonnull))downloadProgress
                      success:(void (^)(NSURLSessionDataTask * _Nonnull, id _Nullable))success
                      failure:(void (^)(NSURLSessionDataTask * _Nullable, NSError * _Nonnull))failure
{

    NSURLSessionDataTask *dataTask = [self dataTaskWithHTTPMethod:@"GET"
                                                        URLString:URLString
                                                       parameters:parameters
                                                   uploadProgress:nil
                                                 downloadProgress:downloadProgress
                                                          success:success
                                                          failure:failure];

    [dataTask resume];

    return dataTask;
}

3.HEAD

// 使用HEAD 方法獲取資料，
- (NSURLSessionDataTask *)HEAD:(NSString *)URLString
                    parameters:(id)parameters
                       success:(void (^)(NSURLSessionDataTask *task))success
                       failure:(void (^)(NSURLSessionDataTask *task, NSError *error))failure
{
    NSURLSessionDataTask *dataTask = [self dataTaskWithHTTPMethod:@"HEAD" URLString:URLString parameters:parameters uploadProgress:nil downloadProgress:nil success:^(NSURLSessionDataTask *task, __unused id responseObject) {
        if (success) {
            success(task);
        }
    } failure:failure];

    [dataTask resume];

    return dataTask;
}

4.POST

- (NSURLSessionDataTask *)POST:(NSString *)URLString
                    parameters:(id)parameters
                       success:(void (^)(NSURLSessionDataTask *task, id responseObject))success
                       failure:(void (^)(NSURLSessionDataTask *task, NSError *error))failure
{
    return [self POST:URLString parameters:parameters progress:nil success:success failure:failure];
}

- (NSURLSessionDataTask *)POST:(NSString *)URLString
                    parameters:(id)parameters
                      progress:(void (^)(NSProgress * _Nonnull))uploadProgress
                       success:(void (^)(NSURLSessionDataTask * _Nonnull, id _Nullable))success
                       failure:(void (^)(NSURLSessionDataTask * _Nullable, NSError * _Nonnull))failure
{
    NSURLSessionDataTask *dataTask = [self dataTaskWithHTTPMethod:@"POST" URLString:URLString parameters:parameters uploadProgress:uploadProgress downloadProgress:nil success:success failure:failure];

    [dataTask resume];

    return dataTask;
}

5.上傳資料

- (NSURLSessionDataTask *)POST:(NSString *)URLString
                    parameters:(nullable id)parameters
     constructingBodyWithBlock:(nullable void (^)(id<AFMultipartFormData> _Nonnull))block
                       success:(nullable void (^)(NSURLSessionDataTask * _Nonnull, id _Nullable))success
                       failure:(nullable void (^)(NSURLSessionDataTask * _Nullable, NSError * _Nonnull))failure
{
    return [self POST:URLString parameters:parameters constructingBodyWithBlock:block progress:nil success:success failure:failure];
}

- (NSURLSessionDataTask *)POST:(NSString *)URLString
                    parameters:(id)parameters
     constructingBodyWithBlock:(void (^)(id <AFMultipartFormData> formData))block
                      progress:(nullable void (^)(NSProgress * _Nonnull))uploadProgress
                       success:(void (^)(NSURLSessionDataTask *task, id responseObject))success
                       failure:(void (^)(NSURLSessionDataTask *task, NSError *error))failure
{
    NSError *serializationError = nil;
    NSMutableURLRequest *request = [self.requestSerializer multipartFormRequestWithMethod:@"POST" URLString:[[NSURL URLWithString:URLString relativeToURL:self.baseURL] absoluteString] parameters:parameters constructingBodyWithBlock:block error:&serializationError];
    if (serializationError) {
        if (failure) {
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Wgnu"
            dispatch_async(self.completionQueue ?: dispatch_get_main_queue(), ^{
                failure(nil, serializationError);
            });
#pragma clang diagnostic pop
        }

        return nil;
    }

    __block NSURLSessionDataTask *task = [self uploadTaskWithStreamedRequest:request progress:uploadProgress completionHandler:^(NSURLResponse * __unused response, id responseObject, NSError *error) {
        if (error) {
            if (failure) {
                failure(task, error);
            }
        } else {
            if (success) {
                success(task, responseObject);
            }
        }
    }];

    [task resume];

    return task;
}

6.PUT

- (NSURLSessionDataTask *)PUT:(NSString *)URLString
                   parameters:(id)parameters
                      success:(void (^)(NSURLSessionDataTask *task, id responseObject))success
                      failure:(void (^)(NSURLSessionDataTask *task, NSError *error))failure
{
    NSURLSessionDataTask *dataTask = [self dataTaskWithHTTPMethod:@"PUT" URLString:URLString parameters:parameters uploadProgress:nil downloadProgress:nil success:success failure:failure];

    [dataTask resume];

    return dataTask;
}

7.PATCH

- (NSURLSessionDataTask *)PATCH:(NSString *)URLString
                     parameters:(id)parameters
                        success:(void (^)(NSURLSessionDataTask *task, id responseObject))success
                        failure:(void (^)(NSURLSessionDataTask *task, NSError *error))failure
{
    NSURLSessionDataTask *dataTask = [self dataTaskWithHTTPMethod:@"PATCH" URLString:URLString parameters:parameters uploadProgress:nil downloadProgress:nil success:success failure:failure];

    [dataTask resume];

    return dataTask;
}

8.DELETE

- (NSURLSessionDataTask *)DELETE:(NSString *)URLString
                      parameters:(id)parameters
                         success:(void (^)(NSURLSessionDataTask *task, id responseObject))success
                         failure:(void (^)(NSURLSessionDataTask *task, NSError *error))failure
{
    NSURLSessionDataTask *dataTask = [self dataTaskWithHTTPMethod:@"DELETE" URLString:URLString parameters:parameters uploadProgress:nil downloadProgress:nil success:success failure:failure];

    [dataTask resume];

    return dataTask;
}

9.私有方法

- (NSURLSessionDataTask *)dataTaskWithHTTPMethod:(NSString *)method
                                       URLString:(NSString *)URLString
                                      parameters:(id)parameters
                                  uploadProgress:(nullable void (^)(NSProgress *uploadProgress)) uploadProgress
                                downloadProgress:(nullable void (^)(NSProgress *downloadProgress)) downloadProgress
                                         success:(void (^)(NSURLSessionDataTask *, id))success
                                         failure:(void (^)(NSURLSessionDataTask *, NSError *))failure
{
    NSError *serializationError = nil;
    NSMutableURLRequest *request = [self.requestSerializer requestWithMethod:method URLString:[[NSURL URLWithString:URLString relativeToURL:self.baseURL] absoluteString] parameters:parameters error:&serializationError];
    if (serializationError) {
        if (failure) {
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Wgnu"
            dispatch_async(self.completionQueue ?: dispatch_get_main_queue(), ^{
                failure(nil, serializationError);
            });
#pragma clang diagnostic pop
        }

        return nil;
    }

    __block NSURLSessionDataTask *dataTask = nil;
    dataTask = [self dataTaskWithRequest:request
                          uploadProgress:uploadProgress
                        downloadProgress:downloadProgress
                       completionHandler:^(NSURLResponse * __unused response, id responseObject, NSError *error) {
        if (error) {
            if (failure) {
                failure(dataTask, error);
            }
        } else {
            if (success) {
                success(dataTask, responseObject);
            }
        }
    }];

    return dataTask;
}

這篇文章確實比較簡單，有了前幾篇文章的鋪墊，到了我們真正使用的時候，一切都變得那麼簡單自然啊.我們已經不知不覺中學到了很多知識，但有一點，知識這東西，要反覆的記憶才能記住。舉個例子吧，平時可能我們需要在web端檢視json資料，當我們把引數拼接到paramter中，該怎麼檢視呢？

找到AFURLRequestSerialization這個.m
找到requestBySerializingRequest: withParameters: error:這個方法
NSLog(@"URL: %@",mutableRequest.URL.absoluteString);

說明

接下來先把 AFNetworking 的分類再解析完，然後開始搭建網路框架。

原始碼閱讀：AFNetworking（七）——AFHTTPSessionManager
2018-03-07
原始碼HTTPSession
原始碼閱讀：AFNetworking（六）——AFURLSessionManager
2018-03-05
原始碼Session
AFNetworking 原始碼閱讀
2017-12-19
原始碼
AFNetWorking原始碼之AFURLSessionManager
2017-04-19
原始碼Session
AFNetWorking原始碼之AFURLRequestSerialization
2017-04-25
原始碼
原始碼閱讀：AFNetworking（十六）——UIWebView+AFNetworking
2018-03-16
原始碼UIWebView
原始碼閱讀：AFNetworking（十四）——UIProgressView+AFNetworking
2018-03-16
原始碼UIView
原始碼閱讀：AFNetworking（十三）——UIImageView+AFNetworking
2018-03-16
原始碼UIView
原始碼閱讀：AFNetworking（十一）——UIActivityIndicatorView+AFNetworking
2018-03-15
原始碼UIIndicatorView
AFNetworking（一）從一次請求瞭解AFHTTPSessionManager
2019-01-21
HTTPSession
原始碼閱讀：AFNetworking（二）——AFURLRequestSerialization
2019-02-28
原始碼
原始碼閱讀：AFNetworking（三）——AFURLResponseSerialization
2018-02-10
原始碼
原始碼閱讀：AFNetworking（四）——AFSecurityPolicy
2018-02-26
原始碼
原始碼閱讀：AFNetworking（十二）——UIButton+AFNetworking
2018-03-15
原始碼UI
原始碼閱讀：AFNetworking（十五）——UIRefreshControl+AFNetworking
2018-03-16
原始碼UI
AFNetWorking原始碼詳解（二）
2016-07-10
原始碼
原始碼閱讀：AFNetworking（五）——AFNetworkReachabilityManager
2018-02-27
原始碼
原始碼閱讀：AFNetworking（九）——AFImageDownloader
2018-03-11
原始碼
原始碼閱讀：AFNetworking（八）——AFAutoPurgingImageCache
2018-03-09
原始碼
原始碼閱讀：AFNetworking（十）——AFNetworkActivityIndicatorManager
2018-03-14
原始碼IndicatorORM
原始碼閱讀：AFNetworking（一）——從使用入手
2017-12-16
原始碼
iOS AFNetWorking原始碼詳解（一）
2016-07-10
iOS原始碼
React原始碼解讀之setState
2018-07-20
React原始碼
React原始碼解讀之componentMount
2018-07-18
React原始碼
DeepSort之原始碼解讀
2022-04-05
原始碼
AFNetworking原始碼分析
2016-07-18
原始碼
【原始碼解讀(一)】EFCORE原始碼解讀之建立DBContext查詢攔截
2023-10-13
原始碼Context
Element UI 原始碼解讀之 Table 元件
2019-03-04
UI原始碼元件
原始碼閱讀：SDWebImage（六）——SDWebImageCoderHelper
2018-06-01
原始碼Web
Vue 原始碼閱讀（六）元件化
2018-03-08
Vue原始碼元件化
AFNetworking 原始碼分析（一）
2018-05-21
原始碼
elastic-job 原始碼解讀之從原始碼看null值
2021-09-09
AST原始碼Null
智慧安全3.0之可信任解讀
2021-06-09
D3原始碼解讀系列之Chord
2019-11-01
原始碼
D3原始碼解讀系列之Dispatches
2019-11-01
原始碼
D3原始碼解讀系列之Force
2019-11-01
原始碼
D3原始碼解讀系列之Hierarchies
2019-11-01
原始碼
D3原始碼解讀系列之Path
2019-11-01
原始碼