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閱讀 229,836評論 6 540
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 99,275評論 3 428
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 177,904評論 0 383
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 63,633評論 1 317
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 72,368評論 6 410
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 55,736評論 1 328
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,740評論 3 446
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,919評論 0 289
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 49,481評論 1 335
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 41,235評論 3 358
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 43,427評論 1 374
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,968評論 5 363
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,656評論 3 348
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 35,055評論 0 28
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 36,348評論 1 294
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 52,160評論 3 398
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 48,380評論 2 379

推薦閱讀更多精彩內容