如何在ReactiveCocoa中写单元测试
Sailerc48
8年前
<p>现在很多人在开发iOS时都使用 ReactiveCocoa ，它是一个函数式和响应式编程的框架，使用Signal来代替KVO、Notification、Delegate和Target-Action等传递消息和解决对象之间状态与状态的依赖过多问题。但很多时候使用它之后，如何编写 单元测试 来验证程序是否正确呢？下面首先了解MVVM架构，然后通过一个 例子 来讲述我如何在RAC(ReactiveCocoa简称)中使用 Kiwi 来编写单元测试。</p> <h2><strong>MVVM架构</strong></h2> <p style="text-align:center"><img src="https://simg.open-open.com/show/5fda57c13c79384fd72378d15146e502.jpg"></p> <p>在MVVM架构中，通常都将view和view controller看做一个整体。相对于之前MVC架构中view controller执行很多在view和model之间数据映射和交互的工作，现在将它交给view model去做。</p> <p>至于选择哪种机制来更新view model或view是没有强制的，但通常我们都选择 <a href="/misc/goto?guid=4958534310893103470" rel="nofollow,noindex">ReactiveCocoa</a> 。ReactiveCocoa会监听model的改变然后将这些改变映射到view model的属性中，并且可以执行一些业务逻辑。</p> <p>举个例子来说，有一个model包含一个dateAdded的属性，我想监听它的变化然后更新view model的dateAdded属性。但model的dateAdded属性的数据类型是NSDate，而view model的数据类型是NSString，所以在view model的init方法中进行数据绑定，但需要数据类型转换。示例代码如下：</p> <pre> <code class="language-objectivec">RAC(self,dateAdded) = [RACObserve(self.model,dateAdded) map:^(NSDate*date){ return [[ViewModel dateFormatter] stringFromDate:date]; }];</code></pre> <p>ViewModel调用dateFormatter进行数据转换，且方法dateFormatter可以复用到其他地方。然后view controller监听view model的dateAdded属性且绑定到label的text属性。</p> <pre> <code class="language-objectivec">RAC(self.label,text) = RACObserve(self.viewModel,dateAdded);</code></pre> <p>现在我们抽象出日期转换到字符串的逻辑到view model，使得代码可以 <strong>测试</strong> 和 <strong>复用</strong> ，并且帮view controller <strong>瘦身</strong> 。</p> <h2><strong>登录情景</strong></h2> <p style="text-align:center"><img src="https://simg.open-open.com/show/01e70d889401dbf69db159128c5455d8.gif"></p> <p>如图所示，这是一个简单的 <strong>登录界面</strong> ：有用户名和密码的两个输入框，一个登录按钮。用户输入完用户名和密码后，点击登录按钮后，成功登录。但这里有 <strong>限制条件</strong> ：用户名必须满足邮件的格式和密码长度必须在6位以上。当同时满足这两个条件后才能点击按钮，否则按钮是不可点击的。</p> <p>首先我们先画界面，我定义一个 LoginView ，将画登录界面的责任都交给它。然后在 LoginViewController 中的 viewDidLoad 方法调用 buildViewHierarchy 加载它</p> <pre> <code class="language-objectivec">#pragma mark - Lifecycle- (void)viewDidLoad { [super viewDidLoad]; // build view hierarchy [self buildViewHierarchy]; // bind data [self bindData]; // handle events [self handleEvents]; } - (void)buildViewHierarchy { [self.view addSubview:self.rootView]; [self.rootView mas_makeConstraints:^(MASConstraintMaker *make) { make.edges.equalTo(self.view); }]; }</code></pre> <p>接下来我们要思考UI如何交互和如何设计和实现哪些类来处理。由于用户名和密码要同时满足验证格式时才能点击登录按钮，所以需要时刻监听 usernameTextField 和 passwordTextField 的text属性，对于处理UI交互、数据校验以及转换都交给MVVM架构中 ViewModel 来处理。于是定义一个 LoginViewModel ,并继承 RVMViewModel ，这个 RVMViewModel 有个 active 属性来表示viewModel是否处于活跃状态，当active是YES时，更新或显示UI。当active是NO时，不更新或隐藏UI。</p> <pre> <code class="language-objectivec">@interface LoginViewModel : RVMViewModel#pragma mark - UI state/* @brief 用户名 */@property (copy, nonatomic) NSString *username;/* @brief 密码 */@property (copy, nonatomic) NSString *password;#pragma mark - Handle events/* @brief 处理用户民和密码是否有效才能点击按钮以及登陆事件 */@property (nonatomic, strong) RACCommand *loginCommand;#pragma mark - Methods- (RACSignal *)isValidUsernameAndPasswordSignal;@end</code></pre> <p>上面还有一个 loginCommand 属性和 isValidUsernameAndPasswordSignal 方法等下会详细介绍。定义 LoginViewModel 类后，在 LoginViewController 以 <strong>组合和委托</strong> 的方式来使用 LoginViewModel 并使用 <strong>Lazy Initialization</strong> 来初始化它。</p> <pre> <code class="language-objectivec">@interface LoginViewController ()#pragma mark - View model@property (strong, nonatomic) LoginViewModel *loginViewModel;@end@implementation LoginViewController#pragma mark - Custom Accessors- (LoginViewModel *)loginViewModel { if (!_loginViewModel) { _loginViewModel = [LoginViewModel new]; } return _loginViewModel; }</code></pre> <p>最后调用 bindData 方法进行 数据绑定</p> <pre> <code class="language-objectivec">- (void)bindData { RAC(self.loginViewModel, username) = self.rootView.usernameTextField.rac_textSignal; RAC(self.loginViewModel, password) = self.rootView.passwordTextField.rac_textSignal; }</code></pre> <h3><strong>数据绑定测试</strong></h3> <p>如果usernameTextField.text、passwordTextField.text与loginViewModel.username、loginViewModel.password已经绑定数据，那么usernameTextField.text和passwordTextField.text的数据变动的话，一定会引起loginViewModel.username和loginViewModel.password的改变。那么 <strong>测试用例</strong> 可以这样设计：</p> <p style="text-align:center"><img src="https://simg.open-open.com/show/6cff9bce05e52d1a6ea79f1f0f0a7048.png"></p> <p>数据绑定 Test Case</p> <p>用kiwi编写测试如下：</p> <pre> <code class="language-objectivec">SPEC_BEGIN(LoginViewControllerSpec) describe(@"LoginViewController", ^{ __block LoginViewController *controller = nil; beforeEach(^{ controller = [LoginViewController new]; [controller view]; }); afterEach(^{ controller = nil; }); describe(@"Root View", ^{ __block LoginView *rootView = nil; beforeEach(^{ rootView = controller.rootView; }); context(@"when view did load", ^{ it(@"should bind data", ^{ rootView.usernameTextField.text = @"samlau"; rootView.passwordTextField.text = @"freedom"; [rootView.usernameTextField sendActionsForControlEvents:UIControlEventEditingChanged]; [rootView.passwordTextField sendActionsForControlEvents:UIControlEventEditingChanged]; [[controller.loginViewModel.username should] equal:rootView.usernameTextField.text]; [[controller.loginViewModel.password should] equal:rootView.passwordTextField.text]; }); }); }); });SPEC_END</code></pre> <p>这个测试中有 <strong>两点</strong> 需要重点解释：</p> <ul> <li> <p>初始化完controller之后， controller 一定要调用 view 方法来加载controller的view，否则不会调用 viewDidLoad 方法。</p> <p> </p> </li> </ul> <p style="text-align:center"><img src="https://simg.open-open.com/show/c18f6089028970d90df485d262217ffe.png"></p> <ul> <li> <p>usernameTextField和passwordTextField一定要调用 sendActionsForControlEvents 方法来通知UI已经更新。</p> <pre> <code class="language-objectivec">[rootView.usernameTextField sendActionsForControlEvents:UIControlEventEditingChanged]; [rootView.passwordTextField sendActionsForControlEvents:UIControlEventEditingChanged];</code></pre> <p>一开始时，我并没有调用 sendActionsForControlEvents 方法导致 loginViewModel.username 和 loginViewModel.password 属性并没有更新。当时我开始思考，是不是还需要其他条件还能触发它更新呢？由于我使用 UITextField 的 rac_textSignal 属性，于是我就查看它的源代码：</p> <pre> <code class="language-objectivec">- (RACSignal *)rac_textSignal { @weakify(self); return [[[[[RACSignal defer:^{ @strongify(self); return [RACSignal return:self]; }] concat:[self rac_signalForControlEvents:UIControlEventEditingChanged | UIControlEventEditingDidBegin]] map:^(UITextField *x) { return x.text; }] takeUntil:self.rac_willDeallocSignal] setNameWithFormat:@"%@ -rac_textSignal", self.rac_description]; }</code></pre> <p>从源代码可以知道，只有触发 UIControlEventEditingChanged 或 UIControlEventEditingDidBegin 事件时才能创建RACSignal对象。</p> </li> </ul> <h3><strong>业务逻辑测试</strong></h3> <p>由于这里需要验证用户名和密码，复用性高，我不将处理逻辑放在viewModel中，而是定义一个 DataValidation 来处理。这里的用户名是邮箱格式，而密码要求长度大于等于6即可，方法如下：</p> <pre> <code class="language-objectivec">@interface DataValidation : NSObject+ (BOOL)isValidEmail:(NSString *)data; + (BOOL)isValidPassword:(NSString *)password;@end</code></pre> <p>测试用例设计如下：</p> <p style="text-align:center"><img src="https://simg.open-open.com/show/c710fdfcee1d6e6421fff34a57294df0.png"></p> <p>然后使用kiwi编写测试如下：</p> <pre> <code class="language-objectivec">SPEC_BEGIN(DataValidationSpec)describe(@"DataValidation", ^{ context(@"when email is samlau@163.com", ^{ it(@"should return YES", ^{ BOOL result = [DataValidation isValidEmail:@"samlau@163.com"]; [[theValue(result) should] beYes]; }); }); context(@"when email is samlau163.com", ^{ it(@"should return YES", ^{ BOOL result = [DataValidation isValidEmail:@"samlau163.com"]; [[theValue(result) should] beNo]; }); }); ......省略两个测试用例 });</code></pre> <h3><strong>ViewModel层测试</strong></h3> <p>前面已经完成了数据绑定和数据校验逻辑，接下来思考使用哪个类处理用户名和密码是否有效才能点击和点击按钮后，如何调用网络层在来匹配用户名和密码，RAC提供一个 RACCommand 类。 LoginViewModel 定义一个属性 loginCommand ，并在 <strong>实现文件</strong> 中使用 Lazy Initialization 初始化：</p> <pre> <code class="language-objectivec">- (RACCommand *)loginCommand { if (!_loginCommand) { _loginCommand = [[RACCommand alloc] initWithEnabled:[self isValidUsernameAndPasswordSignal] signalBlock:^RACSignal *(id input) { return [LoginClient loginWithUsername:self.username password:self.password]; }]; } return _loginCommand; }</code></pre> <p>上面有一个重要方法 isValidUsernameAndPasswordSignal 来监听和验证用户名和密码:</p> <pre> <code class="language-objectivec">- (RACSignal *)isValidUsernameAndPasswordSignal { return [RACSignal combineLatest:@[RACObserve(self, username), RACObserve(self, password)] reduce:^(NSString *username, NSString *password) { return @([DataValidation isValidEmail:username] && [DataValidation isValidPassword:password]); }]; }</code></pre> <p>由于上面的方法 isValidUsernameAndPasswordSignal 已经监听 LoginViewModel 的username和password，当username和password其中一个改变时， DataValidation 类都会调用 isValidEmail 和 isValidPassword 来数据验证，并将结果包裹成 RACSignal 对象返回。</p> <p>测试用例设计如下：</p> <p style="text-align:center"><img src="https://simg.open-open.com/show/b504d863cb38249f9a506ee3b7bdcc3b.png"></p> <p>然后使用kiwi编写测试如下：</p> <pre> <code class="language-objectivec">describe(@"LoginViewModel", ^{ __block LoginViewModel* viewModel = nil; beforeEach(^{ viewModel = [LoginViewModel new]; }); afterEach(^{ viewModel = nil; }); context(@"when username is samlau@163.com and password is freedom", ^{ __block BOOL result = NO; it(@"should return signal that value is YES", ^{ viewModel.username = @"samlau@163.com"; viewModel.password = @"freedom"; [[viewModel isValidUsernameAndPasswordSignal] subscribeNext:^(id x) { result = [x boolValue]; }]; [[theValue(result) should] beYes]; }); }); ......省略两个测试用例 });</code></pre> <p>以上测试用例很简单，设置viewModel的username和password，然后调用 isValidUsernameAndPasswordSignal 返回RACSignal对象，使用 subscribeNext 获取它的值，最后验证。</p> <h3><strong>网络层测试</strong></h3> <p>最后处理点击登录按钮访问服务器来验证用户名和密码。我定义一个 LoginClient 类来处理：</p> <pre> <code class="language-objectivec">@interface LoginClient : NSObject+ (RACSignal *)loginWithUsername:(NSString *)username password:(NSString *)password;@end</code></pre> <p>只要输入username和password两个参数，就能返回是否验证成功的结果被包裹在 RACSignal 对象中。</p> <p>由于这里我是使用 <a href="/misc/goto?guid=4958859336248198036" rel="nofollow,noindex">moco</a> 模拟服务，所以只设计一个成功的测试用例:</p> <p style="text-align:center"><img src="https://simg.open-open.com/show/310ed2fd066751e91296ceea20e19e20.png"></p> <p>然后使用kiwi编写测试如下：</p> <pre> <code class="language-objectivec">describe(@"LoginClient", ^{ context(@"when username is samlau@163.com and password is samlau", ^{ __block BOOL success = NO; __block NSError *error = nil; it(@"should login successfully", ^{ RACTuple *tuple = [[LoginClient loginWithUsername:@"samlau@163.com" password:@"samlau"] asynchronousFirstOrDefault:nil success:&success error:&error]; NSDictionary *result = tuple.first; [[theValue(success) should] beYes]; [[error should] beNil]; [[result[@"result"] should] equal:@"success"]; }); }); });</code></pre> <p>里面使用RAC的一个重要方法 asynchronousFirstOrDefault 来测试异步网络访问的。</p> <h2><strong>抓取网络数据并显示情景</strong></h2> <p style="text-align:center"><img src="https://simg.open-open.com/show/6b0748dae0340177b4f67217253439cc.gif"></p> <p>如图所示，输入正确的用户名和密码后，跳转到一个食物列表页面，它从服务端抓取图片、价格和已售份数后以列表的方式显示。</p> <h3><strong>网络层测试</strong></h3> <p>首先考虑如何设计和实现API，然后再考虑如何测试。因为它需要从服务端抓取数据，需要设计一个访问食物列表数据的类 FoodListClient ，设计如下：</p> <pre> <code class="language-objectivec">@interface FoodListClient : NSObject+ (RACSignal *)fetchFoodList;@end</code></pre> <p>FoodListClient 实现如下：</p> <pre> <code class="language-objectivec">@implementation FoodListClient + (RACSignal *)fetchFoodList{ return [[[AFHTTPSessionManager manager] rac_GET:[URLHelper URLWithResourcePath:@"/v1/foodlist"] parameters:nil] replayLazily]; }@end</code></pre> <p>fetchFoodList 方法主要从服务端抓取数据后，返回一个JSON格式的数组。因此想测试这个API，只需要使用RAC的 asynchronousFirstOrDefault 方法返回 RACTuple 对象，获取第一个值，测试返回数组不为空即可。使用kiwi编写测试如下：</p> <pre> <code class="language-objectivec">describe(@"FoodListClient", ^{ context(@"when fetch food list ", ^{ __block BOOL successful = NO; __block NSError *error = nil; it(@"should receive data", ^{ RACSignal *result = [FoodListClient fetchFoodList]; RACTuple *tuple = [result asynchronousFirstOrDefault:nil success:&successful error:&error]; NSArray *foodList = tuple.first; [[theValue(successful) should] beYes]; [[error should] beNil]; [[foodList shouldNot] beEmpty]; }); }); });</code></pre> <h3><strong>Model层测试</strong></h3> <p>抓取完数据后，它的数据格式一般都是JSON格式，需要转化为Model方便访问和修改，通常我都使用 <a href="/misc/goto?guid=4958870673057858431" rel="nofollow,noindex">Mantle</a> 来实现。我定义一个 FoodModel 类：</p> <pre> <code class="language-objectivec">@interface FoodModel : MTLModel /* @brief 食物图片URL */@property (copy, nonatomic) NSString *foodImageURL;/* @brief 食物价格 */@property (copy, nonatomic) NSString *foodPrice;/* @brief 销量 */@property (copy, nonatomic) NSString *saleNumber;@end</code></pre> <p>那么如何测试它是否转化成功呢？首先基于上一个网络层测试获取返回JSON格式的食物列表数据，然后调用 MTLJSONAdapter 类的 modelsOfClass: fromJSONArray: error: 方法来转化成 FoodModel 的数组。接下来断言 <strong>数组不能为空</strong> 和 <strong> 数组的第一个元素是 FoodModel 类 </strong> 。</p> <p>使用kiwi编写测试如下：</p> <pre> <code class="language-objectivec">describe(@"FoodModel", ^{ context(@"when JSON data convert to FoodModel", ^{ __block BOOL successful = NO; __block NSError *error = nil; it(@"should return FoodModel array", ^{ // get data from network RACSignal *result = [FoodListClient fetchFoodList]; RACTuple *tuple = [result asynchronousFirstOrDefault:nil success:&successful error:&error]; NSArray *foodList = tuple.first; // assert that foodList can't be empty [[theValue(successful) should] beYes]; [[error should] beNil]; [[foodList shouldNot] beEmpty]; // assert that return FoolModel array NSArray *foodModelList = [MTLJSONAdapter modelsOfClass:[FoodModel class] fromJSONArray:foodList error:nil]; [[foodModelList shouldNot] beEmpty]; [[foodModelList[0] should] beKindOfClass:[FoodModel class]]; }); }); });</code></pre> <h3><strong>ViewModel抓取数据</strong></h3> <p>完成抓取网络数据和转化JSON数据为Model后，我使用 FoodViewModel 来 <strong>抓取网络数据</strong> 和完成 <strong>数据映射</strong> ，设计与实现如下：</p> <pre> <code class="language-objectivec">@interface FoodViewModel : RVMViewModel/* @brief FoodModel列表 */@property (strong, nonatomic, readonly) NSArray *foodModelList;@end</code></pre> <pre> <code class="language-objectivec">@implementation FoodViewModel- (instancetype)init { self = [super init]; if (!self) { return nil; } RAC(self, foodModelList) = [[FoodListClient fetchFoodList] map:^id(RACTuple * tuple) { return [MTLJSONAdapter modelsOfClass:[FoodModel class] fromJSONArray:tuple.first error:nil]; }]; return self; }@end</code></pre> <h3>Controller加载数据</h3> <p>最后 FoodListViewController 负责构建view hierarchy和加载数据:</p> <pre> <code class="language-objectivec">#pragma mark - Lifecycle- (void)viewDidLoad { [super viewDidLoad]; // setup title name and background color self.title = @"食物列表"; self.view.backgroundColor = [UIColor whiteColor]; // build view hierarchy [self buildViewHierarchy]; // when finish fetching data and reload table view [RACObserve(self.foodViewModel, foodModelList) subscribeNext:^(NSArray* items) { self.foodListDataSource.items = items; [self.tableView reloadData]; }]; }</code></pre> <h2><strong>总结</strong></h2> <p>编写单元测试是程序员的一项 <strong>基本技能</strong> ，如果能够设计好的测试用例并编写测试验证结果，不仅保证代码的质量，而且有利于以后重构加一层保护层。一旦修改了代码之后，如果运行单元测试，并没有通过的话，说明你在重构过程中引入新的bug。如果通过了单元测试，说明并没有引入新的bug。</p> <p> </p> <p> </p> <p>来自：http://www.cocoachina.com/ios/20161103/17934.html</p> <p> </p>