用 Swift 编写面向协议的网络请求

和我一起参加9 月 1 日 - 9月 2 日在纽约举办的 Swift 社区庆典??吧!使用优惠码 NATASHATHEROBOT 可以获得 $100 的折扣!

我最近做了个 Swift 面向协议编程实践(POP??) 的演讲。视频还在处理中。另一方面,这是演讲中 POP 视图部分的文本记录,供我和其他任何人作参考!

普通的配置方式

假设我们要做一款展示全球美食图片和信息的 App。这需要从 API 上拉取数据,那么,用一个对象来做网络请求也就是理所当然的了:

struct FoodService {

    func get(completionHandler: Result<[Food]> -> Void) {        // 异步网络请求        // 返回请求结果    }}

一旦我们创建了异步请求,就不能使用 Swift 內建的错误处理来同时返回成功响应和请求错误了。不过,倒是给练习 Result 枚举创造了机会(更多关于 Result 枚举的信息可以参考 Error Handling in Swift: Might and Magic),下面是一个最基础的 Result 写法:

enum Result<T> {    case Success(T)    case Failure(ErrorType)}

当 API 请求成功,回调便会获得 Success 状态与能正确解析的数据 —— 在当前 FoodService 例子中,成功的状态包含着美食信息数组。如果请求失败,会返回 Failure 状态,并包含错误信息(如 400)。

FoodService 的 get 方法(发起 API 请求)通常会在 ViewController 中调用,ViewController 来决定请求成功失败后具体的操作逻辑:

// FoodLaLaViewController

var dataSource = [Food]() {    didSet {        tableView.reloadData()    }}

override func viewDidLoad() {    super.viewDidLoad()    getFood()}

private func getFood() {    // 在这里调用 get() 方法    FoodService().get() { [weak self] result in        switch result {        case .Success(let food):            self?.dataSource = food        case .Failure(let error):            self?.showError(error)        }    }}

但,这样处理有个问题…

有什么问题

关于 ViewController 中 getFood() 方法的问题是:ViewController 太过依赖这个方法了。如果没有正确的发起 API 请求或者请求结果(无论 Success 还是 Failure)没有正确的处理,那么界面上就没有任何数据显示。

为了确保这个方法没问题,给它写测试显得尤为重要(如果实习生或者你自己以后一不小心改了什么,那界面上就啥都显示不出来了)。是的,View Controller Tests ??!

说实话,它没那么麻烦。这有一个黑魔法来配置 View Controller 测试。

OK,现在已经准备好进行 View Controller 测试了,下一步要做什么?!

依赖注入

为了正确地测试 ViewController 中 getFood() 方法,我们需要注入 FoodService(依赖),而不是直接调用这个方法!

// FoodLaLaViewController

override func viewDidLoad() {    super.viewDidLoad()

    // 传入默认的 food service    getFood(fromService: FoodService())}

// FoodService 被注入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())

    // ?? 接下来?}

接下来,我们需要对 FoodService 返回值类型进行更多的约束。

绝杀 —— 协议

目前 FoodService 的结构体是这样:

struct FoodService {

    func get(completionHandler: Result<[Food]> -> Void) {        // 发起异步请求        // 返回请求结果    }}

为了方便测试,我们需要能够重写 get 方法,来控制哪个 Result(Success 或 Failure)传给 ViewController,之后就可以测试 ViewController 是如何处理这两种结果。

因为 FoodService 是结构体类型,所以不能对其子类化。但是,你猜怎样,我们可以使用协议来达到重写目的。

我们可以将功能性代码单独提到一个协议中:

protocol Gettable {    associatedtype Data

    func get(completionHandler: Result<Data> -> Void)}

注意这里标明了引用类型(associated type)。这个协议将会用在所有的 service 结构体上,现在我们只让FoodService 去遵循,但是以后还会有 CakeService 或者 DonutService 去遵循。通过使用这个通用性的协议,就可以在 App 中非常完美的统一所有 service 了。

现在,唯一需要改变的就是 FoodService —— 让它遵循 Gettable 协议:

struct FoodService: Gettable {

    // [Food] 用于限制传入的引用类型    func get(completionHandler: Result<[Food]> -> Void) {        // 发起异步请求        // 返回请求结果    }}

这样写还有一个好处 —— 良好的可读性。看到 FoodService 时,你会立刻注意到 Gettable 协议。你也可以创建类似的 CreatableUpdatableDelectable,这样,service 能做的事情显而易见!

使用协议 ??

是时候重构一下了!在 ViewController 中,相比之前直接调用 FoodService 的 getFood 方法,我们现在可以将Gettable 的引用类型限制为 [Food]

// 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)        }    }}

现在,测试起来容易多了!

测试

要测试 ViewController 的 getFood 方法,我们需要注入遵循 Gettable 并且引用类型为 [Food] 的 service:

// FoodLaLaViewControllerTests

class Fake_FoodService: Gettable {

    var getWasCalled = false    // 你也可以在这里定义一个失败结果变量,用来测试失败状态    // food 变量是一个数组(在此仅为测试目的)    var result = Result.Success(food)

    func get(completionHandler: Result<[Food]> -> Void) {        getWasCalled = true        completionHandler(result)    }}

所以,我们可以注入 Fake_FoodService 来测试 ViewController 的确发起了请求,并正确的返回了 [Food] 类型的结果(定义为 [Food] 是因为 TableView 的 data source 所要用到的类型就是 [Food]):

// FoodLaLaViewControllerTests

func testFetchFood_Success() {    let fakeFoodService = Fake_FoodService()    viewController.getFood(fromService: fakeFoodService)

    XCTAssertTrue(fakeFoodService.getWasCalled)    XCTAssertEqual(viewController.dataSource.count, food.count)    XCTAssertEqual(viewController.dataSource, food)}

现在你也可以仿照这个写法完成失败状态的测试(比如,根据收到的 ErrorType 显示对应的错误信息)。

总结

使用协议来封装网络层,可以使代码统一、 可注入、 可测试更可读

POP 万岁!

转载自:http://swift.gg/2016/06/03/protocol-oriented-networking-in-swift/

参考链接:https://www.natashatherobot.com/protocol-oriented-networking-in-swift/

时间: 2024-08-06 10:05:37

用 Swift 编写面向协议的网络请求的相关文章

用 Swift 编写面向协议的视图

我最近做了个 Swift 面向协议编程实践 (POP:boom:) 的演讲.视频还在处理中.另一方面,这是演讲中 POP 视图部分的文本记录,供我和其他任何人作参考! 简单的任务 假设你要写一个由一张图片和一个按钮构成的简单应用,产品经理希望按钮被点击的时候图片会抖动,就像这样: 由于这个动画常常在用户名或者密码输入错误时被用到,所以我们很容易就能 在 StackOverflow 上找到代码 (就像每个好的开发者都会做的一样:grin:) 这个需求最难的地方就是决定实现抖动的代码应该写在哪儿,但

011-通过网络协议解析网络请求-DNS-ARP-TCPIP

一.概述 1.1.tcp/ip概述 TCP/IP不是一个协议,而是一个协议族的统称.里面包括IP协议.IMCP协议.TCP协议.跨越了多层模型的多层 TCP/IP协议族按照层次由上到下,层层包装.最上面的是应用层,这里面有http,ftp,等等我们熟悉的协议.而第二层则是传输层,著名的TCP和UDP协议就在这个层次.第三层是网络层,IP协议就在这里,它负责对数据加上IP地址和其他的数据以确定传输的目标.第四层是数据链路层,这个层次为待传送的数据加入一个以太网协议头,并进行CRC编码,为最后的数据

Swift -POP( 面向协议编程)与OOP

面向协议编程(Protocol Oriented Programming,简称POP),是Swift的一种编程范式,Apple于2015年WWDC提出的,如果大家看Swift的标准库,就会看到大量POP的影子. 同时Swift也是一门面向对象的编程语言(Object Oriented Programming,简称OOP),在Swift开发中,OOP和POP是相辅相成的,任何一方并不能取代另一方. 回顾OOP OOP的三大特性:封装.继承.多态 继承的经典使用场合 当多个类(比如A.B.C类)具有

Swift中面向协议的编程

什么是面向协议的编程? 面向协议的编程,是一种编程范式. 编程范式,是一个计算机科学用语.维基百科中的解释是,计算机编程的基本风格或典型模式.通俗来说,就是解决某一个问题的方法不同方法和思路. 像大家很熟悉的,面向对象编程以及面向过程编程,都是一种编程范式. 面向过程编程,关心的焦点是解决某一个问题需要多少步.而面向对象的编程关心的是解决问题需要多少个对象,以及这些对象之间的组织联系. 解释完了编程范式这个名字含义之后,我们继续回到正题上来. 既然面向协议编程,与面向对象,面向过程一样,是一种编

为什么swift是面向协议的编程--对面向对象机制的改进

主要目标是提供抽象能力和解决值类型的多态问题 Actually, Abrahams says, those are all attributes of types, and classes are just one way of implementing a type. Yet, they exact a heavy toll on programmers in that they may cause: Implicit sharing, such that if two objects ref

造轮子 | 怎样设计一个面向协议的 iOS 网络请求库

近期开源了一个面向协议设计的网络请求库 MBNetwork,基于 Alamofire 和 ObjectMapper 实现,目的是简化业务层的网络请求操作. 须要干些啥 对于大部分 App 而言,业务层做一次网络请求通常关心的问题有例如以下几个: 怎样在任何位置发起网络请求. 表单创建. 包括请求地址.请求方式(GET/POST/--).请求头等-- 载入遮罩. 目的是堵塞 UI 交互,同一时候告知用户操作正在进行. 比方提交表单时在提交按钮上显示 "菊花",同一时候使其失效. 载入进度

造轮子 | 如何设计一个面向协议的 iOS 网络请求库

最近开源了一个面向协议设计的网络请求库 MBNetwork,基于 Alamofire 和 ObjectMapper 实现,目的是简化业务层的网络请求操作. 需要干些啥 对于大部分 App 而言,业务层做一次网络请求通常关心的问题有如下几个: 如何在任意位置发起网络请求. 表单创建.包含请求地址.请求方式(GET/POST/--).请求头等-- 加载遮罩.目的是阻塞 UI 交互,同时告知用户操作正在进行.比如提交表单时在提交按钮上显示 "菊花",同时使其失效. 加载进度展示.下载上传图片

Swift - 网络请求报App Transport Security has blocked a cleartext错

使用Xcode7编写iOS9应用时,如果获取http://数据时会报如下错误: App Transport Security has blocked a cleartext HTTP (http://) resource load since it is insecure. Temporary exceptions can be configured via your app's Info.plist file. 原因: 从iOS9起,新特性要求App访问网络请求,要采用 HTTPS 协议. 如

Swift使用Alamofire实现网络请求

Alamofire是一个用Swift编写的HTTP网络库,由此前热门开源项目AFNetworking的的作者mattt开发,可非常简单地用于异步网络通信. 要获取最新版本的 Alamofire,前往https://github.com/Alamofire/Alamofire然后单击网页右边的Download ZIP按钮.接着在 Finder 中打开起始项目文件夹,,然后将Alamofire-master文件夹拖入到您的主项目文件夹中. 打开Alamofire-master文件夹(现在它位于您的项