什么是 NSURLProtocol
NSURLProtocol作为URL Loading System中的一个独立部分存在,能够拦截所有的URL Loading System发出的网络请求,拦截之后便可根据需要做各种自定义处理,是iOS网络层实现AOP(面向切面编程)的终极利器
NSURLProtocol是URL Loading System的重要组成部分。
首先虽然名叫NSURLProtocol,但它却不是协议。它是一个抽象类。我们要使用它的时候需要创建它的一个子类
NSURLProtocol在iOS系统中大概处于这样一个位置:
NSURLProtocol能拦截哪些网络请求
NSURLProtocol能拦截所有基于URL Loading System的网络请求。
可以拦截的网络请求包括NSURLSession,NSURLConnection以及UIWebVIew。基于CFNetwork的网络请求,以及WKWebView的请求是无法拦截的。现在主流的iOS网络库,例如AFNetworking,Alamofire等网络库都是基于NSURLSession或NSURLConnection的,所以这些网络库的网络请求都可以被NSURLProtocol所拦截。还有一些年代比较久远的网络库,例如ASIHTTPRequest,MKNetwokit等网路库都是基于CFNetwork的,所以这些网络库的网络请求无法被NSURLProtocol拦截。
NSURLProtocol的使用
自定义NSURLProtocol的子类YHCacheURLProtocol然后在发起请求前注册
对于基于NSURLConnection或者使用[NSURLSession sharedSession]创建的网络请求,调用registerClass方法即可
[NSURLProtocol registerClass:[YHCacheURLProtocol class]];
对于基于NSURLSession的网络请求,需要通过配置NSURLSessionConfiguration对象的protocolClasses属性。
NSURLSessionConfiguration *sessionConfiguration = [NSURLSessionConfiguration defaultSessionConfiguration];
sessionConfiguration.protocolClasses = @[[YHCacheURLProtocol class]];
拦截
在拦截到网络请求后,NSURLProtocol会依次执行下列方法:
+ (BOOL)canInitWithRequest:(NSURLRequest *)request
/*
(1).处理返回YES,不处理返回NO
(2).打标签,已经处理过的不在处理
*/
+ (BOOL)canInitWithRequest:(NSURLRequest *)request
{
NSString *url = request.URL.absoluteString;
if ([url containsString:@".jpg"] || [url containsString:@".jpeg"] || [url containsString:@".png"]) {
//处理过的,放过
if ([NSURLProtocol propertyForKey:URLProtocolHandledKey inRequest:request]) {
return NO;
}
return YES;
}
return NO;
}
该方法会拿到request的对象,我们可以通过该方法的返回值来筛选request是否需要被NSURLProtocol做拦截处理。
这里我们需要缓存图片的request 所以判断url是否是图片格式再进行拦截
[NSURLProtocol propertyForKey:URLProtocolHandledKey inRequest:request]
该方法是判断这个request是否处理过的。在后面处理request的时候会对request进行标记
+ (NSURLRequest *)canonicalRequestForRequest:(NSURLRequest *)request
+ (NSURLRequest *)canonicalRequestForRequest:(NSURLRequest *)request
{
return request;
}
在该方法中,我们可以对request进行处理。例如修改头部信息等。最后返回一个处理后的request实例。如果需要处理 对request进行mutableCopy然后进行修改
这里我们只对WebView的图片做缓存 所以对request不做修改
- (void)startLoading
- (void)startLoading
{
NSMutableURLRequest *mutableReqeust = [[self request] mutableCopy];
NSString *url = self.request.URL.absoluteString;
dispatch_async(dispatch_get_global_queue(0, 0), ^{
UIImage *image = [[SDWebImageManager sharedManager].imageCache imageFromCacheForKey:url];
if (image) {
NSData *data = [[SDWebImageCodersManager sharedInstance] encodedDataWithImage:image format:SDImageFormatUndefined];
NSURLResponse *res = [[NSURLResponse alloc] initWithURL:self.request.URL MIMEType:@"image/*;q=0.8" expectedContentLength:data.length textEncodingName:nil];
[self.client URLProtocol:self didReceiveResponse:res cacheStoragePolicy:NSURLCacheStorageNotAllowed];
[self.client URLProtocol:self didLoadData:data];
[self.client URLProtocolDidFinishLoading:self];
} else {
//request处理过的放进去
[NSURLProtocol setProperty:@YES forKey:URLProtocolHandledKey inRequest:mutableReqeust];
[[SDWebImageManager sharedManager].imageDownloader downloadImageWithURL:self.request.URL options:SDWebImageDownloaderHighPriority progress:nil completed:^(UIImage * _Nullable image, NSData * _Nullable data, NSError * _Nullable error, BOOL finished) {
if (error) {
[self.client URLProtocol:self didFailWithError:error];
} else {
[[SDWebImageManager sharedManager].imageCache storeImageDataToDisk:data forKey:url];
NSURLResponse *res = [[NSURLResponse alloc] initWithURL:self.request.URL MIMEType:@"image/*;q=0.8" expectedContentLength:data.length textEncodingName:nil];
[self.client URLProtocol:self didReceiveResponse:res cacheStoragePolicy:NSURLCacheStorageNotAllowed];
[self.client URLProtocol:self didLoadData:data];
[self.client URLProtocolDidFinishLoading:self];
}
}];
}
});
}
在这个方法里 处理我们拦截到的webview图片加载的request
在这里判断url对应的图片在本地是否有缓存,如果有 就直接调用
[self.client URLProtocol:self didLoadData:data];
[self.client URLProtocolDidFinishLoading:self];
如果不存在缓存,就去请求
/*!
@abstract Returns the NSURLProtocolClient of the receiver.
@result The NSURLProtocolClient of the receiver.
*/
@property (nullable, readonly, retain) id <NSURLProtocolClient> client;
client是一个遵守了NSURLProtocolClient协议的对象
NSURLProtocolClient协议主要用到下面几个方法:
- (void)URLProtocol:(NSURLProtocol *)protocol didReceiveResponse:(NSURLResponse *)response cacheStoragePolicy:(NSURLCacheStoragePolicy)policy;
- (void)URLProtocol:(NSURLProtocol *)protocol didLoadData:(NSData *)data;
- (void)URLProtocolDidFinishLoading:(NSURLProtocol *)protocol;
- (void)URLProtocol:(NSURLProtocol *)protocol didFailWithError:(NSError *)error;