我们在开发过程中,很多时候可能都需要Mock一个后台,原因可能是下面两种:
- 后台没开发完,只有文档,前端开发又需要数据来方便开发
- 测试需要,我们单元测试需要各种情况,很多情况是我们正常情况后台无法提供的,而且显然我们也不应该向真实后台提交各种测试数据。
那么针对上面两种不同的需求,我们提供不同的方案
为了方便开发
对于这种需求我个人觉得最好可以不要在项目中写关于mock的代码,这里推荐两种方案,两种方案都几乎不需要在项目中写关于mock的代码,只需要修改项目中服务器地址就好了。
Postman
postman是一款非常常用的模拟请求的工具,相信大家对他都不陌生。postman方案的优势就是有UI页面,可操作起来更直观一些
首先我们点击左上角的new按钮
然后选择Mock server
然后按照提示一步一步,设置路径,设置response内容等等一些内容
[图片上传失败...(image-35a1aa-1545309290011)]
如果设置后还需要修改返回内容,参考下图,点击右上角的按钮就可以进行修改
[图片上传失败...(image-78bc64-1545309290011)]
moco
moco是一个java的后端,下载安装之后,我们就可以直接编写一个JSON格式的文件,一行命令便可以完成这个使命
使用时就将你的app host地址改为localhost:设置的端口,然后就可以获取之前你写好的json数据
java -jar pathto/Moco-runner-<version>-standalone.jar http -p 12306 -c pathTo/foo.json
需要注意的是,如果开了全局翻墙,需要改成auto proxy mode,否则请求就会失败
为了测试
这种为了单元测试的情况,虽然上面提到的方案其实也是可以完成测试的,但是还需要依赖项目外的环境设置,不是那么完美。那么我们就有必要把代码写在项目中,以实现不依赖项目外的环境完成测试
其实这里准确的说法应该是Stub
假定我们是使用Apple自带的XCTest
由于网络请求是异步的,所以单元测试需要使用XCTestExpectation
waitForExpectations
fullfile
配合完成测试,这部分就不再赘叙了,我们就直奔主题
我们需要一个第三方库的帮助,OHHTTPStubs
这个库主要是把你的请求拦截下来,然后返回你指定的内容,可以是你写好的json文件
我们先设置好stub,我们把URL最后一部分是“listItems”的请求拦截下来,返回httpStub.json文件中的内容。这里其实可以设置其他的内容,比如把某个Host的请求全部拦截了,这都是可以设置的,大家可以看下OHHTTPStubs仓库中的demo
- (void)installStubs {
[OHHTTPStubs stubRequestsPassingTest:^BOOL(NSURLRequest * _Nonnull request) {
return [request.URL.lastPathComponent isEqualToString:@"listItems"];
} withStubResponse:^OHHTTPStubsResponse * _Nonnull(NSURLRequest * _Nonnull request) {
return [[OHHTTPStubsResponse responseWithFileAtPath:OHPathForFile(@"httpStub.json", self.class)
statusCode:200
headers:@{@"Content-Type":@"application/json; charset=utf-8"}]
requestTime:0.5f
responseTime:OHHTTPStubsDownloadSpeedWifi];
}];
}
这个方法需要在测试真正开始前配置好,所以我们在setUp方法中调用installStubs
- (void)setUp {
// Put setup code here. This method is called before the invocation of each test method in the class.
[self installStubs];
}
我们command+U
测试一下,返回了我们json文件中的内容。到这里我们就完成了测试中模拟数据的部分
总结
我们文章中介绍了三种方式,其实我个人是最喜欢最后一种,为什么呢?
首先,他完全可以在取代前面两种方式,而且不依赖网络不依赖第三方软件,虽然侵入了项目,但是好在不是很多,可以通过IF DEBUG的方式确保就算我们忘记移除,也不会影响release的版本。
再其次,为了做了这个就基本完成了这个接口网络请求的单元测试用例,简直一举两得,虽然iOS开发这个领域,测试并没有那么普及,大家也普遍没有做这项工作,但是测试确实是保证项目质量的重要方式,养成写测试用例的习惯可以帮我们提前发现很多的bug。
参考资料
Postman Setting up a mock serve
Real-World Testing with XCTest
The complete guide to Network Unit Testing in Swift
Asynchronous Tests and Expectations