一般做法(The Usual Setup)
我们有一个App,展示来自世界各地的图片和信息。当然,我们的信息应该是从API中抓去的。为了做到这点,通常我们会有一个API请求的对象。
struct FoodService {
func get(completionHandler:Result<[Food]> -> Void){
//make asynchronous API call
//and return appropriate
}
}
既然我们做一个异步的API调用,我们不能使用swift内置的错误处理返回一个正确的response或者throw一个error。相反,使用Result enum
是一个很好的实践。你可以从这里了解到更多关于Result enum
的信息,但是基础的用法如下:
enum Result<T> {
case Success(T)
case Failure(ErrorType)
}
当API调用成功,携带有正确承载对象的Success result
被传入到completion handler中。在FoodService中,success result包含foot object
的array
。如果没有成功,失败的result被return,result中会有一个失败发生时的error (eg.400)。
FoodService的get方法,通常在ViewController中被调用。ViewController决定如何处理成功或失败的Result:
//FoodLaLaViewController
var dataSource = [Food]() {
didSet {
tableView.reloadData()
}
}
override func viewDidLoad() {
super.viewDidLoad()
getFood()
}
private func getFood() {
//the get function is called here
FoodService().get() { [weak self] result in
switch result {
case .Success(let food):
self?.dataSource = Food
case .Failure(let error):
self?.showError(error)
}
}
}
但是有一个问题....
问题(The Problem)
ViewController的getFood () 方法是controller中最重要的方法。毕竟如果API没有被正确调用,结果没有被正确的处理,controller就不能在屏幕上正确的展示美食。为了确保我们的假设能够起作用,为controller写test就非常重要了。
说实话,其实测试它没有那么糟糕....有一个另辟蹊径的方法能够让你的view controller开始测试。
好了,我们准备开始测试我们的view controller了。
依赖注入(Dependency Injection)
为了测试ViewController的getFood()方法的正确性,我们需要注入FoodService到VC中,只需要在function中注入它。
//FoodLaLaViewController
override func viewDidLoad(){
super.viewDidLoad()
//passing in a default food service
getFood(fromService:FoodService())
}
//The FoodService is now injected!
func getFood(fromService service:FoodService) {
service.get() { [weak self] result in
switch result {
case .Success(let food):
self?.dataSource = food
case .Failure(let error):
self?.showError(error)
}
}
}
下面至少给出了测试的开始:
//FoodLaLaViewControllerTests
func testFetchFood() {
viewController.getFood(fromService: FoodService())
// 🤔 now what?
}
Protocols FTW
下面是我们FoodService的正确版本
struct FoodService {
func get(completionHandler: Result<[Food]> -> Void) {
// make asynchronous API call
// and return appropriate result
}
}
因为测试的目的,我们需要能够重写get function,为了能够控制被传入ViewController的Result。这样我们能测试ViewController对于成功和失败的处理。
因为FoodService是一个结构体,我们不能子类化它。作为替代,你可以猜中,我们能够使用protocols。
实际上,你能够把大部分的方法移动到一个简单的protocol中:
protocol Gettable {
associatedtype Data
func get(completionHandler: Result<Data> -> Void)
}
注意associated type
,这个协议将会为所有的service服务。在这里我们在FoodService上使用这个协议,但是当然你能使用相同的协议在CakeService或DonutService上。通过使用generic protocol,你正添加一个很棒的格式到你应用的所有的service上。
现在,在FoodService中唯一的变化是,Service符合一个Gettable protocol协议。就是下面:
struct FoodService: Gettable {
// [Food] is inferred here as the correct associated type!
func get(completionHandler: Result<[Food]> -> Void) {
// make asynchronous API call
// and return appropriate result
}
}
使用这中方式另外一个好处是可读性。在FoodService里面,你立即可以看到Gettable,意思很明显。你可以用相同的模式来实现Creatable、Updatable、Delectable等。你可以立即知道service的作用,只要你看到它。
使用协议(Using the Protocol 💪)
所以现在,是时候来重构了。在ViewController中,为了替代 传FoodService到getFood方法中,我们能够通过接受一个Gettable来约束它。[Food]
作为associated type
// FoodLaLaViewController
override func viewDidLoad() {
super.viewDidLoad()
getFood(fromService: FoodService())
}
func getFood<Service: Gettable where Service.Data == [Food]>(fromService service: Service) {
service.get() { [weak self] result in
switch result {
case .Success(let food):
self?.dataSource = food
case .Failure(let error):
self?.showError(error)
}
}
}
现在我们可以很简单的测试它!
测试(Test All the Things!)
为了测试ViewController的getFood方法,我们用Gettable进行注入,使用[Food]
作为associated type
// FoodLaLaViewControllerTests
class Fake_FoodService: Gettable {
var getWasCalled = false
// you can assign a failure result here
// to test that scenario as well
// the food here is just an array of food for testing purposes
var result = Result.Success(food)
func get(completionHandler: Result<[Food]> -> Void) {
getWasCalled = true
completionHandler(result)
}
}
所以现在,我们可以通过诸如Fake_FoodService来测试,ViewController调用一个service来返回[Food]
作为成功的result并作为构成tableview的datasource。
// FoodLaLaViewControllerTests
class Fake_FoodService: Gettable {
var getWasCalled = false
// you can assign a failure result here
// to test that scenario as well
// the food here is just an array of food for testing purposes
var result = Result.Success(food)
func get(completionHandler: Result<[Food]> -> Void) {
getWasCalled = true
completionHandler(result)
}
}
你现在同样能为不同的失败的case写测试脚本。
结论(Conclusion)
在你的网络层使用协议让你的code更加通用、可注入、可测试、可读。