AFNetworking源码阅读1——脉络

作者: Wang66 | 来源:发表于2016-10-10 11:44 被阅读1187次

前言

本来是国庆前开始看AFNetworking源码的，原本还计划着国庆假期时把这个搞完的，结果国庆荒废了，啥也没干成。所以，现在赶紧开搞。

准备

首先下载一份AFNetworking然后拷入工程，我们看看它的文件目录如下图：
AFURLSessionManager类是其核心，基于iOS的NSURLSession完成网络请求数据工作；而AFHTTPSessionManager则继承前者，给开发者提供了更友好的HTTP请求方法接口；AFURLRequestSerialization和AFURLResponseSerialization分别是请求序列化器和响应序列化器；AFSecurityPolicy是有关安全策略的；AFNetworkReachabilityManager是网络可达性检测器。而整个UIKit+AFNetworking文件都是和UI相关的。

屏幕快照 2016-10-09 下午2.43.02.png

在还没看代码之前，我们先温习一下NSURLSession是怎么玩的。大概就是这么玩的：

    NSURLRequest *urlRequest = [[NSURLRequest alloc] initWithURL:[NSURL URLWithString:@""]];
    
    NSURLSessionConfiguration *config = [NSURLSessionConfiguration defaultSessionConfiguration];// 1.创建“会话配置”对象
    NSURLSession *session = [NSURLSession sessionWithConfiguration:config]; // 2.通过“会话配置”对象生成一个session
    
    // 3.调用session的dataTaskWithRequest:completionHandler:方法，传入request参数生成一个session task.
    NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:urlRequest completionHandler:^(NSData * _Nullable data, NSURLResponse * _Nullable response, NSError * _Nullable error) {
        
    }];
    
    [dataTask suspend]; // 4.要手动启动task（任务）

首先创建一个“会话配置”对象；然后以此生成一个session对象；再调用session的实例方法dataTaskWithRequest:completionHandler:传入request，生成dataTask；最后，还要手动启动此dataTask。因为需要传入request参数，所以还要提前生成一个request对象。
NSURLSession的基本用法就是上面几个步骤，但其详情还请移步查阅文档资料（比如：从 NSURLConnection 到 NSURLSession）。
我们可以思考一下，既然AFNetworking是基于NSURLSession完成的，那其最核心最基本的骨架也其实就是这几个步骤？！明白了这个道理，在看源码时我们的思路会比较清晰。

源码

现在我们正式开始说AFNetworking的源码。首先看看它的简单使用：

    NSDictionary *dictParam = @{@"name":@"wang66", @"phone":@{@"mobile":@"18693133051", @"home":@"2361126"}};
    
    // 先创建一个AFHTTPSessionManager的实例对象。AFHTTPSessionManager类提供了多种初始化方法
//    AFHTTPSessionManager *manager = [AFHTTPSessionManager manager];
    AFHTTPSessionManager *manager = [[AFHTTPSessionManager alloc] initWithBaseURL:[NSURL URLWithString:@""]];

    [manager GET:@"course/list"
      parameters:dictParam
        progress:nil
         success:^(NSURLSessionDataTask * _Nonnull task, id  _Nullable responseObject) {
             
    } failure:^(NSURLSessionDataTask * _Nullable task, NSError * _Nonnull error) {
        
    }];

可以看到，使用非常简单。我们只需要用AFHTTPSessionManager类，首先在初始化方法里生成实例时便设置了baseUrl,这样我们在每次调用请求服务器的方法时只需要传入接口的名字字符串就行了。然后调用manager的实例方法GET:parameters:progress:success:failure:就可以了。传入接口名字，参数就会通过block回调进度，成功后的数据或失败后的错误信息。
要想了解AFNetworking看来得从AFHTTPSessionManager入手。

——AFHTTPSessionManager——

先看头文件AFHTTPSessionManager.h

屏幕快照 2016-10-09 下午6.00.09.png

#import "AFURLSessionManager.h"

@interface AFHTTPSessionManager : AFURLSessionManager <NSSecureCoding, NSCopying>

@property (readonly, nonatomic, strong, nullable) NSURL *baseURL;

@property (nonatomic, strong) AFHTTPRequestSerializer <AFURLRequestSerialization> * requestSerializer;

@property (nonatomic, strong) AFHTTPResponseSerializer <AFURLResponseSerialization> * responseSerializer;

#pragma mark ---- init method
+ (instancetype)manager;

- (instancetype)initWithBaseURL:(nullable NSURL *)url;

- (instancetype)initWithBaseURL:(nullable NSURL *)url
           sessionConfiguration:(nullable NSURLSessionConfiguration *)configuration NS_DESIGNATED_INITIALIZER;

#pragma mark ---- HTTP Request
- (nullable NSURLSessionDataTask *)GET:(NSString *)URLString
                   parameters:(nullable id)parameters
                      success:(nullable void (^)(NSURLSessionDataTask *task, id _Nullable responseObject))success
                      failure:(nullable void (^)(NSURLSessionDataTask * _Nullable task, NSError *error))failure DEPRECATED_ATTRIBUTE;

- (nullable NSURLSessionDataTask *)GET:(NSString *)URLString
                            parameters:(nullable id)parameters
                              progress:(nullable void (^)(NSProgress *downloadProgress))downloadProgress
                               success:(nullable void (^)(NSURLSessionDataTask *task, id _Nullable responseObject))success
                               failure:(nullable void (^)(NSURLSessionDataTask * _Nullable task, NSError *error))failure;

- (nullable NSURLSessionDataTask *)HEAD:(NSString *)URLString
                    parameters:(nullable id)parameters
                       success:(nullable void (^)(NSURLSessionDataTask *task))success
                       failure:(nullable void (^)(NSURLSessionDataTask * _Nullable task, NSError *error))failure;

- (nullable NSURLSessionDataTask *)POST:(NSString *)URLString
                    parameters:(nullable id)parameters
                       success:(nullable void (^)(NSURLSessionDataTask *task, id _Nullable responseObject))success
                       failure:(nullable void (^)(NSURLSessionDataTask * _Nullable task, NSError *error))failure DEPRECATED_ATTRIBUTE;

- (nullable NSURLSessionDataTask *)POST:(NSString *)URLString
                             parameters:(nullable id)parameters
                               progress:(nullable void (^)(NSProgress *uploadProgress))uploadProgress
                                success:(nullable void (^)(NSURLSessionDataTask *task, id _Nullable responseObject))success
                                failure:(nullable void (^)(NSURLSessionDataTask * _Nullable task, NSError *error))failure;

- (nullable NSURLSessionDataTask *)POST:(NSString *)URLString
                    parameters:(nullable id)parameters
     constructingBodyWithBlock:(nullable void (^)(id <AFMultipartFormData> formData))block
                       success:(nullable void (^)(NSURLSessionDataTask *task, id _Nullable responseObject))success
                       failure:(nullable void (^)(NSURLSessionDataTask * _Nullable task, NSError *error))failure DEPRECATED_ATTRIBUTE;

- (nullable NSURLSessionDataTask *)POST:(NSString *)URLString
                             parameters:(nullable id)parameters
              constructingBodyWithBlock:(nullable void (^)(id <AFMultipartFormData> formData))block
                               progress:(nullable void (^)(NSProgress *uploadProgress))uploadProgress
                                success:(nullable void (^)(NSURLSessionDataTask *task, id _Nullable responseObject))success
                                failure:(nullable void (^)(NSURLSessionDataTask * _Nullable task, NSError *error))failure;

- (nullable NSURLSessionDataTask *)PUT:(NSString *)URLString
                   parameters:(nullable id)parameters
                      success:(nullable void (^)(NSURLSessionDataTask *task, id _Nullable responseObject))success
                      failure:(nullable void (^)(NSURLSessionDataTask * _Nullable task, NSError *error))failure;

- (nullable NSURLSessionDataTask *)PATCH:(NSString *)URLString
                     parameters:(nullable id)parameters
                        success:(nullable void (^)(NSURLSessionDataTask *task, id _Nullable responseObject))success
                        failure:(nullable void (^)(NSURLSessionDataTask * _Nullable task, NSError *error))failure;

- (nullable NSURLSessionDataTask *)DELETE:(NSString *)URLString
                      parameters:(nullable id)parameters
                         success:(nullable void (^)(NSURLSessionDataTask *task, id _Nullable responseObject))success
                         failure:(nullable void (^)(NSURLSessionDataTask * _Nullable task, NSError *error))failure;

@end

我们从头至尾慢慢看。首先可以看到AFHTTPSessionManager是继承于AFURLSessionManager这个类的，这点是非常重要的，后面我们要重点剖析这个类，它是整个框架的核心。然后可以看到其实现了两个协议NSSecureCoding和NSCopying。NSSecureCoding协议是什么意思呢？这个后面也需要说一说。
然后可以看到AFHTTPSessionManager的头文件暴露了三个属性基本路径 baseUrl，请求序列化器requestSerializer和响应序列化器responseSerializer。需要注意的是暴露出的baseUrl属性时readonly的；requestSerializer属性的类型是实现了AFURLRequestSerialization协议的AFHTTPRequestSerializer类。responseSerializer属性同理。
接下来暴露了三个初始化方法。第一个是类方法，后两个是需要传参的实例方法。
剩下的方法都是暴露出的HTTP相应请求方式的实例方法。若HTTP连接请求方式为GET,则调用相应的方法，并只需传入接口名称的字符串和请求参数，即可在block回调中获得请求结果。

再看看看AFHTTPSessionManager.m：

屏幕快照 2016-10-09 23.34.28.png

#import "AFHTTPSessionManager.h"
#import "AFURLRequestSerialization.h"
#import "AFURLResponseSerialization.h"

@interface AFHTTPSessionManager ()
@property (readwrite, nonatomic, strong) NSURL *baseURL;
@end


@implementation AFHTTPSessionManager
@dynamic responseSerializer;

#pragma mark - init method

+ (instancetype)manager {
    return [[[self class] alloc] initWithBaseURL:nil];
}

- (instancetype)init {
    return [self initWithBaseURL:nil];
}

- (instancetype)initWithBaseURL:(NSURL *)url {
    return [self initWithBaseURL:url sessionConfiguration:nil];
}

- (instancetype)initWithSessionConfiguration:(NSURLSessionConfiguration *)configuration {
    return [self initWithBaseURL:nil sessionConfiguration:configuration];
}

/*
 全能初始化方法：在其中通过configuration生成了AFHTTPSessionManager的实例对象，
 并初始化了baseURL,requestSerializer,responseSerializer属性
 需要注意的是session manager的对象是调用父类AFURLSessionManager的initWithSessionConfiguration:方法生成的，所以要研究下父类AFURLSessionManager
 */
- (instancetype)initWithBaseURL:(NSURL *)url
           sessionConfiguration:(NSURLSessionConfiguration *)configuration
{
    self = [super initWithSessionConfiguration:configuration];
    if (!self) {
        return nil;
    }

    // Ensure terminal slash for baseURL path, so that NSURL +URLWithString:relativeToURL: works as expected
    if ([[url path] length] > 0 && ![[url absoluteString] hasSuffix:@"/"]) {
        url = [url URLByAppendingPathComponent:@""];
    }

    self.baseURL = url;

    /*
     请求序列化器和响应序列化器进行初始化。请求序列化器是AFHTTPRequestSerializer类型，响应序列化器是AFJSONResponseSerializer类型
     */
    self.requestSerializer = [AFHTTPRequestSerializer serializer];
    self.responseSerializer = [AFJSONResponseSerializer serializer];

    return self;
}


#pragma mark - setter
/*
 疑问：为什么同是setter方法，requestSerializer和responseSerializer的实现不一样
*/
- (void)setRequestSerializer:(AFHTTPRequestSerializer <AFURLRequestSerialization> *)requestSerializer {
    NSParameterAssert(requestSerializer);

    _requestSerializer = requestSerializer;
}

- (void)setResponseSerializer:(AFHTTPResponseSerializer <AFURLResponseSerialization> *)responseSerializer {
    NSParameterAssert(responseSerializer);

    [super setResponseSerializer:responseSerializer];
}


#pragma mark - HTTP Request

- (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
{

    // 该方法的目的仍是生成dataTask实例，不过参数更丰富灵活。
    NSURLSessionDataTask *dataTask = [self dataTaskWithHTTPMethod:@"GET"
                                                        URLString:URLString
                                                       parameters:parameters
                                                   uploadProgress:nil
                                                 downloadProgress:downloadProgress
                                                          success:success
                                                          failure:failure];

    // 开启该dataTask
    [dataTask resume];

    return dataTask;
}



// HTTP请求的便利方法都是调用了下面这个参数更丰富的方法。所以该方法是核心。
/*
 该方法才是AFHTTPSessionManager类的核心方法。
 上面分别针对HTTP请求方法提供的GET/POST/HEAD/DELETE方法，只不过是以可辨别的方法名取代了method参数。
 在它们的内部其实都是指定和方法名相对应的method参数来调用该方法
 
 我们知道dataTask是由NSURLSession的dataTaskWithRequest:方法来生成的，那首先第一步我们需要生成request，然后以此生成dataTask。
 该方法内部正是分为如此两步骤：1.先生成请求request;2.再以request生成dataTask。
 */
- (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
{
    // 1.先调用requestSerializer的实例方法requestWithMethod:方法生成请求request。若生成request时出现错误，则回调该错误。
    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) {
            dispatch_async(self.completionQueue ?: dispatch_get_main_queue(), ^{
                failure(nil, serializationError);
            });
        }

        return nil;
    }

    
    // 2.将上面生成的request作为参数传入dataTaskWithRequest方法，生成dataTask实例对象
    /*
     捋一下：我们在最外面传入接口相对路径和参数，它在内部其实是调用了一个更全能的方法dataTaskWithHTTPMethod。而在它内部则首先根据请求方法参数、相对路径参数、请求参数参数先生成了一个请求对象（若生成该请求时失败，则直接执行失败回调，而不用再往下执行）
     */
    __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;
}


#pragma mark - description

- (NSString *)description {
    return [NSString stringWithFormat:@"<%@: %p, baseURL: %@, session: %@, operationQueue: %@>", NSStringFromClass([self class]), self, [self.baseURL absoluteString], self.session, self.operationQueue];
}



#pragma mark - NSSecureCoding

+ (BOOL)supportsSecureCoding {
    return YES;
}

- (instancetype)initWithCoder:(NSCoder *)decoder {
    NSURL *baseURL = [decoder decodeObjectOfClass:[NSURL class] forKey:NSStringFromSelector(@selector(baseURL))];
    NSURLSessionConfiguration *configuration = [decoder decodeObjectOfClass:[NSURLSessionConfiguration class] forKey:@"sessionConfiguration"];
    if (!configuration) {
        NSString *configurationIdentifier = [decoder decodeObjectOfClass:[NSString class] forKey:@"identifier"];
        if (configurationIdentifier) {
#if (defined(__IPHONE_OS_VERSION_MIN_REQUIRED) && __IPHONE_OS_VERSION_MIN_REQUIRED >= 80000) || (defined(__MAC_OS_X_VERSION_MIN_REQUIRED) && __MAC_OS_X_VERSION_MIN_REQUIRED >= 1100)
            configuration = [NSURLSessionConfiguration backgroundSessionConfigurationWithIdentifier:configurationIdentifier];
#else
            configuration = [NSURLSessionConfiguration backgroundSessionConfiguration:configurationIdentifier];
#endif
        }
    }

    self = [self initWithBaseURL:baseURL sessionConfiguration:configuration];
    if (!self) {
        return nil;
    }

    self.requestSerializer = [decoder decodeObjectOfClass:[AFHTTPRequestSerializer class] forKey:NSStringFromSelector(@selector(requestSerializer))];
    self.responseSerializer = [decoder decodeObjectOfClass:[AFHTTPResponseSerializer class] forKey:NSStringFromSelector(@selector(responseSerializer))];
    AFSecurityPolicy *decodedPolicy = [decoder decodeObjectOfClass:[AFSecurityPolicy class] forKey:NSStringFromSelector(@selector(securityPolicy))];
    if (decodedPolicy) {
        self.securityPolicy = decodedPolicy;
    }

    return self;
}

- (void)encodeWithCoder:(NSCoder *)coder {
    [super encodeWithCoder:coder];

    [coder encodeObject:self.baseURL forKey:NSStringFromSelector(@selector(baseURL))];
    if ([self.session.configuration conformsToProtocol:@protocol(NSCoding)]) {
        [coder encodeObject:self.session.configuration forKey:@"sessionConfiguration"];
    } else {
        [coder encodeObject:self.session.configuration.identifier forKey:@"identifier"];
    }
    [coder encodeObject:self.requestSerializer forKey:NSStringFromSelector(@selector(requestSerializer))];
    [coder encodeObject:self.responseSerializer forKey:NSStringFromSelector(@selector(responseSerializer))];
    [coder encodeObject:self.securityPolicy forKey:NSStringFromSelector(@selector(securityPolicy))];
}



#pragma mark - NSCopying

- (instancetype)copyWithZone:(NSZone *)zone {
    AFHTTPSessionManager *HTTPClient = [[[self class] allocWithZone:zone] initWithBaseURL:self.baseURL sessionConfiguration:self.session.configuration];

    HTTPClient.requestSerializer = [self.requestSerializer copyWithZone:zone];
    HTTPClient.responseSerializer = [self.responseSerializer copyWithZone:zone];
    HTTPClient.securityPolicy = [self.securityPolicy copyWithZone:zone];
    return HTTPClient;
}

@end

同样，我们也是从头至尾一行一行往下看。
首先在Extension中定义了一个私有属性baseUrl，与头文件中暴露给外部的baseUrl属性不同的，该私有属性baseUrl是readwrite的。

紧接着就是几个初始化方法的实现了。可以看到，所有初始化方法在内部都是直接或间接调用initWithBaseURL:sessionConfiguration:这个全能初始化方法。这个初始化方法内部首先调用了父类(AFURLSessionManager)的同名初始化方法，这一步几乎完成了所有基础而核心的东西。然后初始化了三个属性，requestSerializer默认初始化为AFHTTPRequestSerializer类型的，responseSerializer默认初始化为AFJSONResponseSerializer类型的。

接着就是请求序列化器和响应序列化器两个属性的setter方法，疑问：为什么同是属性的setter方法，一个是直接将其值赋给变量，而另一个要调用父类的setter方法呢，父类的setter方法也同样是将其值赋给变量呀？

然后，我们就来到了核心部分——HTTP请求方式对应的方法。可以看到这些方法内部其实都统一调用了一个方法：

- (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
{
      // 1.先调用requestSerializer的实例方法requestWithMethod:方法生成请求request。若生成request时出现错误，则回调该错误。

      // 2.将上面生成的request作为参数传入dataTaskWithRequest方法，生成dataTask实例对象
}

该方法相较于HTTP请求方式对应的方法参数更丰富，更“全能”。那些暴露给开发者使用的HTTP方法都是对其的一层包装。以方法名称的不同，便可以区分不同的请求方式了，而不要HTTPMethod参数了。总之，暴露给开发者的那些HTTP对应的以GET/POST/PUT等开头的方法，可以称之为“便利方法”。

该方法主要有两部分，第一部分是先调用requestSerializer的实例方法，传入请求方式method，请求地址URLString，请求参数parameters，返回request。若生成request时出现错误，则通过block回调该错误，不再往下执行。关于该方法的具体实现，我们放到后面讲到序列化时专门分析，这里只理清脉络。

第二部分是调用了在父类中实现的方法，传入请求参数request，生成dataTask实例对象。
这里就对应了我们一开头的预想：先由各参数生成一个request，再由该request生成session task。思路很简单，但实际实现却比较复杂，值得好好阅读。在这我们暂时不细说它们的内部实现，等到说到对应类的时候再细说。

上面的代码里使用了几个有关NSURL的方法，有必要说明一下。

@property (nullable, readonly, copy) NSString *absoluteString;
- (nullable instancetype)initWithString:(NSString *)URLString relativeToURL:(nullable NSURL *)baseURL NS_DESIGNATED_INITIALIZER;
+ (nullable instancetype)URLWithString:(NSString *)URLString relativeToURL:(nullable NSURL *)baseURL;

absoluteString属性可以将NSUR转换为NSString；而下面两个方法却是NSURL的初始化方法，将NSString转换为NSURL了。这几个方法涉及到NSURL和NSString的互相转换。
更多详情请阅读：NSURL /NSURLComponents

一开头我们就留意到了AFHTTPSessionManager类实现了NSSecureCoding协议，该协议其实和NSCoding协议一个意思，都是为了实现数据持久化而归档解档，不过更安全。更多详情请阅读：使用NSSecureCoding协议进行对象编解码

结尾

至此，AFHTTPSessionManager这个类差不多说完了，下篇主要阅读其父类AFURLSessionManager。

AFNetworking源码阅读1——脉络

前言

准备

源码

——AFHTTPSessionManager——

结尾

相关文章

网友评论

延伸阅读

深度阅读

栏目导航

热点阅读

iOS开发

网络相关

AFNetworking

iOS 开发

iOS Developer

AFN源码