NSURLProtocol以及GYHttpMock学习记录

NSURLProtocol的使用

  • 注册protocol。
Class cls = NSClassFromString(@"__NSCFURLSessionConfiguration") ?: NSClassFromString(@"NSURLSessionConfiguration");
[self swizzleSelector:@selector(protocolClasses) fromClass:cls toClass:[self class]];

以上方法适合于NSURLSession的网络请求,替换掉protocolClasses。如果使用的是NSURLConnection,则应使用下面的方法:
[NSURLProtocol registerClass:[GYMockURLProtocol class]];

  • 实现protocol中必须实现的方法。
+ (BOOL)canInitWithRequest:(NSURLRequest *)request;
+ (NSURLRequest *)canonicalRequestForRequest:(NSURLRequest *)request;
+ (BOOL)requestIsCacheEquivalent:(NSURLRequest *)a toRequest:(NSURLRequest *)b;
- (id)initWithRequest:(NSURLRequest *)request cachedResponse:(NSCachedURLResponse *)cachedResponse client:(id<NSURLProtocolClient>)client;
- (void)startLoading;
- (void)stopLoading;

canInitWithRequest是自己注册的URLProtocol类(比如此处的GYMockURLProtocol)的方法入口。只有这个方法返回YES时,才会执行下面的方法,返回NO时就直接运行系统的方法。

canonicalRequestForRequest返回规范化的request。This method returns a canonical version of the given request。一般直接返回传入的request,而且不要在这里做规范化的操作,否则可能出现反复调用等奇怪现象。

requestIsCacheEquivalent请求是使用缓存还是发起新请求。直接返回NO,设置每次都发起新请求。

- (id)initWithRequest:(NSURLRequest *)request cachedResponse:(NSCachedURLResponse *)cachedResponse client:(id<NSURLProtocolClient>)client;初始化方法,非必须实现。

startLoading核心方法,真正的网络请求和mock方法这这个方法里面定义并执行。

stopLoading网络请求完成后需要调用的方法。

GYHttpMock使用示例:

  1. 添加需要mock的地址mockRequest(@"GET", @"https://httpbin.org/get").isUpdatePartResponseBody(YES);
  2. 发起网络请求
NSURLSession * session = [NSURLSession sharedSession];
   [[session dataTaskWithURL:[NSURL URLWithString:@"https://httpbin.org/get"] completionHandler:^(NSData * _Nullable data, NSURLResponse * _Nullable response, NSError * _Nullable error) {
       if (error) {
           NSLog(@"%@",error);
       }else{
           NSLog(@"%@",data);
       }
   }] resume];

第二步中发起的网络请求就会被GYHttpMock mock住。

注意:如果第一步中不添加isUpdatePartResponseBody(YES),则第二步中发起的网络请求就会被GYHttpMock mock住,不会真的发起网络请求,只是返回code码是200的请求头。当添加了isUpdatePartResponseBody(YES)时才会发起网络请求。

关于GYHttpMock的具体API见微信团队的博客

代码详解:

mockRequest方法会初始化GYHttpMock,添加两个hook。依据传入的URL和方法名创建GYMockRequest实例并保存。添加的两个hook是:GYNSURLConnectionHook,GYNSURLSessionHook。命名看起来是添加两个hook,其实是在完成上面说的方法注册和方法交换的功能。

当发起网络请求时,会先调用GYHttpMockcanInitWithRequest方法。此时会检查第一步中是否有该url对应的GYMockRequest实例,如果有则返回YES,表明我们想要自己拦截请求或者修改response,GYHttpMockstartLoading等方法会被调用。如果返回NO就会把控制权交还给系统。

GYHttpMock使用的是NSURLConnection发起真正的网络请求。

无论是拦截请求,还是修改response,都应该主动调用

- (void)URLProtocol:(NSURLProtocol *)protocol didReceiveResponse:(NSURLResponse *)response cacheStoragePolicy:(NSURLCacheStoragePolicy)policy;
- (void)URLProtocol:(NSURLProtocol *)protocol didLoadData:(NSData *)data;
- (void)URLProtocolDidFinishLoading:(NSURLProtocol *)protocol;

URLProtocol的方法,将最终数据返回给系统,系统会将数据传递给外部的网络请求者,比如AFNetworking或者NSURLSession的delegate。

GYHttpMock还有一个值得一提的点是他使用了函数式编程的思想。GYMockRequestDSLGYMockResponseDSL里面通过block实现了函数式编程。实现方法是定义blcok属性,在block中完成操作,并最终在block中将self返回给调用者。
举例如下:

typedef GYMockResponseDSL *(^ResponseWithHeadersMethod)(NSDictionary *);
@property (nonatomic, strong, readonly) ResponseWithHeaderMethod withHeader;
- (ResponseWithHeadersMethod)withHeaders; {
    return ^(NSDictionary *headers) {
        for (NSString *header in headers) {
            NSString *value = [headers objectForKey:header];
            [self.response setHeader:header value:value];
        }
        return self;
    };
}

GYHttpMock修改网络返回数据需要调用者清楚返回数据的结构,并预先定义好和该结构相符的字典才能完成修改。具体的修改过程是通过 递归,层级检查返回的json结构,在合适的地方添加新内容。调用的方法如下:
- (void)addEntriesFromDictionary:(NSDictionary *)dict to:(NSMutableDictionary *)targetDict

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 201,681评论 5 474
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 84,710评论 2 377
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 148,623评论 0 334
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,202评论 1 272
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,232评论 5 363
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,368评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,795评论 3 393
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,461评论 0 256
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,647评论 1 295
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,476评论 2 317
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,525评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,226评论 3 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,785评论 3 303
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,857评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,090评论 1 258
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,647评论 2 348
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,215评论 2 341

推荐阅读更多精彩内容