AFHTTPSessionManager類說明

繼承：AFURLSessionManager：NSObject

遵照：NSCopying, NSSecureCoding

聲明處：AFHTTPSessionManager.h

概述

AFHTTPSessionManager是AFURLSessionManager的子類，為了便利使用HTTP請求。當一個baseURL提供時，用相對路徑構造GET/POST等便利的方法來創建請求。

子類化注意

開發人員使用網絡服務并且將iOS7或Mac OS X 10.9或更新的版本作為目標版本，那么推薦使用AFHTTPSessionManager的子類，提供一個返回共享單例對象的類方法，此單例可以在整個應用中共享驗證或其他的配置信息。

對于開發人員設置目標版本為iOS6或Mac OS X 10.8 或更早的版本，那么AFHTTPRequestOperationManager可以實現相同的效果。

重載的方法

改變所有數據的任務操作結構的行為，同樣使用GET/POST等便利的方法，重載dataTaskWithRequest:completionHandler:.

序列化

一個HTTP端創建的請求，包含默認的HTTP頭和依據requestSerializer屬性編碼的參數，是遵照AFURLRequestSerialization的對象。

服務器返回的響應數據是被自動校驗過的并被responseSerializers屬性序列化的，是遵照AFURLResponseSerialization的對象。

URL構建使用相對路徑

對于HTTP便利方法，請求序列化構造URLs來之baseURL的相對路徑，使用提供的NSURL的方法 +URLWithString:relativeToURL:. 當baseURL為nil時，請求路徑使用NSURL的方法+URLWithString:來生成一個有效的NSURL對象。

以下是baseURL和相對路徑互相作用的一些樣例代碼：

NSURL *baseURL = [NSURL URLWithString:@"http://example.com/v1/"];
[NSURL URLWithString:@"foo" relativeToURL:baseURL];                  // http://example.com/v1/foo
[NSURL URLWithString:@"foo?bar=baz" relativeToURL:baseURL];          // http://example.com/v1/foo?bar=baz
[NSURL URLWithString:@"/foo" relativeToURL:baseURL];                 // http://example.com/foo
[NSURL URLWithString:@"foo/" relativeToURL:baseURL];                 // http://example.com/v1/foo
[NSURL URLWithString:@"/foo/" relativeToURL:baseURL];                // http://example.com/foo/
[NSURL URLWithString:@"http://example2.com/" relativeToURL:baseURL]; // http://example2.com/

同時特別注意baseURL末尾沒有斜杠時添加一個。否則當沒有一個末尾斜杠時，可能在使用路徑構架URLs時引起未預期的行為。

警告：后臺會話的Managers必須在他們使用期間擁有?？梢酝ㄟ^創建一個application-wide或分享單例實例來完成。

任務

其他方法

baseURL 屬性

requestSerializer 屬性

responseSerializer 屬性

初始化

類方法
+ manager
實例方法
– initWithBaseURL:
– initWithBaseURL:sessionConfiguration:

創建HTTP請求

– GET:parameters:success:failure:
– GET:parameters:progress:success:failure:
– HEAD:parameters:success:failure:
– POST:parameters:success:failure:
– POST:parameters:progress:success:failure:
– POST:parameters:constructingBodyWithBlock:success:failure:
– POST:parameters:constructingBodyWithBlock:progress:success:failure:
– PUT:parameters:success:failure:
– PATCH:parameters:success:failure:
– DELETE:parameters:success:failure:

屬性

baseURL

@property (readonly, nonatomic, strong, nullable) NSURL *baseURL

討論

此URL是用在像requestWithMethod:URLString:parameters:方法中根據相對路徑和GET/POST等便利方法來創建請求。

聲明處

AFHTTPSessionManager.h

requestSerializer

@property (nonatomic, strong) AFHTTPRequestSerializer<AFURLRequestSerialization> *requestSerializer

討論

使用requestWithMethod:URLString:parameters: & multipartFormRequestWithMethod:URLString:parameters:constructingBodyWithBlock這個兩個方法創建的請求，是通過這個屬性指定已經參數序列化好的一組默認請求頭構建的。默認設置下，這些內容設置在一個為GET，HEAD和DELETE或其他URL-form-encodes的HTTP消息體連接查詢字符串參數的AFHTTPRequestSerializer實例中。

警告： requestSerializer必須不能為nil。

聲明處

AFHTTPSessionManager.h

responseSerializer

@property (nonatomic, strong) AFHTTPResponseSerializer<AFURLResponseSerialization> *responseSerializer

討論

回應序列化是dateTaskWithRequest:success:failure:創建的數據任務使用Get、Post等便利的方法，獲取服務器返回的響應進行驗證和通過響應序列進行序列化。默認這個屬性設置為AFJSONResponseSerializer的實例。

警告： responseSerializer必須不為nil。

聲明處

AFHTTPSessionManager.h

類方法

manager

+ (instancetype)manager

討論

創建和返回一個AFHTTPSessionManager對象。

聲明處

AFHTTPSessionManager.h

實例方法

DELETE:parameters:success:failure:

- (nullable NSURLSessionDataTask *)DELETE:(NSString *)URLString parameters:(nullable id)parameters success:(nullable void ( ^ ) ( NSURLSessionDataTask *task , id _Nullable responseObject ))success failure:(nullable void ( ^ ) ( NSURLSessionDataTask *_Nullable task , NSError *error ))failure

討論

創建和運行一個DELETE請求的NSURLSessionDataTask

參數

URLString

用于創建請求RUL的URL字符串。

parameters

依據定制的請求序列化被編碼的參數。

success

一個當任務成功完成時被執行的塊。這個塊沒有返回值和帶兩個參數：數據任務和被定制的響應序列化創建的響應對象。

failure

一個當任務完成單沒有成功時，或成功完成但是在解析響應數據時遭遇一個錯誤時被執行的塊。這個塊沒有返回值和帶兩個參數：數據任務和描述發生的網絡和解析出錯的錯誤。

聲明處

AFHTTPSessionManager.h

GET:parameters:progress:success:failure:

- (nullable NSURLSessionDataTask *)GET:(NSString *)URLString parameters:(nullable id)parameters progress:(nullable void ( ^ ) ( NSProgress *downloadProgress ))downloadProgress success:(nullable void ( ^ ) ( NSURLSessionDataTask *task , id _Nullable responseObject ))success failure:(nullable void ( ^ ) ( NSURLSessionDataTask *_Nullable task , NSError *error ))failure

討論

創建和運行一個GET請求的NSURLSessionDataTask。

參數

URLString

用于創建請求RUL的URL字符串。

parameters

依據定制的請求序列化被編碼的參數。

downloadProgress

一個當下載進度更新時被執行的塊。注意這個塊是在會話隊列中被調用，而不是在主隊列。

success

一個當任務成功完成時被執行的塊。這個塊沒有返回值和帶兩個參數：數據任務和被定制的響應序列化創建的響應對象。

failure

一個當任務完成單沒有成功時，或成功完成但是在解析響應數據時遭遇一個錯誤時被執行的塊。這個塊沒有返回值和帶兩個參數：數據任務和描述發生的網絡和解析出錯的錯誤。

聲明處

AFHTTPSessionManager.h

GET:parameters:success:failure:

- (nullable NSURLSessionDataTask *)GET:(NSString *)URLString parameters:(nullable id)parameters success:(nullable void ( ^ ) ( NSURLSessionDataTask *task , id _Nullable responseObject ))success failure:(nullable void ( ^ ) ( NSURLSessionDataTask *_Nullable task , NSError *error ))failure

討論

創建和運行一個GET請求的NSURLSessionDataTask。

參數

URLString

用于創建請求RUL的URL字符串。

parameters

依據定制的請求序列化被編碼的參數。

success

一個當任務成功完成時被執行的塊。這個塊沒有返回值和帶兩個參數：數據任務和被定制的響應序列化創建的響應對象。

failure

一個當任務完成單沒有成功時，或成功完成但是在解析響應數據時遭遇一個錯誤時被執行的塊。這個塊沒有返回值和帶兩個參數：數據任務和描述發生的網絡和解析出錯的錯誤。

聲明處

AFHTTPSessionManager.h

HEAD:parameters:success:failure:

- (nullable NSURLSessionDataTask *)HEAD:(NSString *)URLString parameters:(nullable id)parameters success:(nullable void ( ^ ) ( NSURLSessionDataTask *task ))success failure:(nullable void ( ^ ) ( NSURLSessionDataTask *_Nullable task , NSError *error ))failure

討論

創建和運行一個HEAD請求的NSURLSessionDataTask。

參數

URLString

用于創建請求RUL的URL字符串。

parameters

依據定制的請求序列化被編碼的參數。

success

一個當任務成功完成時被執行的塊。這個塊沒有返回值和帶兩個參數：數據任務和被定制的響應序列化創建的響應對象。

failure

一個當任務完成單沒有成功時，或成功完成但是在解析響應數據時遭遇一個錯誤時被執行的塊。這個塊沒有返回值和帶兩個參數：數據任務和描述發生的網絡和解析出錯的錯誤。

聲明處

AFHTTPSessionManager.h

PATCH:parameters:success:failure:

- (nullable NSURLSessionDataTask *)PATCH:(NSString *)URLString parameters:(nullable id)parameters success:(nullable void ( ^ ) ( NSURLSessionDataTask *task , id _Nullable responseObject ))success failure:(nullable void ( ^ ) ( NSURLSessionDataTask *_Nullable task , NSError *error ))failure

討論

創建和運行一個PATCH請求的NSURLSessionDataTask。

參數

URLString

用于創建請求RUL的URL字符串。

parameters

依據定制的請求序列化被編碼的參數。

success

一個當任務成功完成時被執行的塊。這個塊沒有返回值和帶兩個參數：數據任務和被定制的響應序列化創建的響應對象。

failure

一個當任務完成單沒有成功時，或成功完成但是在解析響應數據時遭遇一個錯誤時被執行的塊。這個塊沒有返回值和帶兩個參數：數據任務和描述發生的網絡和解析出錯的錯誤。

聲明處

AFHTTPSessionManager.h

POST:parameters:constructingBodyWithBlock:progress:success:failure:

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

討論

創建和運行一個多部分的POST請求的NSURLSessionDataTask。

參數

URLString

用于創建請求RUL的URL字符串。

parameters

依據定制的請求序列化被編碼的參數。

block

一個帶一個參數和追加數據到HTTP消息體的塊。這個塊的參數是一個采用AFMultipartFormData協議的對象。

uploadProgress

一個當上傳進度更新時被執行的塊。注意這個塊是在會話隊列中被調用，而不是在主隊列。

success

一個當任務成功完成時被執行的塊。這個塊沒有返回值和帶兩個參數：數據任務和被定制的響應序列化創建的響應對象。

failure

一個當任務完成單沒有成功時，或成功完成但是在解析響應數據時遭遇一個錯誤時被執行的塊。這個塊沒有返回值和帶兩個參數：數據任務和描述發生的網絡和解析出錯的錯誤。

聲明處

AFHTTPSessionManager.h

POST:parameters:constructingBodyWithBlock:success:failure:

- (nullable NSURLSessionDataTask *)POST:(NSString *)URLString parameters:(nullable id)parameters constructingBodyWithBlock:(nullable void ( ^ ) ( id<AFMultipartFormData> formData ))block success:(nullable void ( ^ ) ( NSURLSessionDataTask *task , id _Nullable responseObject ))success failure:(nullable void ( ^ ) ( NSURLSessionDataTask *_Nullable task , NSError *error ))failure

討論

創建和運行一個多部分的POST請求的NSURLSessionDataTask。

參數

URLString

用于創建請求RUL的URL字符串。

parameters

依據定制的請求序列化被編碼的參數。

block

一個帶一個參數和追加數據到HTTP消息體的塊。這個塊的參數是一個采用AFMultipartFormData協議的對象。

success

一個當任務成功完成時被執行的塊。這個塊沒有返回值和帶兩個參數：數據任務和被定制的響應序列化創建的響應對象。

failure

一個當任務完成單沒有成功時，或成功完成但是在解析響應數據時遭遇一個錯誤時被執行的塊。這個塊沒有返回值和帶兩個參數：數據任務和描述發生的網絡和解析出錯的錯誤。

聲明處

AFHTTPSessionManager.h

POST:parameters:progress:success:failure:

- (nullable NSURLSessionDataTask *)POST:(NSString *)URLString parameters:(nullable id)parameters progress:(nullable void ( ^ ) ( NSProgress *uploadProgress ))uploadProgress success:(nullable void ( ^ ) ( NSURLSessionDataTask *task , id _Nullable responseObject ))success failure:(nullable void ( ^ ) ( NSURLSessionDataTask *_Nullable task , NSError *error ))failure

討論

創建和運行一個POST請求的NSURLSessionDataTask。

參數

URLString

用于創建請求RUL的URL字符串。

parameters

依據定制的請求序列化被編碼的參數。

uploadProgress

一個當上傳進度更新時被執行的塊。注意這個塊是在會話隊列中被調用，而不是在主隊列。

success

一個當任務成功完成時被執行的塊。這個塊沒有返回值和帶兩個參數：數據任務和被定制的響應序列化創建的響應對象。

failure

一個當任務完成單沒有成功時，或成功完成但是在解析響應數據時遭遇一個錯誤時被執行的塊。這個塊沒有返回值和帶兩個參數：數據任務和描述發生的網絡和解析出錯的錯誤。

聲明處

AFHTTPSessionManager.h

POST:parameters:success:failure:

- (nullable NSURLSessionDataTask *)POST:(NSString *)URLString parameters:(nullable id)parameters success:(nullable void ( ^ ) ( NSURLSessionDataTask *task , id _Nullable responseObject ))success failure:(nullable void ( ^ ) ( NSURLSessionDataTask *_Nullable task , NSError *error ))failure

討論

創建和運行一個POST請求的NSURLSessionDataTask。

參數

URLString

用于創建請求RUL的URL字符串。

parameters

依據定制的請求序列化被編碼的參數。

success

一個當任務成功完成時被執行的塊。這個塊沒有返回值和帶兩個參數：數據任務和被定制的響應序列化創建的響應對象。

failure

一個當任務完成單沒有成功時，或成功完成但是在解析響應數據時遭遇一個錯誤時被執行的塊。這個塊沒有返回值和帶兩個參數：數據任務和描述發生的網絡和解析出錯的錯誤。

聲明處

AFHTTPSessionManager.h

PUT:parameters:success:failure:

- (nullable NSURLSessionDataTask *)PUT:(NSString *)URLString parameters:(nullable id)parameters success:(nullable void ( ^ ) ( NSURLSessionDataTask *task , id _Nullable responseObject ))success failure:(nullable void ( ^ ) ( NSURLSessionDataTask *_Nullable task , NSError *error ))failure

討論

創建和運行一個PUT請求的NSURLSessionDataTask。

參數

URLString

用于創建請求RUL的URL字符串。

parameters

依據定制的請求序列化被編碼的參數。

success

一個當任務成功完成時被執行的塊。這個塊沒有返回值和帶兩個參數：數據任務和被定制的響應序列化創建的響應對象。

failure

一個當任務完成單沒有成功時，或成功完成但是在解析響應數據時遭遇一個錯誤時被執行的塊。這個塊沒有返回值和帶兩個參數：數據任務和描述發生的網絡和解析出錯的錯誤。

聲明處

AFHTTPSessionManager.h

initWithBaseURL:

- (instancetype)initWithBaseURL:(nullable NSURL *)url

討論

用指定的基礎URL初始化一個AFHTTPSessionManager對象。

參數

url

HTTP客戶端的基礎URL。

返回值

一個新初始化的HTTP客戶端。

聲明處

AFHTTPSessionManager.h

initWithBaseURL:sessionConfiguration:

- (instancetype)initWithBaseURL:(nullable NSURL *)url sessionConfiguration:(nullable NSURLSessionConfiguration *)configuration

討論

使用指定的基礎URL初始化一個AFHTTPSessionManager對象。
這是特定的初始化方法。

參數

url

HTTP客戶端的基礎URL。

configuration

配置用來創建會話管理。

返回值

一個新初始化的HTTP客戶端。

聲明處

AFHTTPSessionManager.h

// END 這個類的翻譯，真是的花了一點時間。中間好幾次放棄，去研究React Native。 每想到后面的類方法，重復的好多。 _

最后編輯于 ：
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明：文章內容（如有圖片或視頻亦包括在內）由作者上傳并發布，文章內容僅代表作者本人觀點，簡書系信息發布平臺，僅提供信息存儲服務。
  • 人面猴
    序言：七十年代末，一起剝皮案震驚了整個濱河市，隨后出現的幾起案子，更是在濱河造成了極大的恐慌，老刑警劉巖，帶你破解...
    沈念sama閱讀 228,702評論 6贊 534
  • 死咒
    序言：濱河連續發生了三起死亡事件，死亡現場離奇詭異，居然都是意外死亡，警方通過查閱死者的電腦和手機，發現死者居然都...
    沈念sama閱讀 98,615評論 3贊 419
  • 救了他兩次的神仙讓他今天三更去死
    文/潘曉璐 我一進店門，熙熙樓的掌柜王于貴愁眉苦臉地迎上來，“玉大人，你說我怎么就攤上這事?！?“怎么了？”我有些...
    開封第一講書人閱讀 176,606評論 0贊 376
  • 道士緝兇錄：失蹤的賣姜人
    文/不壞的土叔 我叫張陵，是天一觀的道長。 經常有香客問我，道長，這世上最難降的妖魔是什么？ 我笑而不...
    開封第一講書人閱讀 63,044評論 1贊 314
  • ?港島之戀（遺憾婚禮）
    正文 為了忘掉前任，我火速辦了婚禮，結果婚禮上，老公的妹妹穿的比我還像新娘。我一直安慰自己，他們只是感情好，可當我...
    茶點故事閱讀 71,826評論 6贊 410
  • 惡毒庶女頂嫁案：這布局不是一般人想出來的
    文/花漫 我一把揭開白布。 她就那樣靜靜地躺著，像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上，一...
    開封第一講書人閱讀 55,227評論 1贊 324
  • 城市分裂傳說
    那天，我揣著相機與錄音，去河邊找鬼。 笑死，一個胖子當著我的面吹牛，可吹牛的內容都是我干的。 我是一名探鬼主播，決...
    沈念sama閱讀 43,307評論 3贊 442
  • 雙鴛鴦連環套：你想象不到人心有多黑
    文/蒼蘭香墨 我猛地睜開眼，長吁一口氣：“原來是場噩夢啊……” “哼！你這毒婦竟也來了？” 一聲冷哼從身側響起，我...
    開封第一講書人閱讀 42,447評論 0贊 289
  • 萬榮殺人案實錄
    序言：老撾萬榮一對情侶失蹤，失蹤者是張志新（化名）和其女友劉穎，沒想到半個月后，有當地人在樹林里發現了一具尸體，經...
    沈念sama閱讀 48,992評論 1贊 335
  • ?護林員之死
    正文 獨居荒郊野嶺守林人離奇死亡，尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 40,807評論 3贊 355
  • ?白月光啟示錄
    正文 我和宋清朗相戀三年，在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 43,001評論 1贊 370
  • 活死人
    序言：一個原本活蹦亂跳的男人離奇死亡，死狀恐怖，靈堂內的尸體忽然破棺而出，到底是詐尸還是另有隱情，我是刑警寧澤，帶...
    沈念sama閱讀 38,550評論 5贊 361
  • ?日本核電站爆炸內幕
    正文 年R本政府宣布，位于F島的核電站，受9級特大地震影響，放射性物質發生泄漏。R本人自食惡果不足惜，卻給世界環境...
    茶點故事閱讀 44,243評論 3贊 347
  • 男人毒藥：我在死后第九天來索命
    文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧，春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,667評論 0贊 26
  • 一樁弒父案，背后竟有這般陰謀
    文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至，卻和暖如春，著一層夾襖步出監牢的瞬間，已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 35,930評論 1贊 287
  • 情欲美人皮
    我被黑心中介騙來泰國打工， 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留，地道東北人。 一個月前我還...
    沈念sama閱讀 51,709評論 3贊 393
  • 代替公主和親
    正文 我出身青樓，卻偏偏與公主長得像，于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子，可洞房花燭夜當晚...
    茶點故事閱讀 47,996評論 2贊 374

推薦閱讀更多精彩內容