最近在開發(fā)SDK時有上傳圖片的需求筋粗，這個需求用AF的話當(dāng)然非常簡單俭尖，多添加一句代碼就可以搞定低散。但為避免第三方耦合并沒有使用AFNetworking诊县，這就需要自己走完上傳圖片的全部流程，所以仔細(xì)研究了一下AFNetworking的相關(guān)源碼检号，梳理了整個流程腌歉，它的流程大致是這樣的：

AF上傳圖片流程

看著有點(diǎn)眼花眼花繚亂是吧? 沒關(guān)系，接著往下看齐苛，看完這篇文章翘盖，你也可以自己封裝一套圖片上傳網(wǎng)絡(luò)工具類。

目錄

• 基本原理
• 請求方式
• 請求管理工具類AFStreamingMultipartFormData
• InputStream的子類AFMultipartBodyStream
• 參數(shù)的封裝AFHTTPBodyPart
• 具體實(shí)現(xiàn)
  • 創(chuàng)建NSMutableURLRequest并設(shè)置請求方式為POST
  • 自定義HTTPBodyStream
  • 對request進(jìn)行參數(shù)設(shè)置
  • 通過NSURLSession的uploadTaskWithStreamedRequest:方法發(fā)起Post請求

基本原理

首先我們來看一下AF中上傳圖片的方法長什么樣：

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

請求方式

這個方法和AF其他正常的POST請求一樣凹蜂，都是基于NSURLSession馍驯，通過自定義的NSMutableURLRequest發(fā)起網(wǎng)絡(luò)請求阁危。不過在這個方法中，并沒有使用常用的dataTaskWithRequest方法汰瘫，而使用的是uploadTaskWithStreamedRequest狂打。

請求管理工具類AFStreamingMultipartFormData

在整個圖片上傳請求過程中，核心點(diǎn)在于為網(wǎng)絡(luò)請求NSURLReqeust進(jìn)行參數(shù)設(shè)定混弥。為此趴乡，AFNetworking封裝了一個工具類AFStreamingMultipartFormData，在這個類中完成對NSURLRequst除HTTPMethod外所有參數(shù)的設(shè)定剑逃。

InputStream的子類AFMultipartBodyStream

圖片上傳需要封裝參數(shù)和圖片數(shù)據(jù)浙宜，每一個參數(shù)的鍵值對都會封裝成一個AFHTTPBodyPart模型，而AFMultipartBodyStream就負(fù)責(zé)對AFHTTPBodyPart進(jìn)行管理蛹磺，它本身同時也是自定義的HTTPBodyStream。

參數(shù)的封裝AFHTTPBodyPart

AFHTTPBodyPart是對POST請求參數(shù)和數(shù)據(jù)的封裝同仆，并實(shí)現(xiàn)了將請求數(shù)據(jù)轉(zhuǎn)換為InputStream的方法萤捆。

具體實(shí)現(xiàn)

上面的原理講起來有點(diǎn)兒抽象，下面從圖片上傳的完整實(shí)現(xiàn)中來了解整個過程俗批。

創(chuàng)建NSMutableURLRequest并設(shè)置請求方式為POST

這一步就是常規(guī)步驟俗或，代碼如下：

NSMutableURLRequest *request = [[NSMutableURLRequest alloc]initWithURL:[NSURL URLWithString:api] cachePolicy:NSURLRequestUseProtocolCachePolicy timeoutInterval:10.0f];
[request setHTTPMethod:@"POST"];

自定義HTTPBodyStream

首先，需要創(chuàng)建一個工具類來管理剛剛創(chuàng)建的request：

__block AFStreamingMultipartFormData *formData = [[AFStreamingMultipartFormData alloc] initWithURLRequest:request stringEncoding:NSUTF8StringEncoding];

接下來岁忘，需要將所有參數(shù)的鍵值對轉(zhuǎn)換為AFHTTPBodyPart辛慰，這里要分兩種情況：普通參數(shù)和圖片相關(guān)參數(shù)。

普通參數(shù)

普通參數(shù)的轉(zhuǎn)換直接遍歷即可干像，將每一個鍵值對都轉(zhuǎn)換為AFHTTPBodyPart帅腌，不過AFNetworking在這里將鍵值對又封閉了一個模型AFQueryStringPair，所以你看到的是這樣的：

if (parameters) {
    for (AFQueryStringPair *pair in AFQueryStringPairsFromDictionary(parameters)) {
        NSData *data = nil;
        if ([pair.value isKindOfClass:[NSData class]]) {
            data = pair.value;
        } else if ([pair.value isEqual:[NSNull null]]) {
            data = [NSData data];
        } else {
            data = [[pair.value description] dataUsingEncoding:self.stringEncoding];
        }

        if (data) {
            [formData appendPartWithFormData:data name:[pair.field description]];
        }
    }
}

不過個人覺得完全沒有必要麻汰，不封裝模型這樣寫可以達(dá)到同樣的效果：

if (parameters) {
    [parameters enumerateKeysAndObjectsUsingBlock:^(id  _Nonnull key, id  _Nonnull obj, BOOL * _Nonnull stop) {
        NSData *data = nil;
        if ([obj isKindOfClass:[NSData class]]) {
            data = obj;
        }else if ([obj isKindOfClass:[NSNull class]]) {
            data = [NSData data];
        }else {
            data = [[obj description] dataUsingEncoding:NSUTF8StringEncoding];
        }
        if (data) {
            [formData appendPartWithFormData:data name:[key description]];
        }
    }];
}

在上面的方法中速客，調(diào)用了-appendPartWithFormData:name:方法，這個方法的作用有兩個：拼裝Header字典和封裝AFHTTPBodyPart模型：

- (void)appendPartWithFormData:(NSData *)data
                          name:(NSString *)name {
    NSParameterAssert(name);
    // 拼裝Header字典
    NSMutableDictionary *mutableHeaders = [NSMutableDictionary dictionary];
    [mutableHeaders setValue:[NSString stringWithFormat:@"form-data; name=\"%@\"", name] forKey:@"Content-Disposition"];

    [self appendPartWithHeaders:mutableHeaders body:data];
}

- (void)appendPartWithHeaders:(NSDictionary *)headers
                         body:(NSData *)body
{
    NSParameterAssert(body);
    // 創(chuàng)建模型
    AFHTTPBodyPart *bodyPart = [[AFHTTPBodyPart alloc] init];
    bodyPart.stringEncoding = self.stringEncoding;
    bodyPart.headers = headers;
    bodyPart.boundary = self.boundary;
    bodyPart.bodyContentLength = [body length];
    bodyPart.body = body;
    // bodyStream管理bodyPart
    [self.bodyStream appendHTTPBodyPart:bodyPart];
}

接下來就是在AFMultipartBodyStream中管理生成的多個AFHTTPBodyPart五鲫。

圖片相關(guān)參數(shù)

如果只需要單一的上傳圖片的需求溺职，直接將圖片的數(shù)據(jù)、名稱位喂、類型等作為方法的參數(shù)傳進(jìn)來就可以浪耘，實(shí)現(xiàn)起來除Header的拼裝有差異外幾乎和上面正常參數(shù)一樣。但AF為了可擴(kuò)展性塑崖，添加了一個Block和代理七冲，方便除NSData以外諸如FileURL、InputStream等上傳方式弃舒。

這個Block長這個樣子

void (^block)(id <AFMultipartFormData> formData)

Block傳入的參數(shù)是除圖片參數(shù)的鍵值對外的全部轉(zhuǎn)換完成后的AFStreamingMultipartFormData癞埠，遵從AFMultipartFormData協(xié)議状原。在以上正常參數(shù)轉(zhuǎn)換完之后調(diào)用，Block的實(shí)現(xiàn)為用戶自定義苗踪，用戶可以選擇適合的方式添加參數(shù)上傳數(shù)據(jù)颠区，這里只講圖片的NSData方式上傳：

[formData appendPartWithFileData:imageData name:key fileName:[NSString stringWithFormat:@"%@.jpg",key] mimeType:@"image/jpeg"];

然后同樣是拼接Header

- (void)appendPartWithFileData:(NSData *)data
                          name:(NSString *)name
                      fileName:(NSString *)fileName
                      mimeType:(NSString *)mimeType {
    NSParameterAssert(name);
    NSParameterAssert(fileName);
    NSParameterAssert(mimeType);
    
    NSMutableDictionary *mutableHeaders = [NSMutableDictionary dictionary];
    [mutableHeaders setValue:[NSString stringWithFormat:@"form-data; name=\"%@\"; filename=\"%@\"", name, fileName] forKey:@"Content-Disposition"];
    [mutableHeaders setValue:mimeType forKey:@"Content-Type"];
    
    [self appendPartWithHeaders:mutableHeaders body:data];
}

然后是轉(zhuǎn)換成AFHTTPBodyPart，由AFMultipartBodyStream進(jìn)行管理通铲。

- (void)appendPartWithHeaders:(NSDictionary *)headers
                         body:(NSData *)body {
    NSParameterAssert(body);
    
    AFHTTPBodyPart *bodyPart = [[AFHTTPBodyPart alloc] init];
    bodyPart.stringEncoding = self.stringEncoding;
    bodyPart.headers = headers;
    bodyPart.boundary = self.boundary;
    bodyPart.bodyContentLength = [body length];
    bodyPart.body = body;
    
    [self.bodyStream appendHTTPBodyPart:bodyPart];
}

AFMultipartBodyStream管理并轉(zhuǎn)換AFHTTPBodyPart內(nèi)部數(shù)據(jù)的具體實(shí)現(xiàn)

每生成一個AFHTTPBodyPart它都會存入AFMultipartBodyStream的HTTPBodyParts這個可變數(shù)組中毕莱，方便后面對數(shù)據(jù)進(jìn)行處理。

而AFMultipartBodyStream的對數(shù)據(jù)轉(zhuǎn)換要從它的父類NSInputStream說起颅夺，NSInputStream是NSStream的子類朋截，方便我們以流文件的形式讀取數(shù)據(jù)。在AF中吧黄，它重寫了父類的-read:maxLength:方法部服，在這個方法里進(jìn)行數(shù)據(jù)的處理。

- (NSInteger)read:(uint8_t *)buffer
        maxLength:(NSUInteger)length {
    if ([self streamStatus] == NSStreamStatusClosed) {
        return 0;
    }
    
    NSInteger totalNumberOfBytesRead = 0;
    
    while ((NSUInteger)totalNumberOfBytesRead < MIN(length, self.numberOfBytesInPacket)) {
        if (!self.currentHTTPBodyPart || ![self.currentHTTPBodyPart hasBytesAvailable]) {
            if (!(self.currentHTTPBodyPart = [self.HTTPBodyPartEnumerator nextObject])) {
                break;
            }
        } else {
            NSUInteger maxLength = MIN(length, self.numberOfBytesInPacket) - (NSUInteger)totalNumberOfBytesRead;
            NSInteger numberOfBytesRead = [self.currentHTTPBodyPart read:&buffer[totalNumberOfBytesRead] maxLength:maxLength];
            if (numberOfBytesRead == -1) {
//                self.streamError = self.currentHTTPBodyPart.inputStream.streamError;
                break;
            } else {
                totalNumberOfBytesRead += numberOfBytesRead;
                
                if (self.delay > 0.0f) {
                    [NSThread sleepForTimeInterval:self.delay];
                }
            }
        }
    }
    
    return totalNumberOfBytesRead;
}

上面這個方法核心就是把bodyPart挨個取出來進(jìn)行讀取數(shù)據(jù)操作拗慨，bodyPart讀取數(shù)據(jù)的操作是在其內(nèi)部實(shí)現(xiàn)的：

- (NSInteger)read:(uint8_t *)buffer
        maxLength:(NSUInteger)length {
    NSInteger totalNumberOfBytesRead = 0;
    
    if (_phase == AFEncapsulationBoundaryPhase) {
        NSData *encapsulationBoundaryData = [([self hasInitialBoundary] ? AFMultipartFormInitialBoundary(self.boundary) : AFMultipartFormEncapsulationBoundary(self.boundary)) dataUsingEncoding:self.stringEncoding];
        totalNumberOfBytesRead += [self readData:encapsulationBoundaryData intoBuffer:&buffer[totalNumberOfBytesRead] maxLength:(length - (NSUInteger)totalNumberOfBytesRead)];
    }
    
    if (_phase == AFHeaderPhase) {
        NSData *headersData = [[self stringForHeaders] dataUsingEncoding:self.stringEncoding];
        totalNumberOfBytesRead += [self readData:headersData intoBuffer:&buffer[totalNumberOfBytesRead] maxLength:(length - (NSUInteger)totalNumberOfBytesRead)];
    }
    
    if (_phase == AFBodyPhase) {
        NSInteger numberOfBytesRead = 0;
        
        numberOfBytesRead = [self.inputStream read:&buffer[totalNumberOfBytesRead] maxLength:(length - (NSUInteger)totalNumberOfBytesRead)];
        if (numberOfBytesRead == -1) {
            return -1;
        } else {
            totalNumberOfBytesRead += numberOfBytesRead;
            
            if ([self.inputStream streamStatus] >= NSStreamStatusAtEnd) {
                [self transitionToNextPhase];
            }
        }
    }
    
    if (_phase == AFFinalBoundaryPhase) {
        NSData *closingBoundaryData = ([self hasFinalBoundary] ? [AFMultipartFormFinalBoundary(self.boundary) dataUsingEncoding:self.stringEncoding] : [NSData data]);
        totalNumberOfBytesRead += [self readData:closingBoundaryData intoBuffer:&buffer[totalNumberOfBytesRead] maxLength:(length - (NSUInteger)totalNumberOfBytesRead)];
    }
    
    return totalNumberOfBytesRead;
}

- (NSInteger)readData:(NSData *)data
           intoBuffer:(uint8_t *)buffer
            maxLength:(NSUInteger)length {
    NSRange range = NSMakeRange((NSUInteger)_phaseReadOffset, MIN([data length] - ((NSUInteger)_phaseReadOffset), length));
    [data getBytes:buffer range:range];
    
    _phaseReadOffset += range.length;
    
    if (((NSUInteger)_phaseReadOffset) >= [data length]) {
        [self transitionToNextPhase];
    }
    
    return (NSInteger)range.length;
}

- (BOOL)transitionToNextPhase {
    if (![[NSThread currentThread] isMainThread]) {
        dispatch_sync(dispatch_get_main_queue(), ^{
            [self transitionToNextPhase];
        });
        return YES;
    }
    
    switch (_phase) {
        case AFEncapsulationBoundaryPhase:
            _phase = AFHeaderPhase;
            break;
        case AFHeaderPhase:
            [self.inputStream scheduleInRunLoop:[NSRunLoop currentRunLoop] forMode:NSRunLoopCommonModes];
            [self.inputStream open];
            _phase = AFBodyPhase;
            break;
        case AFBodyPhase:
            [self.inputStream close];
            _phase = AFFinalBoundaryPhase;
            break;
        case AFFinalBoundaryPhase:
        default:
            _phase = AFEncapsulationBoundaryPhase;
            break;
    }
    _phaseReadOffset = 0;
    
    return YES;
}

上面三個方法即是bodyPart對數(shù)據(jù)讀取的全部實(shí)現(xiàn)廓八，看著比較復(fù)雜，梳理下來其實(shí)它的邏輯也比較清晰赵抢。簡單來說就是把數(shù)據(jù)讀取分成幾個階段剧蹂，不同階段進(jìn)行相應(yīng)操作，其最核心的是這兩句：

[self.inputStream scheduleInRunLoop:[NSRunLoop currentRunLoop] forMode:NSRunLoopCommonModes];
[self.inputStream open];

這兩句不僅僅是把輸入流加入運(yùn)行循環(huán)烦却，開始讀取數(shù)據(jù)宠叼，這里還用了一個懶加載，重寫了inputStream的getter方法其爵，在這個方法里進(jìn)行了inputStream的初始化冒冬，即數(shù)據(jù)源的指定。

- (NSInputStream *)inputStream {
    if (!_inputStream) {
        if ([self.body isKindOfClass:[NSData class]]) {
            _inputStream = [NSInputStream inputStreamWithData:self.body];
        } else if ([self.body isKindOfClass:[NSURL class]]) {
            _inputStream = [NSInputStream inputStreamWithURL:self.body];
        } else if ([self.body isKindOfClass:[NSInputStream class]]) {
            _inputStream = self.body;
        } else {
            _inputStream = [NSInputStream inputStreamWithData:[NSData data]];
        }
    }
    
    return _inputStream;
}

所有的參數(shù)的數(shù)據(jù)流讀取完畢醋闭，我們的自定義HTTPBodyStream也完成了窄驹，接下來就可以把它賦值給request了。

對request進(jìn)行參數(shù)設(shè)置

參數(shù)設(shè)置這步比較簡單证逻，將之前自定義好的HTTPBodyStream賦值然后補(bǔ)充必要的參數(shù)即可：

// 調(diào)用方法對request進(jìn)行配置
[formData requestByFinalizingMultipartFormData]

- (NSMutableURLRequest *)requestByFinalizingMultipartFormData {
    if ([self.bodyStream isEmpty]) {
        return self.request;
    }

    // 重設(shè)Boundary確保內(nèi)容長度計算正確
    [self.bodyStream setInitialAndFinalBoundaries];
    [self.request setHTTPBodyStream:self.bodyStream];

    [self.request setValue:[NSString stringWithFormat:@"multipart/form-data; boundary=%@", self.boundary] forHTTPHeaderField:@"Content-Type"];
    [self.request setValue:[NSString stringWithFormat:@"%llu", [self.bodyStream contentLength]] forHTTPHeaderField:@"Content-Length"];

    return self.request;
}

通過NSURLSession的uploadTaskWithStreamedRequest:方法發(fā)起Post請求

上面request配置完成乐埠，就剩最后一步發(fā)起請求了：

__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];

- (NSURLSessionUploadTask *)uploadTaskWithStreamedRequest:(NSURLRequest *)request
                                                 progress:(void (^)(NSProgress *uploadProgress)) uploadProgressBlock
                                        completionHandler:(void (^)(NSURLResponse *response, id responseObject, NSError *error))completionHandler
{
    __block NSURLSessionUploadTask *uploadTask = nil;
    url_session_manager_create_task_safely(^{
        uploadTask = [self.session uploadTaskWithStreamedRequest:request];
    });

    [self addDelegateForUploadTask:uploadTask progress:uploadProgressBlock completionHandler:completionHandler];

    return uploadTask;
}

在AF自定義的上傳方法中，使用了自己的代理囚企，并讓代理調(diào)用Block進(jìn)行上傳進(jìn)度和完成的回調(diào)丈咐，具體實(shí)現(xiàn)在這里就不贅述了，可以看源代碼進(jìn)一步了解龙宏。

其實(shí)這個方法也完全可以用- dataTaskWithRequest:completionHandler:代替棵逊，這就避免了自己手動實(shí)現(xiàn)代理和回調(diào)的麻煩。

至此银酗，整個圖片上傳流程就完成了辆影。如果你自己寫一個上傳圖片方法徒像，其實(shí)也完全不用像AF的這么復(fù)雜，畢竟AF是要考慮到各種復(fù)雜的使用場景蛙讥，內(nèi)部的復(fù)雜實(shí)現(xiàn)可以保證調(diào)用更靈活也更方便锯蛀。