AFNetworking 源碼閱讀筆記（三）


AFNetworking 是 Objective-C 中用于網(wǎng)絡(luò)請(qǐng)求的第三方框架，我們一般使用它來封裝網(wǎng)絡(luò)請(qǐng)求，這篇文章記錄了閱讀 AFNetworking(Version 3.1.0) 源碼的筆記，簡(jiǎn)單的研究了它的實(shí)現(xiàn)細(xì)節(jié)。

AFURLRequestSerialization

AFURLRequestSerialization 只是個(gè)協(xié)議，其內(nèi)部提供了一個(gè)方法用以序列化請(qǐng)求數(shù)據(jù)。

@protocol AFURLRequestSerialization <NSObject, NSSecureCoding, NSCopying>

- (nullable NSURLRequest *)requestBySerializingRequest:(NSURLRequest *)request
                               withParameters:(nullable id)parameters
                                        error:(NSError * _Nullable __autoreleasing *)error NS_SWIFT_NOTHROW;

@end

同時(shí)也要遵循 NSObject、NSSecureCoding 和 NSCopying 這三個(gè)協(xié)議，實(shí)現(xiàn)安全編碼、拷貝等。

在 AFNetworking 內(nèi)部里遵循這個(gè)協(xié)議并返回特定的數(shù)據(jù)類型有 3 種，分別是：

  • AFHTTPRequestSerializer
  • AFJSONRequestSerializer
  • AFPropertyListRequestSerializer

一般來說請(qǐng)求都會(huì)按 key=value 的方式帶上各種參數(shù)，GET 方法參數(shù)會(huì)直接加在 URL 上，POST 方法放在 body 上，而 NSURLRequest 沒有直接對(duì)這個(gè)參數(shù)的解析，所以都是拼好字符串再往上添加的。但 AFURLRequestSerialization 提供了接口，讓參數(shù)可以是 NSDictionary, NSArray, NSSet 這些類型，再由內(nèi)部解析成字符串后賦給 NSURLRequest。因?yàn)?AFHTTPRequestSerializer 為 AFHTTPSessionManager 創(chuàng)建時(shí)默認(rèn)的 requestSerializer，下面具體過程以 AFHTTPRequestSerializer 的相關(guān)方法為例。

requestWithMethod 方法

requestWithMethod:方法是 AFHTTPSessionManager 在創(chuàng)建 dataTask 前用來創(chuàng)建 request 的，方法具體實(shí)現(xiàn)如下：

- (NSMutableURLRequest *)requestWithMethod:(NSString *)method
                                 URLString:(NSString *)URLString
                                parameters:(id)parameters
                                     error:(NSError *__autoreleasing *)error
{
    // 進(jìn)行參數(shù)斷言
    NSParameterAssert(method);
    NSParameterAssert(URLString);

    NSURL *url = [NSURL URLWithString:URLString];

    NSParameterAssert(url);

    // 使用url構(gòu)建并初始化NSMutableURLRequest，然后設(shè)置HTTPMethod
    NSMutableURLRequest *mutableRequest = [[NSMutableURLRequest alloc] initWithURL:url];
    mutableRequest.HTTPMethod = method;

    // 給NSMutableURLRequest自帶的屬性賦值
    // 然后通過判斷mutableObservedChangedKeyPaths（NSMutableSet）中是否有這個(gè)keyPath，來設(shè)定mutableRequest對(duì)應(yīng)的keyPath值
    // AFHTTPRequestSerializerObservedKeyPaths這個(gè)數(shù)組里的屬性是固定的，且在 init 方法里全都 KVO 了
    /**
     *  當(dāng) AFHTTPRequestSerializerObserverContext 中有 value 變化了(且變化后的新值不為 NSNull null)，就會(huì)響應(yīng) observerValueForKeyPath 這個(gè)函數(shù)，從而mutableObservedChangedKeyPaths就會(huì)添加這個(gè) keyPath
     */
    for (NSString *keyPath in AFHTTPRequestSerializerObservedKeyPaths()) {
        if ([self.mutableObservedChangedKeyPaths containsObject:keyPath]) {
            [mutableRequest setValue:[self valueForKeyPath:keyPath] forKey:keyPath];
        }
    }

    // 將傳入的parameters進(jìn)行編碼，并添加到request中
    mutableRequest = [[self requestBySerializingRequest:mutableRequest withParameters:parameters error:error] mutableCopy];

 return mutableRequest;
}

主要是使用指定的 HTTP method 和 URLString 來構(gòu)建一個(gè) NSMutableURLRequest 對(duì)象實(shí)例，如果 method 是 GET、HEAD、DELETE，那么 parameter 將會(huì)被用來構(gòu)建一個(gè)基于 url 編碼的查詢字符串，并且這個(gè)字符串會(huì)直接加到 request 的 url 后面。對(duì)于其他的Method，比如POST/PUT，會(huì)根據(jù) parameterEncoding 屬性進(jìn)行編碼，而后加到 request 的 http body 上，這里具體是調(diào)用 requestBySerializingRequest: 這個(gè)方法。

requestBySerializingRequest 方法

requestBySerializingRequest: 方法做了以下事情：

  • 1.設(shè)置 HTTP 的頭部
  • 2.構(gòu)建查詢字符串
  • 3.拼接參數(shù)
  • 4.將 query 設(shè)置到 http body 上
- (NSURLRequest *)requestBySerializingRequest:(NSURLRequest *)request
                               withParameters:(id)parameters
                                        error:(NSError *__autoreleasing *)error
{
    NSParameterAssert(request);

    NSMutableURLRequest *mutableRequest = [request mutableCopy];

    // 1.設(shè)置request的http header field
    [self.HTTPRequestHeaders enumerateKeysAndObjectsUsingBlock:^(id field, id value, BOOL * __unused stop) {
        if (![request valueForHTTPHeaderField:field]) {
            [mutableRequest setValue:value forHTTPHeaderField:field];
        }
    }];

    
    // 2.構(gòu)建查詢字符串 query
    NSString *query = nil;
    if (parameters) {
        // 第一種，自定義了queryStringSerialization
        if (self.queryStringSerialization) {
            NSError *serializationError;
            query = self.queryStringSerialization(request, parameters, &serializationError);

            if (serializationError) {
                if (error) {
                    *error = serializationError;
                }

                return nil;
            }
        } else {
            // 第二種，使用AFQueryStringFromParameters() 方法
            switch (self.queryStringSerializationStyle) {
                case AFHTTPRequestQueryStringDefaultStyle:
                    query = AFQueryStringFromParameters(parameters);
                    break;
            }
        }
    }
    // 3.拼接參數(shù)
    // 這幾個(gè)method的quey是拼接到url后面的。而POST、PUT是把query拼接到http body中的。
    // 判斷該request中是否包含了GET、HEAD、DELETE
    if ([self.HTTPMethodsEncodingParametersInURI containsObject:[[request HTTPMethod] uppercaseString]]) {
        if (query && query.length > 0) {
            // 將query合并到mutbleRequest的query url 上
            mutableRequest.URL = [NSURL URLWithString:[[mutableRequest.URL absoluteString] stringByAppendingFormat:mutableRequest.URL.query ? @"&%@" : @"?%@", query]];
        }
    } else {
        // 4.將query設(shè)置到http body上
        if (!query) {
            query = @"";
        }
        if (![mutableRequest valueForHTTPHeaderField:@"Content-Type"]) {
            [mutableRequest setValue:@"application/x-www-form-urlencoded" forHTTPHeaderField:@"Content-Type"];
        }
        [mutableRequest setHTTPBody:[query dataUsingEncoding:self.stringEncoding]];
    }

    return mutableRequest;
}

其中在第二部構(gòu)建查詢字符串時(shí)，提供了一個(gè)queryStringSerialization block，可以自定義這個(gè)構(gòu)建方法。當(dāng)然如果沒設(shè)置這個(gè) block，就會(huì)使用默認(rèn)的 AFHTTPRequestQueryStringDefaultStyle case，調(diào)用 AFQueryStringFromParameters()方法來構(gòu)建字符串。

AFQueryStringFromParameters 方法

這一步主要是將參數(shù)用 & 連接起來，其核心方法有三個(gè)：

FOUNDATION_EXPORT NSArray * AFQueryStringPairsFromDictionary(NSDictionary *dictionary);
FOUNDATION_EXPORT NSArray * AFQueryStringPairsFromKeyAndValue(NSString *key, id value);

// 構(gòu)建字符串 用&連接
NSString * AFQueryStringFromParameters(NSDictionary *parameters) {
    NSMutableArray *mutablePairs = [NSMutableArray array];
    for (AFQueryStringPair *pair in AFQueryStringPairsFromDictionary(parameters)) {
        // URLEncoded 處理
        [mutablePairs addObject:[pair URLEncodedStringValue]];
    }

    return [mutablePairs componentsJoinedByString:@"&"];
}

NSArray * AFQueryStringPairsFromDictionary(NSDictionary *dictionary) {
    return AFQueryStringPairsFromKeyAndValue(nil, dictionary);
}

NSArray * AFQueryStringPairsFromKeyAndValue(NSString *key, id value) {
    NSMutableArray *mutableQueryStringComponents = [NSMutableArray array];

    // 根據(jù)需要排列的對(duì)象的description來進(jìn)行升序排列，并且selector使用的是compare:
    // 因?yàn)閷?duì)象的description返回的是NSString，所以此處compare:使用的是NSString的compare函數(shù)
    // 即@[@"foo", @"bar", @"bae"] ----> @[@"bae", @"bar",@"foo"]
    NSSortDescriptor *sortDescriptor = [NSSortDescriptor sortDescriptorWithKey:@"description" ascending:YES selector:@selector(compare:)];

    // 判斷 value 類型
    // 遞歸調(diào)用并解析
    // 因?yàn)椴荒鼙ＷCNSDictionary的value中存放的是一個(gè)NSArray、NSSet
    if ([value isKindOfClass:[NSDictionary class]]) {
        NSDictionary *dictionary = value;
        // Sort dictionary keys to ensure consistent ordering in query string, which is important when deserializing potentially ambiguous sequences, such as an array of dictionaries
        for (id nestedKey in [dictionary.allKeys sortedArrayUsingDescriptors:@[ sortDescriptor ]]) {
            id nestedValue = dictionary[nestedKey];
            if (nestedValue) {
                [mutableQueryStringComponents addObjectsFromArray:AFQueryStringPairsFromKeyAndValue((key ? [NSString stringWithFormat:@"%@[%@]", key, nestedKey] : nestedKey), nestedValue)];
            }
        }
    } else if ([value isKindOfClass:[NSArray class]]) {
        NSArray *array = value;
        for (id nestedValue in array) {
            [mutableQueryStringComponents addObjectsFromArray:AFQueryStringPairsFromKeyAndValue([NSString stringWithFormat:@"%@[]", key], nestedValue)];
        }
    } else if ([value isKindOfClass:[NSSet class]]) {
        NSSet *set = value;
        for (id obj in [set sortedArrayUsingDescriptors:@[ sortDescriptor ]]) {
            [mutableQueryStringComponents addObjectsFromArray:AFQueryStringPairsFromKeyAndValue(key, obj)];
        }
    } else {
        // 結(jié)束遞歸 最后一個(gè) value 為 NSString
        [mutableQueryStringComponents addObject:[[AFQueryStringPair alloc] initWithField:key value:value]];
    }

    return mutableQueryStringComponents;
}

需要注意的是在 AFQueryStringPairsFromKeyAndValue() 方法中是采用遞歸調(diào)用解析參數(shù)類型的，直到最后一個(gè) value 的類型為 NSString 結(jié)束遞歸，在此同時(shí)也將一個(gè) AFQueryStringPair 對(duì)象添加到數(shù)組中。來看一下這個(gè)對(duì)象的結(jié)構(gòu)：

@interface AFQueryStringPair : NSObject
// 為 key
@property (readwrite, nonatomic, strong) id field;
// 為 value
@property (readwrite, nonatomic, strong) id value;

- (instancetype)initWithField:(id)field value:(id)value;

- (NSString *)URLEncodedStringValue;
@end

可以看出這是個(gè)專門存放 key 和 value 的類，其提供了一個(gè)初始化方法和一個(gè)序列化方法。

- (NSString *)URLEncodedStringValue {
    if (!self.value || [self.value isEqual:[NSNull null]]) {
        return AFPercentEscapedStringFromString([self.field description]);
    } else {
        return [NSString stringWithFormat:@"%@=%@", AFPercentEscapedStringFromString([self.field description]), AFPercentEscapedStringFromString([self.value description])];
    }
}

通過序列化方法將 key 和 value 轉(zhuǎn)化成 key=value 這種形式。

AFURLResponseSerialization

AFURLResponseSerialization 只是個(gè)協(xié)議，其內(nèi)部提供了一個(gè)方法用以序列化返回?cái)?shù)據(jù)。

@protocol AFURLResponseSerialization <NSObject, NSSecureCoding, NSCopying>

- (nullable id)responseObjectForResponse:(nullable NSURLResponse *)response
                           data:(nullable NSData *)data
                          error:(NSError * _Nullable __autoreleasing *)error NS_SWIFT_NOTHROW;

@end

同時(shí)也要遵循 NSObject、NSSecureCoding 和 NSCopying 這三個(gè)協(xié)議，實(shí)現(xiàn)安全編碼、拷貝等。

在 AFNetworking 內(nèi)部里遵循這個(gè)協(xié)議并返回特定的數(shù)據(jù)類型有 7 種，分別是：

  • AFHTTPResponseSerializer
  • AFJSONResponseSerializer
  • AFXMLParserResponseSerializer
  • AFXMLDocumentResponseSerializer
  • AFPropertyListResponseSerializer
  • AFImageResponseSerializer
  • AFCompoundResponseSerializer

因?yàn)?AFJSONResponseSerializer 為 AFHTTPSessionManager 創(chuàng)建時(shí)默認(rèn)的 responseSerializer，這里以 AFJSONResponseSerializer 的相關(guān)方法為例。

responseObjectForResponse 方法

responseObjectForResponse: 方法是 AFURLResponseSerialization 協(xié)議的方法，這里以 AFJSONResponseSerializer 所實(shí)現(xiàn)的 responseObjectForResponse: 方法為例：

- (id)responseObjectForResponse:(NSURLResponse *)response
                           data:(NSData *)data
                          error:(NSError *__autoreleasing *)error
{
    // 驗(yàn)證請(qǐng)求的有效性
    if (![self validateResponse:(NSHTTPURLResponse *)response data:data error:error]) {
        if (!error || AFErrorOrUnderlyingErrorHasCodeInDomain(*error, NSURLErrorCannotDecodeContentData, AFURLResponseSerializationErrorDomain)) {
            return nil;
        }
    }
    // 解決一個(gè)空格引起的 bug
    id responseObject = nil;
    NSError *serializationError = nil;
    // Workaround for behavior of Rails to return a single space for `head :ok` (a workaround for a bug in Safari), which is not interpreted as valid input by NSJSONSerialization.
    // See https://github.com/rails/rails/issues/1742
    BOOL isSpace = [data isEqualToData:[NSData dataWithBytes:" " length:1]];
    // 序列化 JSON
    if (data.length > 0 && !isSpace) {
        responseObject = [NSJSONSerialization JSONObjectWithData:data options:self.readingOptions error:&serializationError];
    } else {
        return nil;
    }
    // 移除 JSON 中的 null
    if (self.removesKeysWithNullValues && responseObject) {
        responseObject = AFJSONObjectByRemovingKeysWithNullValues(responseObject, self.readingOptions);
    }
    if (error) {
        *error = AFErrorWithUnderlyingError(serializationError, *error);
    }
    return responseObject;
}

可見其核心就是序列化 JSON，將 responseObject 轉(zhuǎn)化為 JSON 格式的數(shù)據(jù)。同理，在 AFHTTPResponseSerializer 中的 responseObjectForResponse: 方法就是返回原生的 HTTP 數(shù)據(jù)，如下：

- (id)responseObjectForResponse:(NSURLResponse *)response
                           data:(NSData *)data
                          error:(NSError *__autoreleasing *)error
{
    [self validateResponse:(NSHTTPURLResponse *)response data:data error:error];

    return data;
}

那么相應(yīng)的剩余的都類似，區(qū)別只是 responseObjectForResponse: 方法的實(shí)現(xiàn)不同。

總結(jié)

AFNetworking 源碼閱讀筆記就記錄到這里了，剩余的類都在源碼注釋里有注釋，感興趣的可以看看，這里就不細(xì)說了。

Reference

AFNetworking
AFNetworking 概述

最后編輯于 ：
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成，瀏覽時(shí)請(qǐng)結(jié)合常識(shí)與多方信息審慎甄別。
平臺(tái)聲明：文章內(nèi)容（如有圖片或視頻亦包括在內(nèi)）由作者上傳并發(fā)布，文章內(nèi)容僅代表作者本人觀點(diǎn)，簡(jiǎn)書系信息發(fā)布平臺(tái)，僅提供信息存儲(chǔ)服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容