NSURLProtocol拦截网络请求用法与理解

NSURLProtocol

官方解释一个抽象类,用于处理特定于协议的URL数据的加载。

使用方法

不要NSURLProtocol直接实例化子类。而是为您的应用支持的任何自定义协议或URL方案创建子类。下载开始时,系统会创建相应的协议对象来处理相应的URL请求。您可以在应用程序的启动时间内定义协议类并调用类方法,以便系统了解您的协议。registerClass:

用NSURLProtocol可以统一处理app内你发的协议,例如你要对请求头进行处理加工,对请求以及响应处理都是个不错的地方

1.首先创建一个继承于NSURLProtocol的类

#import 

@interface XiaDianProtocol : NSURLProtocol

@end

2.然后先在app开启的时候加入如下代码,注册自定义协议类,这样你发的请求都会通过你这类进行过滤在进行下一步操作

[NSURLProtocol registerClass:[XiaDianProtocol class]];
NSURLProtocol拦截网络请求用法与理解_第1张图片
过滤网络请求

3.写一个简单网络请求,API在网上找的看一下效果

  //创建一个网络路径
    NSString *browseUrl = [NSString stringWithFormat:@"https://www.sojson.com/open/api/weather/json.shtml?city=%@", @"北京"];
    //处理一下特殊字符汉字等
    browseUrl =  [browseUrl stringByAddingPercentEncodingWithAllowedCharacters:[NSCharacterSet URLFragmentAllowedCharacterSet]];
    //创建一个网络请求
    NSURLRequest *request =[NSURLRequest requestWithURL:[NSURL URLWithString:browseUrl]];
    //创建一个Task任务:
    NSURLSession *session = [NSURLSession sharedSession];
    NSURLSessionDataTask *sessionDataTask = [session dataTaskWithRequest:request completionHandler:^(NSData * _Nullable data, NSURLResponse * _Nullable response, NSError * _Nullable error) {
        if (data == nil) {
            return ;
        }
         NSDictionary *dict = [NSJSONSerialization JSONObjectWithData:data options:(NSJSONReadingMutableLeaves) error:nil];
        NSLog(@"从服务器获取到数据%@", dict);
    }];
    NSLog(@"sessionDataTask------>%p", sessionDataTask);
    //执行任务
    [sessionDataTask resume];

4.运行结果当然是崩的 因为protocol里有必须要实现的方法 要不崩至少要实现有下面几个API

方法API 注释
+ (BOOL)canInitWithRequest:(NSURLRequest *)request; 确定协议子类是否可以处理指定的请求。
- (void)startLoading; 启动特定于协议的请求加载。
- (void)stopLoading; 停止特定于协议的请求加载。
+ (NSURLRequest *)canonicalRequestForRequest:(NSURLRequest *)request; 返回指定请求的规范版本。

5.把这四个都实现一下,不要返回值的都可以先空着

// return YES 就是都进行处理抓到就处理
+ (BOOL)canInitWithRequest:(NSURLRequest *)request{
    return YES;
}
//返回规范版本的请求一般直接返回,改变影响查找URL缓存中的对象
+ (NSURLRequest *)canonicalRequestForRequest:(NSURLRequest *)request{
    return request;
}
// 启动特定于协议的请求加载。
- (void)startLoading{
}
// 停止特定于协议的请求加载。
-(void)stopLoading{
}

6.运行发送请求正常顺序就是canInitWithRequest-》canonicalRequestForRequest-》startLoading-》stopLoading

但你会发现你的网络请求都会是超时的,接收不到数据了
因为你拦截了你发的网络请求然后什么也没有做,这个请求就相当于没有发......所以我们要完善一下startloading方法里的东西 这里我们要做的事就是把拦截的请求发出去然后返回到外面的请求回调里

- (void)startLoading{
   //复制一份获取拦截的请求
    NSMutableURLRequest *request = [self.request copy];   
    NSURLSessionDataTask *sessionDataTask = [[NSURLSession sharedSession] dataTaskWithRequest:self.request completionHandler:^(NSData * _Nullable data, NSURLResponse * _Nullable response, NSError * _Nullable error) {
       //将获取的数据回传给外面的请求
        [self.client URLProtocol:self didLoadData:data];
        [self.client URLProtocol:self didReceiveResponse:response cacheStoragePolicy:NSURLCacheStorageNotAllowed];
        [self.client URLProtocol:self didFailWithError:error];
        [self.client URLProtocolDidFinishLoading:self];
    }];
    [sessionDataTask resume];
}

7.运行你会发现一个更大的问题 死循环了 因为你用的是NSURLSessionDataTask发的请求 还会被拦截到 拦截到再发 再拦,所以我们要对我们在startLoading里的请求做一下标识不让它被拦截 原理就是我们在request对象里人为的添加键值进行标识是否被处理了 如果被处理了就在canInitWithRequest方法里返回No不拦截

//定义一个字符串做key
static NSString *xiaDianDealDone = @"xiaDianDealDone";
//修改后的startLoading方法
- (void)startLoading{
    NSMutableURLRequest *request = [self.request copy];
    //为request对象添加一个键值标记为YES
    [NSURLProtocol setProperty:@(YES) forKey:xiaDianDealDone inRequest:request];
    
    NSURLSessionDataTask *sessionDataTask = [[NSURLSession sharedSession] dataTaskWithRequest:self.request completionHandler:^(NSData * _Nullable data, NSURLResponse * _Nullable response, NSError * _Nullable error) {
       //将获取的数据回传给外面的请求
        [self.client URLProtocol:self didLoadData:data];
        [self.client URLProtocol:self didReceiveResponse:response cacheStoragePolicy:NSURLCacheStorageNotAllowed];
        [self.client URLProtocol:self didFailWithError:error];
        [self.client URLProtocolDidFinishLoading:self];
    }];
    [sessionDataTask resume];
}
//处理后的canInitWithRequest方法
+ (BOOL)canInitWithRequest:(NSURLRequest *)request{
   //发现是处理过的请求直接返回No不拦截此请求
    if ([NSURLProtocol propertyForKey:xiaDianDealDone inRequest:request]) {
        return NO;
    }
    return YES;
}

8.这时候运行就可以在外部获得网络数据了 在外面的请求完全看不出来做了什么处理。如果你要对网络请求统一做某些处理的时候就在这个protol中就好了

理解

每个网络请求被拦截的时候系统都会生成一个protocol子类的对象
这个对象有俩个重要属性用来处理这个请求

属性 类型 注释
request NSURLRequest 拦截的请求的request对象有这个对象能获取很多request信息
client id 这个是回调回去重要的属性,每发一个网络请求系统应该都会产生一个client对象来处理网络请求进行回调等操作,而所有的client对象都应该遵守的协议 这样我们通过回调协议的方法就可以把数据以及响应返回最初的请求

总结

1.startLoading 里面随便你用什么再次发送拦截的网络请求 只要能请求就行
2.startLoading里对应的回调方法要回调对应的协议方法,这样就能对应的在外面获取到对应的响应
3.注意死循环发送,加上标识。
4.给予苹果NSURLSession或NSURLConnection的http,https请求可以拦截 如果公司自己实现的应用层协议就不好使了。
5.还有一点多次注册protocol子类会按照后注册的线调用来运行 如果处理的请求就不在像后找,没处理就接着向后寻找处理protocol

NSURLProtocol很强大 在canInitWithRequest和startLoading里能做的事情就有很多,网络请求处理的黑魔法。

你可能感兴趣的:(NSURLProtocol拦截网络请求用法与理解)