在Swift中进行面向协议的网络编程(Protocol-Oriented-Networking in Swift)

一般做法(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 objectarray。如果没有成功,失败的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更加通用、可注入、可测试、可读。

原文地址:Protocol-Oriented-Networking in Swift

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

推荐阅读更多精彩内容