使用VIPER构建iOS应用

使用VIPER构建iOS应用

 

转自Di Wu's blog，原文：Architecting iOS Apps with VIPER

 

建筑领域流行这样一句话，“我们虽然在营造建筑，但建筑也会重新塑造我们”。正如所有开发者最终领悟到的，这句话同样适用于构建软件。

 

编写代码中至关重要的是，需要使每一部分容易被识别，赋有一个特定而明显的目的，并与其他部分在逻辑关系中完美契合。这就是我们所说的软件架构。好的架构不仅让一个产品成功投入使用，还可以让产品具有可维护性，并让人不断头脑清醒的对它进行维护！

 

在这篇文章中，我们介绍了一种称之为  VIPER 的 iOS 应用架构的方式。VIPER 已经在很多大型的项目上成功实践，但是出于本文的目的我们将通过一个待办事项清单 (to-do app) 来介绍 VIPER 。你可以在  GitHub 上关注这个项目。

 

什么是 VIPER？

测试永远不是构建 iOS 应用的主要部分。当我们 ( Mutual Mobile) 着手改善我们的测试实践时，我们发现给 iOS 应用写测试代码非常困难。因此如果想要设法改变测试的现状，我们首先需要一个更好的方式来架构应用，我们称之为 VIPER。

 

VIPER 是一个创建 iOS 应用 简明构架的程序。VIPER 可以是视图 (View)，交互器 (Interactor)，展示器 (Presenter)，实体 (Entity) 以及路由 (Routing) 的首字母缩写。简明架构将一个应用程序的逻辑结构划分为不同的责任层。这使得它更容易隔离依赖项 (如数据库)，也更容易测试各层间的边界处的交互：

 

大部分 iOS 应用利用 MVC 构建，使用 MVC 应用程序架构可以引导你将每一个类看做模型，视图或控制器中的一个。但由于大部分应用程序的逻辑不会存在于模型或视图中，所以通常最终总是在控制器里实现。这就导致一个称为 重量级视图控制器的问题，在这里，视图控制器做了太多工作。为这些重量级视图控制器 瘦身并不是 iOS 开发者寻求提高代码的质量所要面临的唯一挑战，但至少这是一个很好的开端。

 

VIPER 的不同层提供了明确的程序逻辑以及导航控制代码来应对这个挑战，利用 VIPER ，你会注意到在我们的待办事项示例清单中的视图控制器可以简洁高效，意义明确地控制视图。你也会发现视图控制器中代码和所有的其他类很容易理解，容易测试，理所当然也更易维护。

 

基于用例的应用设计

应用通常是一些用户用例的集合。用例也被称为验收标准，或行为集，它们用来描述应用的用途。清单可以根据时间，类型以及名字排序，这就是一个用例。用例是应用程序中用来负责业务逻辑的一层，应独立于用户界面的实现，同时要足够小，并且有良好的定义。决定如何将一个复杂的应用分解成较小的用例非常具有挑战性，并且需要长期实践，但这对于缩小你解决的问题时所要面临的范围及完成的每个类的所要涉及的内容来说，是很有帮助的。

 

利用 VIPER 建立一个应用需要实施一组套件来满足所有的用例，应用逻辑是实现用例的主要组成部分，但却不是唯一。用例也会影响用户界面。另一个重要的方面，是要考虑用例如何与其他应用程序的核心组件相互配合，例如网络和数据持久化。组件就好比用例的插件，VIPER 则用来描述这些组件的作用是什么，如何进行交互。

 

我们其中一个用例，或者说待办事项清单中其中的一个需求是可以基于用户的选择来将待办事项分组。通过分离的逻辑将数据组织成一个用例，我们能够在测试时使用户界面代码保持干净，用例更易组装，从而确保它如我们预期的方式工作。

 

VIPER 的主要部分

VIPER 的主要部分是：

 

视图：根据展示器的要求显示界面，并将用户输入反馈给展示器。

交互器：包含由用例指定的业务逻辑。

展示器：包含为显示（从交互器接受的内容）做的准备工作的相关视图逻辑，并对用户输入进行反馈（从交互器获取新数据）。

实体：包含交互器要使用的基本模型对象。

路由：包含用来描述屏幕显示和显示顺序的导航逻辑。

 

这种分隔形式同样遵循 单一责任原则。交互器负责业务分析的部分，展示器代表交互设计师，而视图相当于视觉设计师。

 

以下则是不同组件的相关图解，并展示了他们之间是如何关联的：

虽然在应用中 VIPER 的组件可以以任意顺序实现，我们在这里选择按照我们推荐的顺序来进行介绍。你会注意到这个顺序与构建整个应用的进程大致符合 -- 首先要讨论的是产品需要做什么，以及用户会如何与之交互。

 

交互器

交互器在应用中代表着一个独立的用例。它具有业务逻辑以操纵模型对象（实体）执行特定的任务。交互器中的工作应当独立与任何用户界面，同样的交互器可以同时运用于 iOS 应用或者 OS X 应用中。

 

由于交互器是一个 PONSO (Plain Old NSObject，普通的 NSObject)，它主要包含了逻辑，因此很容易使用 TDD 进行开发。

 

示例应用的主要用例是向用户展示所有的待办事项（比如任何截止于下周末的任务）。此类用例的业务逻辑主要是找出今天至下周末之间将要到期的待办事项，然后为它们分配一个相对的截止日期，比如今天，明天，本周以内，或者下周。

 

以下是来自 VTDListInteractor 的对应方法：

  

  
   
   
   
   



   
    
    
    
    
 - (void)findUpcomingItems  


   
    
    
    
    
 {  


   
    
    
    
    
     __weak typeof(self) welf = self;  


   
    
    
    
    
     NSDate* today = [self.clock today];  


   
    
    
    
    
     NSDate* endOfNextWeek = [[NSCalendar currentCalendar] dateForEndOfFollowingWeekWithDate:today];  


   
    
    
    
    
     [self.dataManager todoItemsBetweenStartDate:today endDate:endOfNextWeek completionBlock:^(NSArray* todoItems) {  


   
    
    
    
    
         [welf.output foundUpcomingItems:[welf upcomingItemsFromToDoItems:todoItems]];  


   
    
    
    
    
     }];  


   
    
    
    
    
 }  


  
   
   
   
   

 

实体

实体是被交互器操作的模型对象，并且它们只被交互器所操作。交互器永远不会传输实体至表现层 (比如说展示器)。

 

实体也应该是 PONSOs。如果你使用 Core Data，最好是将托管对象保持在你的数据层之后，交互器不应与 NSManageObjects 协同工作。

 

这里是我们的待办事项服务的实体：

  

  
   
   
   
   



   
    
    
    
    
 @interface VTDTodoItem : NSObject  


   
    
    
    
    
   


   
    
    
    
    
 @property (nonatomic, strong)   NSDate*     dueDate;  


   
    
    
    
    
 @property (nonatomic, copy)     NSString*   name;  


   
    
    
    
    
   


   
    
    
    
    
 + (instancetype)todoItemWithDueDate:(NSDate*)dueDate name:(NSString*)name;  


   
    
    
    
    
   


   
    
    
    
    
 @end  


  
   
   
   
   

不要诧异于你的实体仅仅是数据结构，任何依赖于应用的逻辑都应该放到交互器中。

 

展示器

展示器是一个主要包含了驱动用户界面的逻辑的 PONSO，它总是知道何时呈现用户界面。基于其收集来自用户交互的输入功能，它可以在合适的时候更新用户界面并向交互器发送请求。

 

当用户点击 “+” 键新建待办事项时，addNewEntry 被调用。对于此项操作，展示器会要求 wireframe 显示用户界面以增加新项目：

  

  
   
   
   
   



   
    
    
    
    
 - (void)addNewEntry  


   
    
    
    
    
 {  


   
    
    
    
    
     [self.listWireframe presentAddInterface];  


   
    
    
    
    
 }  


  
   
   
   
   

展示器还会从交互器接收结果并将结果转换成能够在视图中有效显示的形式。

 

下面是如何从交互器接受待办事项的过程，其中包含了处理数据的过程并决定展现给用户哪些内容：

  

  
   
   
   
   



   
    
    
    
    
 - (void)foundUpcomingItems:(NSArray*)upcomingItems  


   
    
    
    
    
 {  


   
    
    
    
    
     if ([upcomingItems count] == 0)  


   
    
    
    
    
     {  


   
    
    
    
    
         [self.userInterface showNoContentMessage];  


   
    
    
    
    
     }  


   
    
    
    
    
     else  


   
    
    
    
    
     {  


   
    
    
    
    
         [self updateUserInterfaceWithUpcomingItems:upcomingItems];  


   
    
    
    
    
     }  


   
    
    
    
    
 }  


  
   
   
   
   

实体永远不会由交互器传输给展示器，取而代之，那些无行为的简单数据结构会从交互器传输到展示器那里。这就防止了那些“真正的工作”在展示器那里进行，展示器只能负责准备那些在视图里显示的数据。

 

视图

视图一般是被动的，它通常等待展示器下发需要显示的内容，而不会向其索取数据。视图（例如登录界面的登录视图控件）所定义的方法应该允许展示器在高度抽象的层次与之交流。展示器通过内容进行表达，而不关心那些内容所显示的样子。展示器不知道 UILabel，UIButton 等的存在，它只知道其中包含的内容以及何时需要显示。内容如何被显示是由视图来进行控制的。

 

视图是一个抽象的接口 (Interface)，在 Objective-C 中使用协议被定义。一个 UIViewController 或者它的一个子类会实现视图协议。比如我们的示例中 “添加” 界面会有以下接口：

  

  
   
   
   
   



   
    
    
    
    
 @protocol VTDAddViewInterface   


   
    
    
    
    
   


   
    
    
    
    
 - (void)setEntryName:(NSString *)name;  


   
    
    
    
    
 - (void)setEntryDueDate:(NSDate *)date;  


   
    
    
    
    
   


   
    
    
    
    
 @end  


  
   
   
   
   

视图和视图控制器同样会操纵用户界面和相关输入。因为通常来说视图控制器是最容易处理这些输入和执行某些操作的地方，所以也就不难理解为什么视图控制器总是这么大了。为了使视图控制器保持苗条，我们需要使它们在用户进行相关操作的时候可以有途径来通知相关部分。视图控制器不应当根据这些行为进行相关决定，但是它应当将发生的事件传递到能够做决定的部分。

 

在我们的例子中，Add View Controller 有一个事件处理的属性，它实现了如下接口：

  

  
   
   
   
   



   
    
    
    
    
 @protocol VTDAddModuleInterface   


   
    
    
    
    
   


   
    
    
    
    
 - (void)cancelAddAction;  


   
    
    
    
    
 - (void)saveAddActionWithName:(NSString *)name dueDate:(NSDate *)dueDate  


   
    
    
    
    
   


   
    
    
    
    
 @end  


  
   
   
   
   

当用户点击取消键的时候，视图控制器告知这个事件处理程序用户需要其取消这次添加的动作。这样一来，事件处理程序便可以处理关闭 add view controller 并告知列表视图进行更新。

 

视图和展示器之间边界处是一个使用  ReactiveCocoa 的好地方。在这个示例中，视图控制器可以返回一个代表按钮操作的信号。这将允许展示器在不打破职责分离的前提下轻松地对那些信号进行响应。

 

路由

屏幕间的路径会在交互设计师创建的线框 (wireframes) 里进行定义。在 VIPER 中，路由是由两个部分来负责的：展示器和线框。一个线框对象包括 UIWindow，UINavigationController，UIViewController 等部分，它负责创建视图/视图控制器并将其装配到窗口中。

 

由于展示器包含了响应用户输入的逻辑，因此它就拥有知晓何时导航至另一个屏幕以及具体是哪一个屏幕的能力。而同时，线框知道如何进行导航。在两者结合起来的情况下，展示器可以使用线框来进行实现导航功能，它们两者一起描述了从一个屏幕至另一个屏幕的路由过程。

 

线框同时也明显是一个处理导航转场动画的地方。来看看这个 add wireframe 中的例子吧：

  

  
   
   
   
   



   
    
    
    
    
 @implementation VTDAddWireframe  


   
    
    
    
    
   


   
    
    
    
    
 - (void)presentAddInterfaceFromViewController:(UIViewController *)viewController   


   
    
    
    
    
 {  


   
    
    
    
    
     VTDAddViewController *addViewController = [self addViewController];  


   
    
    
    
    
     addViewController.eventHandler = self.addPresenter;  


   
    
    
    
    
     addViewController.modalPresentationStyle = UIModalPresentationCustom;  


   
    
    
    
    
     addViewController.transitioningDelegate = self;  


   
    
    
    
    
   


   
    
    
    
    
     [viewController presentViewController:addViewController animated:YES completion:nil];  


   
    
    
    
    
   


   
    
    
    
    
     self.presentedViewController = viewController;  


   
    
    
    
    
 }  


   
    
    
    
    
   


   
    
    
    
    
 #pragma mark - UIViewControllerTransitioningDelegate Methods  


   
    
    
    
    
   


   
    
    
    
    
 - (id)animationControllerForDismissedController:(UIViewController *)dismissed   


   
    
    
    
    
 {  


   
    
    
    
    
     return [[VTDAddDismissalTransition alloc] init];  


   
    
    
    
    
 }  


   
    
    
    
    
   


   
    
    
    
    
 - (id)animationControllerForPresentedController:(UIViewController *)presented  


   
    
    
    
    
                                                                   presentingController:(UIViewController *)presenting  


   
    
    
    
    
                                                                       sourceController:(UIViewController *)source   


   
    
    
    
    
 {  


   
    
    
    
    
     return [[VTDAddPresentationTransition alloc] init];  


   
    
    
    
    
 }  


   
    
    
    
    
   


   
    
    
    
    
 @end  


  
   
   
   
   

应用使用了自定义的视图控制器转场来呈现 add view controller。因为线框部件负责实施这个转场，所以它成为了 add view controller 转场的委托，并且返回适当的转场动画。

 

利用 VIPER 组织应用组件

iOS 应用的构架需要考虑到 UIKit 和 Cocoa Touch 是建立应用的主要工具。架构需要和应用的所有组件都能够和平相处，但又需要为如何使用框架的某些部分以及它们应该在什么位置提供一些指导和建议。

 

iOS 应用程序的主力是 UIViewController，我们不难想象找一个竞争者来取代 MVC 就可以避免大量使用视图控制器。但是视图控制器现在是这个平台的核心：它们处理设备方向的变化，回应用户的输入，和类似导航控制器之类的系统系统组件集成得很好，而现在在 iOS 7 中又能实现自定义屏幕之间的转换，功能实在是太强大了。

 

有了 VIPER，视图控制器便就能真正的做它本来应该做的事情了，那就是控制视图。 我们的待办事项应拥有两个视图控制器，一个是列表视图，另一个是新建待办。因为 add view controller 要做的所有事情就是控制视图，所以实现起来非常的简单基础：

  

  
   
   
   
   



   
    
    
    
    
 @implementation VTDAddViewController  


   
    
    
    
    
   


   
    
    
    
    
 - (void)viewDidAppear:(BOOL)animated   


   
    
    
    
    
 {  


   
    
    
    
    
     [super viewDidAppear:animated];  


   
    
    
    
    
   


   
    
    
    
    
     UITapGestureRecognizer *gestureRecognizer = [[UITapGestureRecognizer alloc] initWithTarget:self  


   
    
    
    
    
                                                                                         action:@selector(dismiss)];  


   
    
    
    
    
     [self.transitioningBackgroundView addGestureRecognizer:gestureRecognizer];  


   
    
    
    
    
     self.transitioningBackgroundView.userInteractionEnabled = YES;  


   
    
    
    
    
 }  


   
    
    
    
    
   


   
    
    
    
    
 - (void)dismiss   


   
    
    
    
    
 {  


   
    
    
    
    
     [self.eventHandler cancelAddAction];  


   
    
    
    
    
 }  


   
    
    
    
    
   


   
    
    
    
    
 - (void)setEntryName:(NSString *)name   


   
    
    
    
    
 {  


   
    
    
    
    
     self.nameTextField.text = name;  


   
    
    
    
    
 }  


   
    
    
    
    
   


   
    
    
    
    
 - (void)setEntryDueDate:(NSDate *)date   


   
    
    
    
    
 {  


   
    
    
    
    
     [self.datePicker setDate:date];  


   
    
    
    
    
 }  


   
    
    
    
    
   


   
    
    
    
    
 - (IBAction)save:(id)sender   


   
    
    
    
    
 {  


   
    
    
    
    
     [self.eventHandler saveAddActionWithName:self.nameTextField.text  


   
    
    
    
    
                                      dueDate:self.datePicker.date];  


   
    
    
    
    
 }  


   
    
    
    
    
   


   
    
    
    
    
 - (IBAction)cancel:(id)sender   


   
    
    
    
    
 {  


   
    
    
    
    
     [self.eventHandler cancelAddAction];  


   
    
    
    
    
 }  


   
    
    
    
    
   


   
    
    
    
    
   


   
    
    
    
    
 #pragma mark - UITextFieldDelegate Methods  


   
    
    
    
    
   


   
    
    
    
    
 - (BOOL)textFieldShouldReturn:(UITextField *)textField   


   
    
    
    
    
 {  


   
    
    
    
    
     [textField resignFirstResponder];  


   
    
    
    
    
   


   
    
    
    
    
     return YES;  


   
    
    
    
    
 }  


   
    
    
    
    
   


   
    
    
    
    
 @end  


  
   
   
   
   

应用在接入网络以后会变得更有用处，但是究竟该在什么时候联网呢？又由谁来负责启动网络连接呢？典型的情况下，由交互器来启动网络连接操作的项目，但是它不会直接处理网络代码。它会寻找一个像是 network manager 或者 API client 这样的依赖项。交互器可能聚合来自多个源的数据来提供所需的信息，从而完成一个用例。最终，就由展示器来采集交互器反馈的数据，然后组织并进行展示。

 

数据存储模块负责提供实体给交互器。因为交互器要完成业务逻辑，因此它需要从数据存储中获取实体并操纵它们，然后将更新后的实体再放回数据存储中。数据存储管理实体的持久化，而实体应该对数据库全然不知，正因如此，实体并不知道如何对自己进行持久化。

 

交互器同样不需要知道如何将实体持久化，有时交互器更希望使用一个 data manager 来使其与数据存储的交互变得容易。Data manager 可以处理更多的针对存储的操作，比如创建获取请求，构建查询等等。这就使交互器能够将更多的注意力放在应用逻辑上，而不必再了解实体是如何被聚集或持久化的。下面我们举一个例子来说明使用 data manager 有意义的，这个例子假设你在使用 Core Data。这是示例应用程序的 data manager 的接口：

  

  
   
   
   
   



   
    
    
    
    
 @interface VTDListDataManager : NSObject  


   
    
    
    
    
   


   
    
    
    
    
 @property (nonatomic, strong) VTDCoreDataStore *dataStore;  


   
    
    
    
    
   


   
    
    
    
    
 - (void)todoItemsBetweenStartDate:(NSDate *)startDate endDate:(NSDate *)endDate completionBlock:(void (^)(NSArray *todoItems))completionBlock;  


   
    
    
    
    
   


   
    
    
    
    
 @end  


  
   
   
   
   

当使用 TDD 来开发一个交互器时，是可以用一个测试用的模拟存储来代替生产环境的数据存储的。避免与远程服务器通讯（网络服务）以及避免读取磁盘（数据库）可以加快你测试的速度并加强其可重复性。

 

将数据存储保持为一个界限清晰的特定层的原因之一是，这可以让你延迟选择一个特定的持久化技术。如果你的数据存储是一个独立的类，那你就可以使用一个基础的持久化策略来开始你的应用，然后等到有意义的时候升级至 SQLite 或者 Core Data。而因为数据存储层的存在，你的应用代码库中就不需要改变任何东西。

 

在 iOS 的项目中使用 Core Data 经常比构架本身还容易引起更多争议。然而，利用 VIPER 来使用 Core Data 将给你带来使用 Core Data 的前所未有的良好体验。在持久化数据的工具层面上，Core Data 可以保持快速存取和低内存占用方面，简直是个神器。但是有个很恼人的地方，它会像触须一样把 NSManagedObjectContext 延伸至你所有的应用实现文件中，特别是那些它们不该待的地方。VIPER 可以使 Core Data 待在正确的地方：数据存储层。

 

在待办事项示例中，应用仅有的两部分知道使用了 Core Data，其一是数据存储本身，它负责建立 Core Data 堆栈；另一个是 data manager。Data manager 执行了获取请求，将数据存储返回的 NSManagedObject 对象转换为标准的 PONSO 模型对象，并传输回业务逻辑层。这样一来，应用程序核心将不再依赖于 Core Data，附加得到的好处是，你也再也不用担心过期数据 (stale) 和没有良好组织的多线程 NSManagedObjects 来糟蹋你的工作成果了。

 

在通过请求访问 Core Data 存储时，data manager 中看起来是这样的：

  

  
   
   
   
   



   
    
    
    
    
 @implementation VTDListDataManager  


   
    
    
    
    
   


   
    
    
    
    
 - (void)todoItemsBetweenStartDate:(NSDate *)startDate endDate:(NSDate*)endDate completionBlock:(void (^)(NSArray *todoItems))completionBlock  


   
    
    
    
    
 {  


   
    
    
    
    
     NSCalendar *calendar = [NSCalendar autoupdatingCurrentCalendar];  


   
    
    
    
    
   


   
    
    
    
    
     NSPredicate *predicate = [NSPredicate predicateWithFormat:@"(date >= %@) AND (date <= %@)", [calendar dateForBeginningOfDay:startDate], [calendar dateForEndOfDay:endDate]];  


   
    
    
    
    
     NSArray *sortDescriptors = @[];  


   
    
    
    
    
   


   
    
    
    
    
     __weak typeof(self) welf = self;  


   
    
    
    
    
     [self.dataStore  


   
    
    
    
    
      fetchEntriesWithPredicate:predicate  


   
    
    
    
    
      sortDescriptors:sortDescriptors  


   
    
    
    
    
      completionBlock:^(NSArray* entries) {  


   
    
    
    
    
          if (completionBlock)  


   
    
    
    
    
          {  


   
    
    
    
    
              completionBlock([welf todoItemsFromDataStoreEntries:entries]);  


   
    
    
    
    
          }  


   
    
    
    
    
      }];  


   
    
    
    
    
 }  


   
    
    
    
    
   


   
    
    
    
    
 - (NSArray*)todoItemsFromDataStoreEntries:(NSArray *)entries  


   
    
    
    
    
 {  


   
    
    
    
    
     return [entries arrayFromObjectsCollectedWithBlock:^id(VTDManagedTodoItem *todo) {  


   
    
    
    
    
         return [VTDTodoItem todoItemWithDueDate:todo.date name:todo.name];  


   
    
    
    
    
     }];  


   
    
    
    
    
 }  


   
    
    
    
    
   


   
    
    
    
    
 @end  


  
   
   
   
   

与 Core Data 一样极富争议的恐怕就是 UI 故事板了。故事板具有很多有用的功能，如果完全忽视它将会是一个错误。然而，调用故事版所能提供的所有功能来完成 VIPER 的所有目标仍然是很困难的。

 

我们所能做出的妥协就是选择不使用 segues 。有时候使用 segues 是有效的，但是使用 segues 的危险性在于它们很难原封不动地保持屏幕之间的分离，以及 UI 和应用逻辑之间的分离。一般来说，如果实现 prepareForSegue 方法是必须的话，我们就尽量不去使用 segues。

 

除此之外，故事板是一个实现用户界面布局有效方法，特别是在使用自动布局的时候。我们选择在实现待办事项两个界面的实例中使用故事板，并且使用这样的代码来执行自己的导航操作。

  

  
   
   
   
   



   
    
    
    
    
 static NSString *ListViewControllerIdentifier = @"VTDListViewController";  


   
    
    
    
    
   


   
    
    
    
    
 @implementation VTDListWireframe  


   
    
    
    
    
   


   
    
    
    
    
 - (void)presentListInterfaceFromWindow:(UIWindow *)window   


   
    
    
    
    
 {  


   
    
    
    
    
     VTDListViewController *listViewController = [self listViewControllerFromStoryboard];  


   
    
    
    
    
     listViewController.eventHandler = self.listPresenter;  


   
    
    
    
    
     self.listPresenter.userInterface = listViewController;  


   
    
    
    
    
     self.listViewController = listViewController;  


   
    
    
    
    
   


   
    
    
    
    
     [self.rootWireframe showRootViewController:listViewController  


   
    
    
    
    
                                       inWindow:window];  


   
    
    
    
    
 }  


   
    
    
    
    
   


   
    
    
    
    
 - (VTDListViewController *)listViewControllerFromStoryboard   


   
    
    
    
    
 {  


   
    
    
    
    
     UIStoryboard *storyboard = [self mainStoryboard];  


   
    
    
    
    
     VTDListViewController *viewController = [storyboard instantiateViewControllerWithIdentifier:ListViewControllerIdentifier];  


   
    
    
    
    
     return viewController;  


   
    
    
    
    
 }  


   
    
    
    
    
   


   
    
    
    
    
 - (UIStoryboard *)mainStoryboard   


   
    
    
    
    
 {  


   
    
    
    
    
     UIStoryboard *storyboard = [UIStoryboard storyboardWithName:@"Main"  


   
    
    
    
    
                                                          bundle:[NSBundle mainBundle]];  


   
    
    
    
    
     return storyboard;  


   
    
    
    
    
 }  


   
    
    
    
    
   


   
    
    
    
    
 @end  


  
   
   
   
   

 

使用 VIPER 构建模块

一般在使用 VIPER 的时候，你会发现一个屏幕或一组屏幕倾向于聚在一起作为一个模块。模块可以以多种形式体现，但一般最好把它想成是一种特性。在播客应用中，一个模块可能是音频播放器或订阅浏览器。然而在我们的待办事项应用中，列表和添加事项的屏幕都将作为单独的模块被建立。

 

将你的应用作为一组模块来设计有很多好处，其中之一就是模块可以有非常明确和定义良好的接口，并且独立于其他的模块。这就使增加或者移除特性变得更加简单，也使在界面中向用户展示各种可变模块变得更加简单。

 

我们希望能将待办事项中各模块之间分隔更加明确，我们为添加模块定义了两个协议。一个是模块接口，它定义了模块可以做什么；另一个则是模块的代理，用来描述该模块做了什么。例如：

  

  
   
   
   
   



   
    
    
    
    
 @protocol VTDAddModuleInterface   


   
    
    
    
    
   


   
    
    
    
    
 - (void)cancelAddAction;  


   
    
    
    
    
 - (void)saveAddActionWithName:(NSString *)name dueDate:(NSDate *)dueDate;  


   
    
    
    
    
   


   
    
    
    
    
 @end  


   
    
    
    
    
   


   
    
    
    
    
   


   
    
    
    
    
 @protocol VTDAddModuleDelegate   


   
    
    
    
    
   


   
    
    
    
    
 - (void)addModuleDidCancelAddAction;  


   
    
    
    
    
 - (void)addModuleDidSaveAddAction;  


   
    
    
    
    
   


   
    
    
    
    
 @end  


  
   
   
   
   

因为模块必须要被展示，才能对用户产生价值，所以模块的展示器通常需要实现模型的接口。当另一个模型想要展现当前模块时，它的展示器就需要实现模型的委托协议，这样它就能在展示时知道当前模块做了些什么。

 

一个模块可能包括实体，交互器和管理器的通用应用逻辑层，这些通常可用于多个屏幕。当然，这取决于这些屏幕之间的交互及它们的相似度。一个模块可以像在待办事项列表里面一样，简单的只代表一个屏幕。这样一来，应用逻辑层对于它的特定模块的行为来说就非常特有了。

 

模块同样是组织代码的简便途径。将模块所有的编码都放在它自己的文件夹中并在 Xcode 中建一个 group，这会在你需要寻找和改变更加容易。当你在要寻找一个类时，它恰到好处地就在你所期待的地方，这种感觉真是无法形容的棒。

 

利用 VIPER 建立模块的另一个好处是它使得扩展到多平台时变得更加简单。独立在交互器层中的所有用例的应用逻辑允许你可以专注于为平板，电话或者 Mac 构建新的用户界面，同时可以重用你的应用层。

 

进一步来说，iPad 应用的用户界面能够将部分 iPhone 应用的视图，视图控制器及展示器进行再利用。在这种情况下，iPad 屏幕将由 ‘super’ 展示器和线框来代表，这样可以利用 iPhone 使用过的展示器和线框来组成屏幕。建立进而维护一个跨多平台的应用是一个巨大的挑战，但是好的构架可以对整个模型和应用层的再利用有大幅度的提升，并使其实现起来更加容易。

 

利用 VIPER 进行测试

VIPER 的出现激发了一个关注点的分离，这使得采用 TDD 变得更加简便。交互器包含独立与任何 UI 的纯粹逻辑，这使测试驱动开发更加简单。同时展示器包含用来为显示准备数据的逻辑，并且它也独立于任何一个 UIKit 部件。对于这个逻辑的开发也很容易用测试来驱动。

 

我们更倾向于先从交互器下手。用户界面里所有部分都服务于用例，而通过采用 TDD 来测试驱动交互器的 API 可以让你对用户界面和用例之间的关系有一个更好的了解。

 

作为实例，我们来看一下负责待办事项列表的交互器。寻找待办事项的策略是要找出所有的将在下周末前截止的项目，并将这些项目分别归类至截止于今天，明天，本周或者下周。

 

我们编写的第一个测试是为了保证交互器能够找到所有的截止于下周末的待办事项：

  

  
   
   
   
   



   
    
    
    
    
 - (void)testFindingUpcomingItemsRequestsAllToDoItemsFromTodayThroughEndOfNextWeek  


   
    
    
    
    
 {  


   
    
    
    
    
     [[self.dataManager expect] todoItemsBetweenStartDate:self.today endDate:self.endOfNextWeek completionBlock:OCMOCK_ANY];  


   
    
    
    
    
     [self.interactor findUpcomingItems];  


   
    
    
    
    
 }  


  
   
   
   
   

一旦知道了交互器找到了正确的待办事项后，我们就需要编写几个小测试用来确认它确实将待办事项分配到了正确的相对日期组内（比如说今天，明天，等等）。

  

  
   
   
   
   



   
    
    
    
    
 - (void)testFindingUpcomingItemsWithOneItemDueTodayReturnsOneUpcomingItemsForToday  


   
    
    
    
    
 {  


   
    
    
    
    
     NSArray *todoItems = @[[VTDTodoItem todoItemWithDueDate:self.today name:@"Item 1"]];  


   
    
    
    
    
     [self dataStoreWillReturnToDoItems:todoItems];  


   
    
    
    
    
   


   
    
    
    
    
     NSArray *upcomingItems = @[[VTDUpcomingItem upcomingItemWithDateRelation:VTDNearTermDateRelationToday dueDate:self.today title:@"Item 1"]];  


   
    
    
    
    
     [self expectUpcomingItems:upcomingItems];  


   
    
    
    
    
   


   
    
    
    
    
     [self.interactor findUpcomingItems];  


   
    
    
    
    
 }  


  
   
   
   
   

既然我们已经知道了交互器的 API 长什么样，接下来就是开发展示器。一旦展示器接收到了交互器传来的待办事项，我们就需要测试看看我们是否适当的将数据进行格式化并且在用户界面中正确的显示它。

  

  
   
   
   
   



   
    
    
    
    
 - (void)testFoundZeroUpcomingItemsDisplaysNoContentMessage  


   
    
    
    
    
 {  


   
    
    
    
    
     [[self.ui expect] showNoContentMessage];  


   
    
    
    
    
   


   
    
    
    
    
     [self.presenter foundUpcomingItems:@[]];  


   
    
    
    
    
 }  


   
    
    
    
    
   


   
    
    
    
    
 - (void)testFoundUpcomingItemForTodayDisplaysUpcomingDataWithNoDay  


   
    
    
    
    
 {  


   
    
    
    
    
     VTDUpcomingDisplayData *displayData = [self displayDataWithSectionName:@"Today"  


   
    
    
    
    
                                                           sectionImageName:@"check"  


   
    
    
    
    
                                                                  itemTitle:@"Get a haircut"  


   
    
    
    
    
                                                                 itemDueDay:@""];  


   
    
    
    
    
     [[self.ui expect] showUpcomingDisplayData:displayData];  


   
    
    
    
    
   


   
    
    
    
    
     NSCalendar *calendar = [NSCalendar gregorianCalendar];  


   
    
    
    
    
     NSDate *dueDate = [calendar dateWithYear:2014 month:5 day:29];  


   
    
    
    
    
     VTDUpcomingItem *haircut = [VTDUpcomingItem upcomingItemWithDateRelation:VTDNearTermDateRelationToday dueDate:dueDate title:@"Get a haircut"];  


   
    
    
    
    
   


   
    
    
    
    
     [self.presenter foundUpcomingItems:@[haircut]];  


   
    
    
    
    
 }  


   
    
    
    
    
   


   
    
    
    
    
 - (void)testFoundUpcomingItemForTomorrowDisplaysUpcomingDataWithDay  


   
    
    
    
    
 {  


   
    
    
    
    
     VTDUpcomingDisplayData *displayData = [self displayDataWithSectionName:@"Tomorrow"  


   
    
    
    
    
                                                           sectionImageName:@"alarm"  


   
    
    
    
    
                                                                  itemTitle:@"Buy groceries"  


   
    
    
    
    
                                                                 itemDueDay:@"Thursday"];  


   
    
    
    
    
     [[self.ui expect] showUpcomingDisplayData:displayData];  


   
    
    
    
    
   


   
    
    
    
    
     NSCalendar *calendar = [NSCalendar gregorianCalendar];  


   
    
    
    
    
     NSDate *dueDate = [calendar dateWithYear:2014 month:5 day:29];  


   
    
    
    
    
     VTDUpcomingItem *groceries = [VTDUpcomingItem upcomingItemWithDateRelation:VTDNearTermDateRelationTomorrow dueDate:dueDate title:@"Buy groceries"];  


   
    
    
    
    
   


   
    
    
    
    
     [self.presenter foundUpcomingItems:@[groceries]];  


   
    
    
    
    
 }  


  
   
   
   
   

同样需要测试的是应用是否在用户想要新建待办事项时正确启动了相应操作：

  

  
   
   
   
   



   
    
    
    
    
 - (void)testAddNewToDoItemActionPresentsAddToDoUI  


   
    
    
    
    
 {  


   
    
    
    
    
     [[self.wireframe expect] presentAddInterface];  


   
    
    
    
    
   


   
    
    
    
    
     [self.presenter addNewEntry];  


   
    
    
    
    
 }  


  
   
   
   
   

这时我们可以开发视图功能了，并且在没有待办事项的时候我们想要展示一个特殊的信息。

  

  
   
   
   
   



   
    
    
    
    
 - (void)testShowingNoContentMessageShowsNoContentView  


   
    
    
    
    
 {  


   
    
    
    
    
     [self.view showNoContentMessage];  


   
    
    
    
    
   


   
    
    
    
    
     XCTAssertEqualObjects(self.view.view, self.view.noContentView, @"the no content view should be the view");  


   
    
    
    
    
 }  


  
   
   
   
   

有待办事项出现时，我们要确保列表是显示出来的：

  

  
   
   
   
   



   
    
    
    
    
 - (void)testShowingUpcomingItemsShowsTableView  


   
    
    
    
    
 {  


   
    
    
    
    
     [self.view showUpcomingDisplayData:nil];  


   
    
    
    
    
   


   
    
    
    
    
     XCTAssertEqualObjects(self.view.view, self.view.tableView, @"the table view should be the view");  


   
    
    
    
    
 }  


  
   
   
   
   

首先建立交互器是一种符合 TDD 的自然规律。如果你首先开发交互器，紧接着是展示器，你就可以首先建立一个位于这些层的套件测试，并且为实现这是实例奠定基础。由于你不需要为了测试它们而去与用户界面进行交互，所以这些类可以进行快速迭代。在你需要开发视图的时候，你会有一个可以工作并测试过的逻辑和表现层来与其进行连接。在快要完成对视图的开发时，你会发现第一次运行程序时所有部件都运行良好，因为你所有已通过的测试已经告诉你它可以工作。

 

结论

我们希望你喜欢这篇对 VIPER 的介绍。或许你们都很好奇接下来应该做什么，如果你希望通过 VIPER 来对你下一个应用进行设计，该从哪里开始呢？

 

我们竭尽全力使这篇文章和我们利用 VIPER 实现的应用实例足够明确并且进行了很好的定义。我们的待办事项里列表程序相当直接简单，但是它准确地解释了如何利用 VIPER 来建立一个应用。在实际的项目中，你可以根据你自己的挑战和约束条件来决定要如何实践这个例子。根据以往的经验，我们的每个项目在使用 VIPER 时都或多或少地改变了一些策略，但它们无一例外的都从中得益，找到了正确的方向。

 

很多情况下由于某些原因，你可能会想要偏离 VIPER 所指引的道路。可能你遇到了很多  'bunny' 对象，或者你的应用使用了故事板的 segues。没关系的，在这些情况下，你只需要在做决定时稍微考虑下 VIPER 所代表的精神就好。VIPER 的核心在于它是建立在 单一责任原则上的架构。如果你碰到了些许麻烦，想想这些原则再考虑如何前进。

 

你一定想知道在现有的应用中能否只用 VIPER 。在这种情况下，你可以考虑使用 VIPER 构建新的特性。我们许多现有项目都使用了这个方法。你可以利用 VIPER 建立一个模块，这能帮助你发现许多建立在单一责任原则基础上造成难以运用架构的现有问题。

 

软件开发最伟大的事情之一就是每个应用程序都是不同的，而设计每个应用的架构的方式也是不同的。这就意味着每个应用对于我们来说都是一个学习和尝试的机遇，如果你决定开始使用 VIPER，你会受益匪浅。感谢你的阅读。

 

Swift 补充

苹果上周在 WWDC 介绍了一门称之为  Swift 的编程语言来作为 Cocoa 和 Cocoa Touch 开发的未来。现在发表关于 Swift 的完整意见还为时尚早，但众所周知编程语言对我们如何设计和构建应用有着重大影响。我们决定使用  Swift 重写我们的待办事项清单，帮助我们学习它对 VIPER 意味着什么。至今为止，收获颇丰。Swift 中的一些特性对于构建应用的体验有着显著的提升。

 

结构体

在 VIPER 中我们使用小型，轻量级的 model 类来在比如从展示器到视图这样不同的层间传递数据。这些 PONSOs 通常是只是简单地带有少量数据，并且通常这些类不会被继承。Swift 的结构体非常适合这个情况。下面的结构体的例子来自 VIPER Swift。这个结构体需要被判断是否相等，所以我们重载了 == 操作符来比较这个类型的两个实例。

  

  
   
   
   
   



   
    
    
    
    
 struct UpcomingDisplayItem : Equatable, Printable {  


   
    
    
    
    
     let title : String = ""  


   
    
    
    
    
     let dueDate : String = ""  


   
    
    
    
    
   


   
    
    
    
    
     var description : String { get {  


   
    
    
    
    
         return "\(title) -- \(dueDate)"  


   
    
    
    
    
     }}  


   
    
    
    
    
   


   
    
    
    
    
     init(title: String, dueDate: String) {  


   
    
    
    
    
         self.title = title  


   
    
    
    
    
         self.dueDate = dueDate  


   
    
    
    
    
     }  


   
    
    
    
    
 }  


   
    
    
    
    
   


   
    
    
    
    
 func == (leftSide: UpcomingDisplayItem, rightSide: UpcomingDisplayItem) -> Bool {  


   
    
    
    
    
     var hasEqualSections = false  


   
    
    
    
    
     hasEqualSections = rightSide.title == leftSide.title  


   
    
    
    
    
   


   
    
    
    
    
     if hasEqualSections == false {  


   
    
    
    
    
         return false  


   
    
    
    
    
     }  


   
    
    
    
    
   


   
    
    
    
    
     hasEqualSections = rightSide.dueDate == rightSide.dueDate  


   
    
    
    
    
   


   
    
    
    
    
     return hasEqualSections  


   
    
    
    
    
 }  


  
   
   
   
   

 

类型安全

也许 Objective-C 和 Swift 的最大区别是它们在对于类型处理上的不同。 Objective-C 是动态类型，而 Swift 故意在编译时做了严格的类型检查。对于一个类似 VIPER 的架构， 应用由不同层构成，类型安全是提升程序员效率和设计架构有非常大的好处。编译器帮助你确保正确类型的容器和对象在层的边界传递。如上所示，这是一个使用结构体的好地方。如果一个结构体的被设计为存在于两层之间，那么由于类型安全，你可以保证它将永远无法脱离这些层之间。