行为驱动开发iOS

前段时间在design+code购买了一个学习iOS设计和编码在线课程,使用Sketch设计App,然后使用Swift语言实现Designer News客户端。作者Meng To已经开源到Github:MengTo/DesignerNewsApp · GitHub。虽然实现整个Designer News客户端基本功能,但是采用臃肿MVC(Model-View-Controller)架构,不易于代码的测试和复用,于是使用ReactiveCocoa实现MVVM(Model-View-View Model)架构,加上一个用Objective-C实现的BDD测试框架Kiwi来单元测试,就可以行为驱动开发iOS App。

ReactiveCocoa

ReactiveCocoa是一个用Objective-C编写,具有函数式和响应式特性的编程框架。大多数的开发者他们解决问题的思考方式都是如何完成任务,通常的做法就是编写很多指令,然后修改重要数据结构的状态,这种编程范式叫做命令式编程(Imperative Programming)。与命令式编程不同的是函数式编程(Functional Programming),思考问题的方式是完成什么任务,怎样描述这个任务。关于对函数式编程入门概念的理解,可以参考酷壳《函数式编程》这篇文章,深入浅出对函数式编程的思考方式、特性和技术通过一些示例来讲解。

ReactiveCocoa解决哪些问题?

  • 对象之间状态与状态的依赖过多问题
    借用ReactiveCocoa中一个例子来说明:用户在登录界面时,有一个用户名输入框和密码输入框,还有一个登录按钮。登录交互要求如下:

    1. 当用户名和密码符合验证格式,并且之前还没登录时,登录按钮才能点击。
    2. 当点击登录成功登录后,设置已登录状态。

    传统的做法代码如下:

    以上使用KVO、Notification、Target-Action等处理事件或消息的方式编写的代码分散到各个地方,变得杂乱和难以理解;但是使用RACSignal统一处理的话,代码更加简洁和易读。使用RAC后代码如下:

  • 传统MVC架构中,由于Controller承担数据验证、映射数据模型到View和操作View层次结构等多个责任,导致Controller过于臃肿,不利于代码的复用和测试。
    在传统的MVC架构中,主要有Model, View和Controller三部分组成。Model主要是保存数据和处理业务逻辑,View将数据显示,而Controller调解关于Model和View之间的所有交互。
    当数据到达时,Model通过Key-Value Observation来通知View Controller, 然后View Controller更新View。当View与用户交互后,View Controller更新Model。

正如你所见,View Controller隐式承担很多责任:数据验证、映射数据模型到View和操作View层次结构。MVVM将很多逻辑从View Controller移走到View-Model,等介绍完ReactiveCocoa后会介绍MVVM架构。还有一些关于如何减负View Controller好文章请参阅objc中国更轻量的View Controllers系列:

  • 使用Signal来代替KVO、Notification、Delegate和Target-Action等传递消息
    iOS开发中有多种消息传递方式,KVO、Notification、Delegate、Block和Target-Action,对于它们之间有什么差异以及如何选择请参考《消息传递机制》。但RAC提供RACSignal来统一消息传递机制,不再为如何选择何种传递消息方式而烦恼。RAC对常用UI控件事件进行封装成一个RACSignal对象,以便对发生的各种事件进行监听。
    KVO示例代码如下:

    Target-Action示例代码如下:

    Notification示例代码如下:

    除此之外,还可以使用AFNetworking访问服务器后对返回数据自创建一个RACSignal。示例代码如下:

    有些朋友可以感觉有点奇怪,上面代码明明返回的是RACSubject,而不是RACSignal,其实RACSubject是RACSignal的子类,但是RACSubject写出代码更加简洁,所以采用RACSubject(官方不推荐使用)。等下将RAC核心类设计时,你就会了解它们之间的关系和如何选择。

ReactiveCocoa核心类设计

关于RAC核心类设计,官方文档有详细的解释:Framework Overview

Sequence和Signal基本操作

了解完整个RAC核心类设计之后,要学会对Sequence和Signal基本操作,比如:用signal执行side effects,转换streams, 合并stream和合并signal。详情请查阅官方文档:Basic Operators

MVVM架构

在MVVM架构中,通常都将view和view controller看做一个整体。相对于之前MVC架构中view controller执行很多在view和model之间数据映射和交互的工作,现在将它交给view model去做。
至于选择哪种机制来更新view model或view是没有强制的,但通常我们都选择ReactiveCocoa。ReactiveCocoa会监听model的改变然后将这些改变映射到view model的属性中,并且可以执行一些业务逻辑。
举个例子来说,有一个model包含一个dateAdded的属性,我想监听它的变化然后更新view model的dateAdded属性。但model的dateAdded属性的数据类型是NSDate,而view model的数据类型是NSString,所以在view model的init方法中进行数据绑定,但需要数据类型转换。示例代码如下:

ViewModel调用dateFormatter进行数据转换,且方法dateFormatter可以复用到其他地方。然后view controller监听view model的dateAdded属性且绑定到label的text属性。

现在我们抽象出日期转换到字符串的逻辑到view model,使得代码可以测试复用,并且帮view controller瘦身

Kiwi

Kiwi是一个iOS行为驱动开发(Behavior Driven Development)的库。相比于Xcode提供单元测试的XCTest是从测试的角度思考问题,而Kiwi是从行为的角度思考问题,测试用例都遵循三段式Given-When-Then的描述,清晰地表达测试用例是测试什么样的对象或数据结构,在基于什么上下文或情景,然后做出什么响应。

我们很容易根据上下文将其提取为Given..When..Then的三段式自然语言

用Xcode自带的XCTest测试框架写过测试代码的朋友可能体会到,以上代码更加易于阅读和理解。就算以后有新的开发者加入或修护代码时,不需要太大的成本去阅读和理解代码。具体如何使用Kiwi,请参考两篇文章:

Designer News UI

在编写Designer News客户端代码之前,首先通过UI来了解整个App的概况。设计Designer News UI的工具是Sketch,想获得Designer News UI,请点击下载Designer New UI

如果将所有的页面都逐个说明如何编写,会比较耗时间,所以只拿登陆页面来说明我是如何行为驱动开发iOS,但我会将整个项目的代码上传到github

登陆界面

由于这个项目简单并且只有一个人开发(多人开发的话,采用Storyboard不易于代码合并),加上Storyboard可以可视化的添加UI组件和Auto Layout的约束,并且可以同时预览多个不同分辨率iPhone的效果,极大地提高开发界面效率。

登陆交互

登陆界面有Email输入框和密码输入框,当用户选中其他一个输入框时,左边对应的图标变成蓝色,同时会有pop动画表示用户准备要输入内容。
当用户没有输入有效的Email或密码格式时,用户是不能点击登陆按钮,只有当用户输入有效的邮件和密码格式时,才能点击登陆按钮。

我们可以使用RAC通过监听Text Field的UITextFieldTextDidBeginEditingNotificationUITextFieldTextDidEndEditingNotification的通知来处理用户选中Email输入框和密码输入框时改变图标和显示的动画。

当点击登陆按钮后,客户端向服务端发送验证请求,服务端验证完账户和密码后,用户便可以成功登陆。所以,接下来要了解RESTful API的基本概念和Designer News提供的RESTful API。

Designer News API

RESTful API基本概念和设计

REST全称是Representational State Transfer,翻译过来就是表现层状态转化。要想真正理解它的含义,从几个关键字入手:Resource, Representation, State Transfer

  • Resource(资源)

    资源就是网络上的实体,它可以是文字、图片、声音、视频或一种服务。但网络有这么多资源,该如何标识它们呢?你可以用URI(统一资源定位符)来唯一标识和定位它们。只要获得资源对应的URI,你就可以访问它们。

  • Representation(表现层)

    资源是一种信息实体,它有多种表示方式。比如,文本可以用.txt格式表示,也可以用xml、json或html格式表示。

  • State Transfer(状态转换)

    客户端访问服务端,服务端处理完后返回客户端,在这个过程中,一般都会引起数据状态的改变或转换。
    客户端操作服务端,都是通过HTTP协议,而在这个HTTP协议中,有几个动词:GET,POSTDELETEUPDATE

    • GET表示获取资源
    • POST表示新增资源
    • DELETE表示删除资源
    • UPDATE表示更新资源

理解RESTful核心概念后,我们来简单了解RESTful API设计以便可以看懂Designer News提供API。就拿Designer News获取Stories对应URL的一个例子来说明:
客户端请求
GET https://api-news.layervault.com/api/v1/stories?client_id=91a5fed537b58c60f36be1sdf71ed1320e9e4af2bda4366f7dn3d79e63835278

服务端返回结果(部分结果)

  • 协议(protocol)
    用户与API通信采用HTTPs协议
  • 域名(domain name)
    应该尽可能部署到专用域名下https://api-news.layervault.com/,但有时会进一步扩展为https://api-news.layervault.com/api
  • 版本(version)
    应该将API版本号v1放入URL
  • 路径(Endpoint)
    路径https://api-news.layervault.com/api/v1/stories表示API具体网址,代表网络一种资源,所以不能有动词,只有使用名词来表示。
  • HTTP动词
    动词GET,表示从服务端获取Stories资源
  • 过滤信息(Filtering)
    ?client_id=91a5fed537b58c60f36be1sdf71ed1320e9e4af2bda4366f7dn3d79e63835278指定client_id的Stories资源
  • 状态码(Status Codes)
    服务器向客户端返回表示成功或失败的状态码,状态码列表请参考Status Code Definitions
  • 错误处理(Error handling)
    服务端处理用户请求失败后,一般都返回error字段来表示错误信息

Designer News提供API

Designer News API Reference提供基于HTTP协议遵循RESTful设计的API,并且允许应用程序通过 oAuth 2授权协议来获取授权权限来访问用户信息。

访问API工具

一般来说,在写访问服务端代码之前,我都会用Paw(下载地址)工具来测试API是否可行;另一方面,用JSON文件保存服务端返回的数据,用于moco模拟服务端的服务。至于为什么需要moco模拟服务端,后面会讲解,现在通过用户登录Designer News这个例子介绍如何使用Paw来测试API。
我们先看看Designer News提供访问用户登录的API

根据以上提供的信息,API的路径是https://api-news.layervault.com/oauth/token,参数有grant_type,username,password,client_secret。其中username和password在Designer News注册才能获取,而client_id和client_secret需要发送email到news@layervault.com申请。使用Paw发送请求和服务端返回结果如下:

Moco模拟服务端

Moco是一个可以轻松搭建测试服务器的工具。

为什么需要模拟服务端

作为一个移动开发人员,有时由于服务端开发进度慢,空有一个iPhone应用但发挥不出作用。幸好有了Moco,只需配置一下请求和返回数据,很快就可以搭建一个模拟服务,无需等待服务端开发完成才能继续开发。当服务端完成后,修改访问地址即可。

有时服务端API应该是什么样子都还没清楚,由于有了moco模拟服务,在开发过程中,可以不断调整API设计,搞清楚真正自己想要的API是什么样子的。就这样,在服务端代码还没真正动手之前,已经提供一份真正满足自己需要的API文档,剩下的就交给服务端照着API去实现就行了。

还有一种情况就是,服务端已经写好了,剩下客户端还没完成。由于moco是本地服务,访问速度比较快,所以通过使用moco来模拟服务端,这样不仅可以提高客户端的访问速度,还提高网络层测试代码访问速度的稳定性,Designer News就是这样情况。

如何使用Moco模拟服务

安装

如果你是使用Mac或Linux,可以尝试一下步骤:

  1. 确定你安装JDK 6以上
  2. 下载脚本
  3. 把它放在你的$PATH路径
  4. 设置它可以执行(chmod 755 ~/bin/moco)

现在你可以运行一下命令测试安装是否成功

  1. 编写配置文件foo.json,内容如下:
  2. 运行Moco HTTP服务器
    moco start -p 12306 -c foo.json
  3. 打开浏览器访问http://localhost:12306,你回看见"Hello, Moco"
配置服务

由于有时候服务端返回的数据比较多,所以将服务端响应的数据独立在一个JSON文件中。以登陆为例,将数据存放在login_response.json

而将请求uri路径,方法(method)和参数(queries)等配置放在login_conf.json文件中

不知道有没有留意到上面uri路径不是全路径http://localhost:12306/oauth/token,因为协议默认是http,而且通常运行在本机localhost,所以在启动模拟服务时只需指定端口12306就行。想更加详细了解如何配置,请查阅官网的HTTP(s) APIs
还有一个需要配置地方就是,由于实际开发中肯定不止一个客户端请求,所以还需要一个配置文件settings.json来包含很有的请求。

启动服务

将路径跳转到DesignerNewsForObjc/DesignerNewsForObjcTests/JSON目录,找到settings.json文件,使用命令行来启动服务:
moco start -p 12306 -g settings.json

使用Paw验证是否配置成功

Send request to Local Server.png

行为驱动开发(BDD)

为什么需要BDD

不知道各位在编写测试的时候,有没有思考过一个问题:我应该测试什么?要回答这个问题并不是那么简单,在没得到答案之前,你还是继续按照你的想法编写测试。
-(void)testValidateEmail;
像这样的测试,存在一个根本问题。它不会告诉你应该会发生什么,也不会预期实际会发生什么。还有,当它发生错误时,不会提示你在哪里发生错误,错误的原因是什么,因此你需要深入代码才能知道失败的原因。这样就需要大量额外和不必要的认知负荷。
这时BDD出现了,帮助开发者确定应该测试什么,它提供DSL(Domain-specific language, 域特定语言),测试用例都遵循三段式Given-When-Then的描述,清晰地表达测试用例是测试什么样的对象或数据结构,在基于什么上下文或情景,然后做出什么响应。
所以,我们应该关注行为,而不是测试。那行为具体是什么?当你设计app里面的其中对象时,它的接口定义方法及其依赖关系,这些方法和依赖关系决定了你的对象如何与其他对象交互,以及它的功能是什么,定义你的对象的行为

BDD过程

行为驱动开发大概三个步骤:

  1. 选择最重要的行为,并编写行为的测试文件。此时,由于测试对象的类还没编写,所以编译失败。创建测试对象的类并编写类的伪实现,让编译通过。
  2. 实现被测试类的行为,让测试通过。
  3. 如果发现代码中有重复代码,重构被测试类来消除重复

如果暂时不理解其中步骤细节,没有关系,继续向下阅读,后面有例子介绍来帮助你理解三个步骤的含义。

登陆验证

网络访问层

DesignerNewsURL

DesignerNewsURL类封装网络访问URL

这里还有个技巧就是在DesignerNewsURL.m实现文件有个条件编译,判断是在测试环境还是产品环境来决定baseURL的值,可以很方便在测试环境与产品环境互相切换。

行为驱动开发LoginClient

在编写代码之前,我们应该先想想如何设计LoginClient类。首先根据Single responsibility principle(责任单一原则),LoginClient主要负责用户登录的网络访问。需要提供一个接口,只要给定用户名(username)和密码(password),用户就能登录,由于我是使用RAC来处理返回结果,所以这个接口返回RACSignal对象。

  • 创建一个LoginClientkiwi文件,编写对应行为。

Create LoginClient 1.png

Create LoginClient 2.png

根据三段式Given-When-Then描述,上面代码我们可以理解为:在给定LoginClient对象,当用户输入正确的用户名和密码时,应该登录成功。
这时,由于还没创建LoginClient类,所以会不通过编译,创建LoginClient类,并编写它的伪实现,让LoginClientSpec.m通过编译。

LoginClient.h.png

LoginClient.m.png

运行测试,测试失败。

LoginClient Failed.png
  • 实现LoginClient,通过其测试

LoginClient.m .png

LoginClient Pass Test.png
  • 由于无冗余代码,无需重构

Model层

由于这次登陆请求服务端返回数据比较简单,只是获取access_token字段数据,所以不需要model来映射和存储数据。不过在获取多个Stories时,就会使用到model来处理。

Controller与ViewModel层

controller是处理用户交互的入口,通常我都会将处理用户交互的逻辑、数据绑定和数据校验都交给ViewModel来精简controller代码,同时最大程度地复用业务逻辑的代码。
我们先回顾用户登陆时的步骤:1. 用户先输入email和密码,只有email和密码符合格式要求时才能点击按钮。2. 用户成功登陆后,跳转到故事列表主页。
我们先分析一下如何实现步骤1, 想要对email和密码进行验证,必须要监听它们两个值的变化,所以需要对emailTextField和passwordTextField使用RAC进行数据绑定。

创建LoginViewControllerSpeckiwi文件,测试绑定行为代码如下:

这里有两个关键点,一个是从Storyboard中加载controller,否则不能获取emailTextField和password,如果采用手写UI代码就不需要了。另一个就是emailTextField或passwordTextField必须调用sendActionsForControlEvents:UIControlEventEditingChanged方法,才能触发textField的text属性改变。

编译失败后,在LoginViewController.m编写- (void)bindViewModel方法通过测试

实现完数据绑定行为后,接下来要数据校验,交给LoginViewModel来处理。创建LoginViewModelSpec.m文件,提供email和password属性给LoginViewModel,返回验证结果的RACSignal,测试验证行为代码如下:

编译失败后(已经创建LoginViewModel类),添加- (RACSignal*)checkEmailPasswordSignal并实现验证数据,通过测试

最后需要在LoginViewModel创建属性为loginButtonCommand的RACCommand来处理点击登陆按钮的交互。在LoginViewControllerSpec.m测试loginButton.rac_command不能为空

测试失败,在LoginViewController.m编写- (void)bindViewModel方法以下代码片段

LoginViewModel.m延迟初始化loginButtonCommand属性

通过测试,完成登陆基本流程,至于登陆成功后如何返回故事列表页面,这里不详细介绍,各位可以通过阅读工程代码便可以得到答案。

总结

最近一段时间都再看关于敏捷开发的书籍(用户故事与敏捷方法硝烟中的Scrum和XP,解析极限编程),对敏捷开发很感兴趣,但发觉很少公司或博客介绍如何实践敏捷开发iOS,所以在网上搜集一些资料,发现有很多优秀的实践(测试驱动开发,重构,持续集成测试,增量设计,增量计划)值得去学习,通过自己对敏捷开发中各种实践的理解来重写这个Designer News,这个Designer News功能还没全部完成,希望各位看完这篇文章尝试以这样方式来完成整个app。如果我有些观点或实践理解有误,请各位多多指点。

扩展阅读

收藏 评论

相关文章

可能感兴趣的话题



直接登录
跳到底部
返回顶部