详解如何拦截iOS所有网络请求
作者:LvesLi
背景
最近在研究iOS无埋点
统计技术,我们的统计SDK
主要分两部分:点击事件和网络请求。统计所有的点击事件是采用Method Swizzling
实现的,可以做到使用中不需要一行代码实现统计所有事件,具体细节将来我会专门抽几篇文章介绍。
今天主要说说如何统计APP中的所有网络请求。公司网络请求如果不是静态库
或者框架
,很容易想到在网络请求发送和返回时添加统计的代码。如何在不修改原来代码(或者修改最少)的基础上拦截所有的请求呢,能不能从系统层面上拦截回调呢?答案是肯定的,苹果有一个黑魔法NSURLProtocol
。
介绍
NSURLProtocol是iOS URL Loading System中的一部分,看起来像是一个协议,但其实这是一个类,而且必须使用该类的子类,并且需要被注册。先看看他在URL Loading System中的位置:
使用场景
不管是UIWebView还是URLSession还是第三方的AFNetWorkong
、Alamofire
或者SDWebImage
他们都是基于URLSession
或者NSURLConnection
来实现的,因此可以通过NSURLProtocol做自定义操作。
- 重定向网络请求
- 拦截网络加载,采用本地缓存
- 修改Request信息
- 自定义返回结果
- 对请求进行HTTPDNS解析,动态设置Host,解决不同网络下客户端不能访问的情况
实现
首先要继承NSURLProtocol创建自定义的类,然后重写startLoading、stopLoading添加我们的统计代码就可以了:
static NSString * const hasInitKey = @"LLMarkerProtocolKey"; @interface LLMarkerURLProtocol : NSURLProtocol @end
子类实现的NSURLProtocol方法:
1.0 +(BOOL)canInitWithRequest:(NSURLRequest *)request
;子类是否能响应该请求。
+(BOOL)canInitWithRequest:(NSURLRequest *)request{ if ([NSURLProtocol propertyForKey:hasInitKey inRequest:request]) { return NO; } return YES; }
2.0 +(NSURLRequest *)canonicalRequestForRequest:(NSURLRequest *)request
;自定义网络请求,如果不需要处理直接返回request。
+(NSURLRequest *)canonicalRequestForRequest:(NSURLRequest *)request{ return request; }
3.0 -(void)startLoading
开始网络请求,需要在该方法中发起一个请求,对于NSURLConnection来说,就是创建一个NSURLConnection,对于NSURLSession,就是发起一个NSURLSessionTask 。一般下载前需要设置该请求正在进行下载,防止多次下载的情况发生。
-(void)startLoading{ NSMutableURLRequest *mutableReqeust = [[self request] mutableCopy]; //做下标记,防止递归调用 [NSURLProtocol setProperty:@YES forKey:hasInitKey inRequest:mutableReqeust]; self.connection = [NSURLConnection connectionWithRequest:mutableReqeust delegate:self]; }
4.0 -(void)stopLoading
停止相应请求,清空请求Connection 或Task。
-(void)stopLoading{ [self.connection cancel]; }
5.0 实现NSURLConnectionDelegate
、NSURLConnectionDataDelegate
或者NSURLSessionTaskDelegate
。
#pragma mark - NSURLConnectionDelegate -(void)connection:(NSURLConnection *)connection didFailWithError:(NSError *)error{ [self.client URLProtocol:self didFailWithError:error]; } #pragma mark - NSURLConnectionDataDelegate - (void)connection:(NSURLConnection *)connection didReceiveResponse:(NSURLResponse *)response { self.responseData = [[NSMutableData alloc] init]; [self.client URLProtocol:self didReceiveResponse:response cacheStoragePolicy:NSURLCacheStorageNotAllowed]; } - (void)connection:(NSURLConnection *)connection didReceiveData:(NSData *)data { [self.responseData appendData:data]; [self.client URLProtocol:self didLoadData:data]; } - (void)connectionDidFinishLoading:(NSURLConnection *)connection { [self.client URLProtocolDidFinishLoading:self]; }
使用
一、在AppDelegate
中注册:
[NSURLProtocol registerClass:[LLMarkerURLProtocol class]];
这样能拦截UIWebView和自定义的请求了,如果要拦截AFNetWorking、Alamofire等第三方请求还需要做一些修改。
二、LLMarkerURLProtocol
中添加自定义NSURLSessionConfiguration
方法:
+ (NSURLSessionConfiguration *) defaultSessionConfiguration{ NSURLSessionConfiguration *config = [NSURLSessionConfiguration defaultSessionConfiguration]; NSMutableArray *array = [[config protocolClasses] mutableCopy]; [array insertObject:[self class] atIndex:0]; config.protocolClasses = array; return config; }
拦截第三方网络库方法就是让第三方使用我们这个NSURLSessionConfiguration。因为我们在自己的NSURLSessionConfiguration 中的protocolClasses中注册了自己类。
三、 下面以Alamofire
为例
1.0 继承Alamofire.SessionManager
自定义SessionManager
class LLSessionManger: Alamofire.SessionManager{ public static let sharedManager: SessionManager = { let configuration = LLMarkerURLProtocol.defaultSessionConfiguration() configuration?.httpAdditionalHeaders = SessionManager.defaultHTTPHeaders let manager = Alamofire.SessionManager(configuration: configuration!) return manager }() }
2.0 使用 LLSessionManger
进行网络请求
let manager = LLSessionManger.sharedManager manager.request("https://httpbin.org/get").responseJSON { (response) in if let JSON = response.result.value { print("JSON: \(JSON)") } }
注意:AFNetWorking、SDWebimage等第三方库的修改和Alamofire类似,找到使用NSURLSessionConfiguration的地方,换成LLMarkerURLProtocol的defaultSessionConfiguration就可以了。
看到这你可能发现,如果使用Alamofire进行网络请求,我们还是修改了原来的代码,下篇文章单独介绍如何不修改原来代码,通过注册Alamofire通知方式,拦截Alamofire的网络请求。
以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持脚本之家。