AFN3.0混合表单提交

今天有这么一个需求,实现APP意见反馈,可以提交标题、内容、联系方式、以及0-4张图片,从接口角度出发,这个属于混合表单提交,AFN3.0刚好支持这种提交方式。

AFN3.0支持文件上传,并且提供下面一个API:

/**
 @param method 不能是 `GET` or `HEAD`, or `nil`.
 @param URLString 服务器文件路径.
 @param parameters 表单数据,最终是存储在HTTP body中.
 @param block 此block有一个遵循 `AFMultipartFormData`协议的对象,用来往HTTP body添加内容.
 @param error 创建Request过程中产生异常会保存在这个对象中.

 @return 一个 `NSMutableURLRequest` 对象
 */
- (NSMutableURLRequest *)multipartFormRequestWithMethod:(NSString *)method
                                              URLString:(NSString *)URLString
                                             parameters:(nullable NSDictionary <NSString *, id> *)parameters
                              constructingBodyWithBlock:(nullable void (^)(id <AFMultipartFormData> formData))block
                                                  error:(NSError * _Nullable __autoreleasing *)error;

假如我们需要上传多个键值对以及多个文件,那么代码如下:

NSMutableURLRequest *request = [self.httpRequestSerializer multipartFormRequestWithMethod:@"POST" URLString:urlString parameters:requestParams constructingBodyWithBlock:^(id<AFMultipartFormData>  _Nonnull formData) {
        for (NSDictionary *dict in files) {
            [formData appendPartWithFileData:dict[kUploadData] name:dict[kUploadTargetName] fileName:dict[kUploadFileName] mimeType:dict[kUploadMimeType]];
        }
    } error:NULL];

拿到了Request之后我们可以通过AFHTTPSessionManager中的API发起网络请求:

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

举个例子:

- (NSNumber *)callApiWithRequest:(NSURLRequest *)request success:(BPCallBack)success fail:(BPCallBack)fail
{
    
    BPLog(@"\n==================================\n\nRequest Start: \n\n %@\n\n==================================", request.URL);
    // 跑到这里的block的时候,就已经是主线程了。
    __block NSURLSessionDataTask *dataTask = nil;
    dataTask = [self.sessionManager dataTaskWithRequest:request uploadProgress:nil downloadProgress:nil completionHandler:^(NSURLResponse * _Nonnull response, id  _Nullable responseObject, NSError * _Nullable error) {
        NSNumber *requestID = @([dataTask taskIdentifier]);
        [self.dispatchTable removeObjectForKey:requestID];
        NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *)response;
        NSData *responseData = responseObject;
        NSString *responseString = [[NSString alloc] initWithData:responseData encoding:NSUTF8StringEncoding];
        
        if (error) {
            BPURLResponse *BPResponse = [[BPURLResponse alloc] initWithResponseString:responseString requestId:requestID request:request responseData:responseData error:error];
            fail?fail(BPResponse):nil;
        } else {
            BPURLResponse *BPResponse = [[BPURLResponse alloc] initWithResponseString:responseString requestId:requestID request:request responseData:responseData status:BPURLResponseStatusSuccess];
            success?success(BPResponse):nil;
        }
    }];
    
    NSNumber *requestId = @([dataTask taskIdentifier]);
    
    self.dispatchTable[requestId] = dataTask;
    [dataTask resume];
    
    return requestId;
}

其实现原理大致如下:

  • 声明编码类型为multipart/form-data,指表单数据有多部分构成:既有文本数据,又有文件等二进制数据的意思。
  • 生成一个boundary字符串用以分隔数据。
  • 将requestParams字典对象中的键值对枚举出来,通过指定的编码格式(默认是UTF-8)编码后存储追加进HTTP body中。

以Apache服务器为例子,服务器端截获的request请求如下图1-1所示:

图1-1

由图的Request Payload下可以清晰看到每个数据都是以boundary分割的,正是因为有了boundary的存在,所以我们可以实现多文件、多类型的数据上传。

服务器组件支持多文件读取,比如fileupload组件,举个例子:

try {
        List<FileItem> items = sfu.parseRequest(request);
        // 区分表单域
        for (int i = 0; i < items.size(); i++) {
            FileItem item = items.get(i);
            // isFormField为true,表示这不是文件上传表单域
            if (!item.isFormField()) {
                //此item为文件
            }else{
                //item为表单数据,通过item.getFieldName()获取字段名,通过item.getString("utf-8")获取字段对应的值
            }
        }
        out.flush();
        out.close();
    } catch (Exception e) {
        e.printStackTrace();
        out.println(e);
        out.flush();
        out.close();
        return;
    }

关于FileItem的具体使用和参考可以点击这里

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 199,064评论 5 466
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 83,606评论 2 376
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 146,011评论 0 328
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 53,550评论 1 269
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 62,465评论 5 359
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 47,919评论 1 275
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,428评论 3 390
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,075评论 0 254
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,208评论 1 294
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,185评论 2 317
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,191评论 1 328
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,914评论 3 316
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,482评论 3 302
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,585评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,825评论 1 255
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,194评论 2 344
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 41,703评论 2 339

推荐阅读更多精彩内容