iOS开发自给自足的Mock数据
写这篇的主要原因是开发中遇到了一些让人不舒服,也很无奈的一些事或者流程。
问题是这样的:
1.客户端开发结束但接口迟迟不给,工期也快到了,催基本没什么结果。
2.开发网络环境经常性的被铲除或因为后台调试环境,一直处于异常。
3.等等一些其他原因,不说了。
如何自给自足完成客户端开发流程(而非联调)呢,Mock数据似乎是最好的方案之一,好吧继续看,先做再说。
一、整体实现架构
方案1:可以是编写假接口如下
- (void)queryServerDataWithRequest:(NSURLRequest *)request completion:(void(^)(id data, NSError *error))completion {
dispatch_after(dispatch_time(DISPATCH_TIME_NOW, (int64_t)(1 * NSEC_PER_SEC)), dispatch_get_main_queue(), ^{
NSDictionary *param = @{@"key1":@"value1",@"key2":@"value2",@"key3":@"value3",@"key4":@"value4"};
if(completion) {
completion(param, nil);
}
});
}
方案2:可以设架Mock服务器,请求和正常的请求一样,重点在Mock服务器,关键还是对别人有依赖。
那么客户端又没什么更好点的方法,自给自足不写假接口呢?当然有,我真理的方案是用苹果的黑魔法NSURLProtocol,拦截请求并接管,将事先准备好的请求数据下发给接口。
Mack框架先看图,接口发出请求被NSURLProtocol拦截,此时此刻请求的控制权就到你手上了:
1.可以继续发起请求把请求的数据转接给接口,监控了数据。
2.从本地读取已经准备好的数据,根据请求过来的参数选择不同的数据给请求接口(就算没网络也可以让接口正常返回数据)。
二、具体实现Mock代码
首先需要注册NSURLProtocol子类作为监听接口:
static NSString* const URLProtocolHandledKey = @"URLProtocolHandledKey";
static IMP g_implementationFunc = NULL;
@implementation DPRequestMonitor
static NSArray *ProtocolClasses(id self, SEL _cmd) {
return @[[DPRequestMonitor class]];
}
+ (void)load {
[NSURLProtocol registerClass:self];
Class cls = NSClassFromString(@"__NSCFURLSessionConfiguration") ?: NSClassFromString(@"NSURLSessionConfiguration");
Method method = class_getInstanceMethod(cls, @selector(protocolClasses));
method_setImplementation(method, (IMP)ProtocolClasses);
}
//更多函数实现省略。。。
@end
实现部分还有其他配合如下:
+ (BOOL)canInitWithRequest:(NSURLRequest *)request;
+ (NSURLRequest *)canonicalRequestForRequest:(NSURLRequest *)request;
- (void)startLoading;
- (void)stopLoading;
在startLoading中实现如下:
- (void)startLoading {
[NSURLProtocol setProperty:@(YES) forKey:URLProtocolHandledKey inRequest:(NSMutableURLRequest *)self.request];
[DPResponseManager queryDataWithKey:self.request completion:^(NSData *data, NSError *error) {
if(!error) {
//[self.client URLProtocol:self didReceiveResponse:nil cacheStoragePolicy:NSURLCacheStorageNotAllowed];
[self.client URLProtocol:self didLoadData:data];
[self.client URLProtocolDidFinishLoading:self];
}
else {
[self.client URLProtocol:self didFailWithError:error];
}
}];
}
下面说明下接口返回的数据:
[DPResponseManager queryDataWithKey]
首先返回是一个json格式数据,这种数据来源于plist(方便编辑)。
本地数据目录 plist文件内容结构IgnoreRequestParam:目的在于忽略Mock请求是否关心上行参数,不管心的情况下默认读取并返回response1
RequestParam:请求上行参数,当IgnoreRequestParam等于NO时用此参数配对ResponseData,如request1 <-> response1
ResponseData:用来配置接口返回数据。
至此,不要动工程代码的情况下,你可以封装程framework,在提交测试前记得移除,怕出错可以做成工程可配置话。简单的mock基本实现,开发不再依赖后台接口,而且返回的数据想怎么修改怎么修改,不再看脸色吃饭了。顺利开发完成就等联调进测试。
三、好用的Mock工具会更友好
自此自给自足的Mock可以算是结束了,但是如何再次基础上做的更好呢??
比如关注开发A接口,但是希望用户可以登陆状态获取用户信息参数,因此你需要这么做:
代码写死跳过登陆,直接写死用户信息参数,直接调起A接口对应的模块,编写Mock数据。当然也有其他方法可以解决这样的问题。
但是我这边打算介绍的是如何简单而不改写过多的代码实现一套完整的Mock系统(不过这里不会过于复杂描述,更多细节后续有时间再补充)。
改进框架在开发App前链接到生产环境,获取接口控制权,此刻发起网络请求并获取到线上的正常交互数据并保存到本地,可按照请求接口连接的path来布置获取的数据保存文件,文件格式建议使用plist。也就是上面做开发用的Mock数据。
多点击几个页面,尤其是自己关心的页面,以及将要开发的页面必进过的页面。登陆流程等等。这一步其实是采集数据。
总结:至此请求Mock的系统可以完成数据采集、手动修改、手动添加接口、使用Mock数据等工作。
除此之外可以有更多想法,比如采集这一块保留,但是做Mock的这一部分移植到自建服务器,数据来自于客户端收集。这样一来多平台可以开发使用。
实现过程基本结束,有兴趣更多细节可以留言,有不妥的地方欢迎拍砖。