AFMultipartFormData协议说明


声明处:AFURLRequestSerialization.h


概述

AFMultipartFormData协议定义的方法是为AFHTTPRequestSerializer的- multipartFormRequestWithMethod:URLString:parameters:constructingBodyWithBlock方法中块的参数提供的。

任务

  • - appendPartWithFileURL:name:error: 必须实现的方法
  • - appendPartWithFileURL:name:fileName:mimeType:error: 必须实现的方法
  • - appendPartWithInputStream:name:fileName:length:mimeType: 必须实现的方法
  • - appendPartWithFileData:name:fileName:mimeType: 必须实现的方法
  • - appendPartWithFormData:name: 必须实现的方法
  • - appendPartWithHeader:body: 必须实现的方法
  • - throttleBandwidthWithPacketSize:delay: 必须实现的方法

实例方法

appendPartWithFileData:name:fileName:mimeType:

- (void)appendPartWithFileData:(NSData *)data name:(NSString *)name fileName:(NSString *)fileName mimeType:(NSString *)mimeType

讨论

追加HTTP头Content-Disposition:file; filename=#{filename}; name=#{name}Content-Type:#{mimeType}, 其次是编码的文件数据和多部分表单边界。

参数

data

被编码的数据,追加到表单数据。

name

指定数据关联的名称。这个参数不能为nil。

fileName

指定数据关联的文件名称。这个参数不能为nil。

mimeType

指定数据的MIME类型。(举个例子,JPEG图片的MIME类型为image/jpeg)有效的MIME类型列表,详见http://www.iana.org/assignments/media-types/ .这个参数不能为nil。

声明处

AFURLRequestSerialization.h

appendPartWithFileURL:name:error

- (BOOL)appendPartWithFileURL:(NSURL *)fileURL name:(NSString *)name error:(NSError *_Nullable __autoreleasing *)error

讨论

追加HTTP头Content-Disposition: file; filename=#{generated filename}; name=#{name}Content-Type:#{generated mimeType},其次是编码的文件数据和多部分表单边界。
分别使用fileURL中最后的路径部分和文件URL扩展的系统关联MIME类型,在表单中数据的文件名和MIME类型将自动生成。

参数

fileURL

追加到表单的文件内容对应的URL。这个参数不能为nil。

name

指定数据相关联的名称。这个参数不能为nil。

error

如果一个错误发生,返回一个包含描述问题的NSError对象。

返回值

如果文件数据追加成功,返回YES,否者返回NO。

声明处

AFURLRequestSerialization.h

appendPartWithURL:name:fileName:mimeType:error

- (BOOL)appendPartWithFileURL:(NSURL *)fileURL name:(NSString *)name fileName:(NSString *)fileName mimeType:(NSString *)mimeType error:(NSError *_Nullable __autoreleasing *)error

讨论

追加到HTTP头Content-Disposition: file; filename=#{filename}; name = #{name}Content-Type: #{mimeType}, 其次是编码的文件数据和多部分表单边界。

参数

fileURL

追加到表单的文件内容对应的URL。这个参数不能为nil。

name

指定数据相关联的名称。这个参数不能为nil。

fileName

在Content-Disposition头中使用的文件名称。这个参数不能为nil。

mimeType

文件数据的公开的MIME类型。这个参数不能为nil。

error

如果一个错误发生,返回一个包含描述问题的NSError对象。

返回值

如果文件数据追加成功,返回YES,否者返回NO。

声明处

AFURLRequestSerialization.h

appendPartWithFormData:name:

- (void)appendPartWithFormData:(NSData *)data name:(NSString *)name

讨论

追加HTTP头Content-Disposition: form-data; name=#{name}, 其次编码的数据和多部分表单的边界。

参数

data

被编码的数据,并追加到表单的数据。

name

根据指定数据相关联的名称。这个参数不能为nil。

声明处

AFURLRequestSerialization.h

appendPartWithHeaders:body:

- (void)appendPartWithHeaders:(nullable NSDictionary<NSString*,NSString*> *)headers body:(NSData *)body

讨论

追到HTTP头,其次为编码数据和多部分表单边界。

参数

header

被追到表单数据的HTTP头。

body

被编码的数据并追加到表单数据。这个参数不能为nil。

声明处

AFURLRequestSerialization.h

appendPartWithInputStream:name:filename:length:mimeType:

- (void)appendPartWithInputStream:(nullable NSInputStream *)inputStream name:(NSString *)name fileName:(NSString *)fileName length:(int64_t)length mimeType:(NSString *)mimeType

讨论

追加HTTP头Content-Dispostion: file; filename=#{filename}; name=#{name}Content-Type:#{mimeType}, 其次是输入流的数据和多部分表单边界。

参数

inputStream

被追加到表单数据的输入流。

name

与指定输入流相关联的名称。这个参数不能为nil。

fileName

与制定输入流相关联的文件名称。这个参数不能为nil。

length

指定输入流的字节长度。

mimeType

指定数据的MIME类型。(举例, 一个JPEG图片的MIME类型为image/jpeg)一个有效MIME类型的列表,详见http://www.iana.org/assignments/media-types/。这个参数不能nil。

声明处

AFURLRequestSerialization.h

throttleBandwidthWithPacketSize:delay:

- (void)throttleBandwidthWithPacketSize:(NSUInteger)numberOfBytes delay:(NSTimeInterval)delay

讨论

通过限制包的大小来控制请求带宽,为从上传流中读取每个大块添加延迟。
当通过3G或EDGE链接上传时,请求可能报“请求体流耗尽”的失败。依据建议的值(kAFUploadStreamGSuggestedPacketSize和 kAFUploadStream3GSuggestedDelay)设置一个最大的包大小和延迟,降低输入流分配过多的带宽的风险。同时,不建议你只基于网络可达性来限制带宽。替代的,你应该考虑在一个失败的块中检查“请求体流耗尽”,同时用限制带宽来重试请求。

参数

numberOfBytes

包的最大字节数。默认的输入流包大小为16kb。

delay

每次读取一个包的延时间隔。默认情况下,不设置延时。

声明处

AFURLRequestSerialization.h

// END 应该好好看看API啊,并看看怎么实现的。仅仅会用觉得没有安全感啊。

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

推荐阅读更多精彩内容