iOS 開發中使用 NSURLProtocol 攔截 HTTP 請求

intercept

這篇文章會提供一種在 Cocoa 層攔截所有 HTTP 請求的方法,其實標題已經說明了攔截 HTTP 請求需要的了解的就是 NSURLProtocol

由于文章的內容較長,會分成兩部分,這篇文章介紹 NSURLProtocol 攔截 HTTP 請求的原理,另一篇文章如何進行 HTTP Mock 介紹這個原理在 OHHTTPStubs 中的應用,它是如何 Mock(偽造)某個 HTTP 請求對應的響應的。

NSURLProtocol

NSURLProtocol 是蘋果為我們提供的 URL Loading System 的一部分,這是一張從官方文檔貼過來的圖片:

URL-loading-syste

官方文檔對 NSURLProtocol 的描述是這樣的:

An NSURLProtocol object handles the loading of protocol-specific URL data. The NSURLProtocol class itself is an abstract class that provides the infrastructure for processing URLs with a specific URL scheme. You create subclasses for any custom protocols or URL schemes that your app supports.

在每一個 HTTP 請求開始時,URL 加載系統創建一個合適的 NSURLProtocol 對象處理對應的 URL 請求,而我們需要做的就是寫一個繼承自 NSURLProtocol 的類,并通過 - registerClass: 方法注冊我們的協議類,然后 URL 加載系統就會在請求發出時使用我們創建的協議對象對該請求進行處理。

這樣,我們需要解決的核心問題就變成了如何使用 NSURLProtocol 來處理所有的網絡請求,這里使用蘋果官方文檔中的 CustomHTTPProtocol 進行介紹,你可以點擊這里下載源代碼。

在這個工程中 CustomHTTPProtocol.m 是需要重點關注的文件,CustomHTTPProtocol 就是 NSURLProtocol 的子類:

@interface CustomHTTPProtocol : NSURLProtocol

...

@end

現在重新回到需要解決的問題,也就是 如何使用 NSURLProtocol 攔截 HTTP 請求?,有這個么幾個問題需要去解決:

  • 如何決定哪些請求需要當前協議對象處理?
  • 對當前的請求對象需要進行哪些處理?
  • NSURLProtocol 如何實例化?
  • 如何發出 HTTP 請求并且將響應傳遞給調用者?

上面的這幾個問題其實都可以通過 NSURLProtocol 為我們提供的 API 來解決,決定請求是否需要當前協議對象處理的方法是:+ canInitWithRequest

+ (BOOL)canInitWithRequest:(NSURLRequest *)request {
    BOOL shouldAccept;
    NSURL *url;
    NSString *scheme;
    
    shouldAccept = (request != nil);
    if (shouldAccept) {
        url = [request URL];
        shouldAccept = (url != nil);
    }
    return shouldAccept;
}

因為項目中的這個方法是大約有 60 多行,在這里只粘貼了其中的一部分,只為了說明該方法的作用:每一次請求都會有一個 NSURLRequest 實例,上述方法會拿到所有的請求對象,我們就可以根據對應的請求選擇是否處理該對象;而上面的代碼只會處理所有 URL 不為空的請求。

請求經過 + canInitWithRequest: 方法過濾之后,我們得到了所有要處理的請求,接下來需要對請求進行一定的操作,而這都會在 + canonicalRequestForRequest: 中進行,雖然它與 + canInitWithRequest: 方法傳入的 request 對象都是一個,但是最好不要在 + canInitWithRequest: 中操作對象,可能會有語義上的問題;所以,我們需要覆寫 + canonicalRequestForRequest: 方法提供一個標準的請求對象:

+ (NSURLRequest *)canonicalRequestForRequest:(NSURLRequest *)request {
    return request;
}

這里對請求不做任何修改,直接返回,當然你也可以給這個請求加個 header,只要最后返回一個 NSURLRequest 對象就可以。

在得到了需要的請求對象之后,就可以初始化一個 NSURLProtocol 對象了:

- (id)initWithRequest:(NSURLRequest *)request cachedResponse:(NSCachedURLResponse *)cachedResponse client:(id <NSURLProtocolClient>)client {
    return [super initWithRequest:request cachedResponse:cachedResponse client:client];
}

在這里直接調用 super 的指定構造器方法,實例化一個對象,然后就進入了發送網絡請求,獲取數據并返回的階段了:

- (void)startLoading {
    NSURLSession *session = [NSURLSession sessionWithConfiguration:[[NSURLSessionConfiguration alloc] init] delegate:self delegateQueue:nil];
    NSURLSessionDataTask *task = [session dataTaskWithRequest:self.request];
    [task resume];
}

這里使用簡化了 CustomHTTPClient 中的項目代碼,可以達到幾乎相同的效果。

你可以在 - startLoading 中使用任何方法來對協議對象持有的 request 進行轉發,包括 NSURLSessionNSURLConnection 甚至使用 AFNetworking 等網絡庫,只要你能在回調方法中把數據傳回 client,幫助其正確渲染就可以,比如這樣:

- (void)URLSession:(NSURLSession *)session dataTask:(NSURLSessionDataTask *)dataTask didReceiveResponse:(NSURLResponse *)response completionHandler:(void (^)(NSURLSessionResponseDisposition))completionHandler {
    [[self client] URLProtocol:self didReceiveResponse:response cacheStoragePolicy:NSURLCacheStorageAllowed];
    
    completionHandler(NSURLSessionResponseAllow);
}

- (void)URLSession:(NSURLSession *)session dataTask:(NSURLSessionDataTask *)dataTask didReceiveData:(NSData *)data {
    [[self client] URLProtocol:self didLoadData:data];
}

當然這里省略后的代碼只會保證大多數情況下的正確執行,只是給你一個對獲取響應數據粗略的認知,如果你需要更加詳細的代碼,我覺得最好還是查看一下 CustomHTTPProtocol 中對 HTTP 響應處理的代碼,也就是 NSURLSessionDelegate 協議實現的部分。

client 你可以理解為當前網絡請求的發起者,所有的 client 都實現了 NSURLProtocolClient 協議,協議的作用就是在 HTTP 請求發出以及接受響應時向其它對象傳輸數據:

@protocol NSURLProtocolClient <NSObject>
...
- (void)URLProtocol:(NSURLProtocol *)protocol didReceiveResponse:(NSURLResponse *)response cacheStoragePolicy:(NSURLCacheStoragePolicy)policy;

- (void)URLProtocol:(NSURLProtocol *)protocol didLoadData:(NSData *)data;

- (void)URLProtocolDidFinishLoading:(NSURLProtocol *)protocol;
...
@end

當然這個協議中還有很多其他的方法,比如 HTTPS 驗證、重定向以及響應緩存相關的方法,你需要在合適的時候調用這些代理方法,對信息進行傳遞。

如果你只是繼承了 NSURLProtocol 并且實現了上述方法,依然不能達到預期的效果,完成對 HTTP 請求的攔截,你還需要在 URL 加載系統中注冊當前類:

[NSURLProtocol registerClass:self];

需要注意的是 NSURLProtocol 只能攔截 UIURLConnectionNSURLSessionUIWebView 中的請求,對于 WKWebView 中發出的網絡請求也無能為力,如果真的要攔截來自 WKWebView 中的請求,還是需要實現 WKWebView 對應的 WKNavigationDelegate,并在代理方法中獲取請求。
無論是 NSURLProtocolNSURLConnection 還是 NSURLSession 都會走底層的 socket,但是 WKWebView 可能由于基于 WebKit,并不會執行 C socket 相關的函數對 HTTP 請求進行處理,具體會執行什么代碼暫時不是很清楚,如果對此有興趣的讀者,可以聯系筆者一起討論。

總結

如果你只想了解如何對 HTTP 請求進行攔截,其實看到這里就可以了,不過如果你想應用文章中的內容或者希望了解如何偽造 HTTP 響應,可以看下一篇文章如何進行 HTTP Mock

References

Github Repo:iOS-Source-Code-Analyze

Follow: Draveness · Github

Source: http://draveness.me/intercept

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

推薦閱讀更多精彩內容

  • Spring Cloud為開發人員提供了快速構建分布式系統中一些常見模式的工具(例如配置管理,服務發現,斷路器,智...
    卡卡羅2017閱讀 134,781評論 18 139
  • iOS網絡編程讀書筆記 Facade Tester客戶端門面模式的實例(被動版本化) 被動版本化,所以硬編碼URL...
    melouverrr閱讀 1,618評論 3 7
  • 一、概念(載錄于:http://www.cnblogs.com/EricaMIN1987_IT/p/3837436...
    yuantao123434閱讀 8,404評論 6 152
  • 本文是逐行翻譯,便于參照原文,如有歧義或者疑問請閱讀原文比較。于 2017.1.25===============...
    Auditore閱讀 1,532評論 4 5
  • 凱文·史派西,今天,出柜了。 出柜沒什么,但這個出柜,貌似別有用心。 他被韋恩斯坦事件卷入丑聞,被《星際迷航:發現...
    Sir電影閱讀 1,485評論 2 12