iOS (三) - NSURLProtocol 的使用

随说 : 用着WebView作混编交互之后,发现其实网络的整个过程需要深入理解,才能做更多的事,于是整理了一下HTTP协议等有关的概念 , 其实这篇文章不单单说的是HTTP, 可以去看一下.一起进步
WebView交互, 说到底还是一个网页展示, 需要请求 - 需要响应, 需要遵守HTTP协议, 也会遵守TCP/IP 协议.
在IOS中, 是用了NSURLConnection这个类作为连接.发出请求,接收响应都能用到他,当然IOS7以后,新增的NSURLSession(建议以后都用这个类,AFN3.0都不用NSURLConnection了)

NSURLProtocol是什么?

NSURLProtocol是个抽象类,只要理解为不能直接实例化它,想用它的方法,就去继承它.
NSURLProtocol是NSURLConnection的handle类, 它更像一套协议,如果遵守这套协议,网络请求Request都会经过这套协议里面的方法去处理.
再说简单点,就是对上层的URLRequest请求做拦截，并根据自己的需求场景做定制化响应处理。

图解 : NSURLProtocol 能在系统执行 URLRequest前先去将URLRequest处理了一遍.

NSURLProtocol的方法属性##

// 这个方法是注册NSURLProtocol子类的方法.
+ (BOOL)registerClass:(Class)protocolClass;

// 这个方法是注册后,NSURLProtocol就会通过这个方法确定参数request是否需要被处理
// return : YES 需要经过这个NSURLProtocol"协议" 的处理, NO 这个 协议request不需要遵守这个NSURLProtocol"协议"
// 这个方法的左右 : 1, 筛选Request是否需要遵守这个NSURLRequest , 2, 处理http: , https等URL
+ (BOOL)canInitWithRequest:(NSURLRequest *)request;

// 这个方法就是返回request,当然这里可以处理的需求有 : 1,规范化请求头的信息 2, 处理DNS劫持,重定向App中所有的请求指向等
+ (NSURLRequest *)canonicalRequestForRequest:(NSURLRequest *)request;

// 这个方法主要用来判断两个请求是否是同一个请求，如果是，则可以使用缓存数据，通常只需要调用父类的实现即可,默认为YES,而且一般不在这里做事情
+ (BOOL)requestIsCacheEquivalent:(NSURLRequest *)a toRequest:(NSURLRequest *)b;

// abstract Initializes an NSURLProtocol given request, cached response, and client.
// 开始初始化一个NSURLProtocol抽象对象, 包含请求, cachedResponse , 和建立client
- (instancetype)initWithRequest:(NSURLRequest *)request cachedResponse:(nullable NSCachedURLResponse *)cachedResponse client:(nullable id <NSURLProtocolClient>)client NS_DESIGNATED_INITIALIZER;

// 需要在该方法中发起一个请求，对于NSURLConnection来说，就是创建一个NSURLConnection，对于NSURLSession，就是发起一个NSURLSessionTask
// 另外一点就是这个方法之后,会回调<NSURLProtocolClient>协议中的方法,
- (void)startLoading

// 这个方法是和start是对应的 一般在这个方法中,断开Connection
// 另外一点就是当NSURLProtocolClient的协议方法都回调完毕后,就会开始执行这个方法了
- (void)stopLoading

/*! 
    @method client
    @abstract Returns the NSURLProtocolClient of the receiver. 
    @result The NSURLProtocolClient of the receiver.  
*/
@property (nullable, readonly, retain) id <NSURLProtocolClient> client;

/*! 
    @method request
    @abstract Returns the NSURLRequest of the receiver. 
    @result The NSURLRequest of the receiver. 
*/
@property (readonly, copy) NSURLRequest *request;

/*! 
    @method cachedResponse
    @abstract Returns the NSCachedURLResponse of the receiver.  
    @result The NSCachedURLResponse of the receiver. 
*/
@property (nullable, readonly, copy) NSCachedURLResponse *cachedResponse;

<NSURLProtocolClient> 的协议方法, 一般和NSURLConnection的代理方法一起使用

随笔 : 其实在总结的过程中,能感受到苹果对类的一种设计思想,我也不知道怎么说,基本就是,"恰到好处"

NSURLProtocol的用法##

以加载一个webView为例 :

// 程序加载的时候
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
    // 注册TravinURLProtocol,这一步必须要做,注册之后,才能执行Connection的handle,执行handle的方法
    [NSURLProtocol registerClass:[TravinURLProtocol class]];
    return YES;
}

最简单的加载一个webView,当loadRequest:开始发送的时候,就开始执行NSURLProtocol里面的方法

    UIWebView *webView = [[UIWebView alloc] initWithFrame:[UIScreen mainScreen].bounds];
    self.view = webView;
    NSURL *url = [NSURL URLWithString:@"http://www.jianshu.com/p/ec5d6c204e17"];
    NSURLRequest *request = [NSURLRequest requestWithURL:url];
    [webView loadRequest:request];

开始跳进NSURLProtocol执行方法

static NSString *const TravinProtocolHandledKey = @"TravinProtocolHandledKey";


// 这个方法是注册后,NSURLProtocol就会通过这个方法确定参数request是否需要被处理
// return : YES 需要经过这个NSURLProtocol"协议" 的处理, NO 这个 协议request不需要遵守这个NSURLProtocol"协议"
// 这个方法的左右 : 1, 筛选Request是否需要遵守这个NSURLRequest , 2, 处理http: , https等URL
+ (BOOL)canInitWithRequest:(NSURLRequest *)request
{
    //只处理http和https请求
    NSString *scheme = [[request URL] scheme];
    if ( ([scheme caseInsensitiveCompare:@"http"] == NSOrderedSame || [scheme caseInsensitiveCompare:@"https"] == NSOrderedSame))
    {
        //看看是否已经处理过了，防止无限循环
        if ([NSURLProtocol propertyForKey:TravinProtocolHandledKey inRequest:request]) {
            return NO;
        }
        
        return YES;
    }
    return NO;
}

// 这个方法就是返回request,当然这里可以处理的需求有 : 
// 1,规范化请求头的信息 2, 处理DNS劫持,重定向App中所有的请求指向等
+ (NSURLRequest *)canonicalRequestForRequest:(NSURLRequest *)request {
    return request;
}

// 这个方法主要用来判断两个请求是否是同一个请求，
// 如果是，则可以使用缓存数据，通常只需要调用父类的实现即可,默认为YES,而且一般不在这里做事情
+ (BOOL)requestIsCacheEquivalent:(NSURLRequest *)a toRequest:(NSURLRequest *)b
{
    return [super requestIsCacheEquivalent:a toRequest:b];
}

// 开始初始化一个NSURLProtocol抽象对象, 包含请求, cachedResponse , 和建立client
- (instancetype)initWithRequest:(NSURLRequest *)request cachedResponse:(NSCachedURLResponse *)cachedResponse client:(id<NSURLProtocolClient>)client
{
    self = [super initWithRequest:request cachedResponse:cachedResponse client:client];
    if (self) {
        
    }
    return self;
}

// 需要在该方法中发起一个请求，对于NSURLConnection来说，就是创建一个NSURLConnection，对于NSURLSession，就是发起一个NSURLSessionTask
// 另外一点就是这个方法之后,会回调<NSURLProtocolClient>协议中的方法,
- (void)startLoading
{
    NSString *cacheKey = self.request.URL.absoluteString;
    // 1.根据URL作为KEY,利用PRCachedURLResponse创建缓存
    TravinCachedURLResponse *cachedResponse = [[TravinObjectCache sharedCache] objectForKey:cacheKey]; //根据请求的URL,获取缓存,
    if (cachedResponse && cachedResponse.response && cachedResponse.data) { // 如果有缓存
       
        NSURLResponse *response = cachedResponse.response;
        NSData *data = cachedResponse.data;
        
        [self.client URLProtocol:self didReceiveResponse:response cacheStoragePolicy:NSURLCacheStorageNotAllowed];
        [self.client URLProtocol:self didLoadData:data];
        [self.client URLProtocolDidFinishLoading:self];
        return;
    }
    
    NSMutableURLRequest *newRequest = [self.request mutableCopy];
    [newRequest setTimeoutInterval:15]; // 设置超时请求
    // 给我们处理过的请求设置一个标识符, 防止无限循环,
    [NSURLProtocol setProperty:@YES forKey:TravinProtocolHandledKey inRequest:newRequest];
    // 1.根据URL作为KEY,利用PRCachedURLResponse创建缓存,如果没,则创建一个NSURLConnection，将处理的request与这个connection钩起来，同时实现NSConnectionDataDelegate的回调
    self.connection = [NSURLConnection connectionWithRequest:newRequest delegate:self]; // 创建connection
    
    
    
    
    NSMutableURLRequest *mutableReqeust = [[self request] mutableCopy];
    //标示改request已经处理过了，防止无限循环
    [NSURLProtocol setProperty:@YES forKey:TravinProtocolHandledKey inRequest:mutableReqeust];
    self.connection = [NSURLConnection connectionWithRequest:mutableReqeust delegate:self];
}

// 这个方法是和start是对应的 一般在这个方法中,断开Connection
// 另外一点就是当NSURLProtocolClient的协议方法都回调完毕后,就会开始执行这个方法了
- (void)stopLoading
{
    // 断开连接
    [self.connection cancel];
}

使用中的一些坑##

在开发过程中,遇到的一些问题总结一下

如果注册了两个NSURLProtocol,执行顺序是怎样?###

Protocols的遍历是反向的，也就是最后注册的Protocol会被优先判断。
如下图, 先注册AAAA,再注册BBBB的话优先判断的是BBBB,

系列的其他整理

[IOS混合编程 - UIWebView 与 WKWebView . 基本使用 (一)][1]
[IOS混合编程 - Http for IOS (二)][2]
[IOS混合编程 - NSURLProtocol 的使用 (三)][3]