用 VIPER 構建 iOS 應用架構（1）

標籤：ios   整體布局   

【編者按】本篇文章由 Jeff Gilbert 和 Conrad Stoll 共同編寫，通過構建一個基礎樣本應用，深入瞭解 VIPER，並從視圖、互動器等多個組件理清 VIPER 的整體布局及思路。通過 VIPER 構建 iOS 應用架構，提升應用品質，迎接應用構建的新機遇！本文系 OneAPM 工程師編譯整理

眾所周知，在建築領域，我們塑造自己的建築，而建築也反過來影響我們。對於程式員來說，在構建軟體方面這個道理也同樣適用。

在編程的過程中，讓代碼具備可讀性是非常重要的，除此之外代碼還要具備明確的目的、在邏輯方面能和其他代碼協調一致。這就是我們常說的軟體架構。好的架構不能保證產品成功，但它卻會使產品便於維護，不至於讓讀到的人抓狂。

在這篇文章中，作者將介紹一種在 iOS 應用中適用的方法，名為 VIPER。 VIPER 已經被用來構建許多大型項目，但這篇文章的目的，是通過建立一個待辦事項的應用來深入瞭解 VIPER。你可以在 GitHub 上找到樣本項目。

什麼是VIPER？

測試並不總是開發 iOS 應用的重要組成部分。當作者在 Mutual Mobile 尋求提高測試實踐的辦法時，發現為 iOS 應用程式編寫測試並不容易。作者意識到，如果要找到提高測試軟體的方法，首先需要想出更好的應用架構。於是把這更好的方法稱作 VIPER。

VIPER 是 iOS 程式的整潔架構。它是指 View、Interactor、Presenter、Entity 和 Routing。整潔的體繫結構將應用程式的邏輯分配到不同的責任區。這使得依賴關係（例如資料庫）更容易獨立，更便於測試層與層之間的相互作用。

大多數 iOS 應用正在使用 MVC（模型—視圖—控制器）架構。使用 MVC 作為一個程式的體繫結構，可以引導你思考各個類是一個模型、視圖或控制器。由於大部分應用程式邏輯不屬於模型或視圖，而是通常在控制器中結束。這便導致了所謂的大規模視圖控制器，其視圖控制器最終變得繁複巨大。為這些龐大的視圖控制器減負是 iOS 開發人員必須面對的問題，也是提高代碼品質的巨大挑戰。

通過定位程式邏輯和導航相關的代碼，VIPER 的不同層可以協助解決這個難題。隨著 VIPER 的應用，「待辦事項」列表執行個體中，你會發現視圖控制器變得纖小、勻稱。視圖控制器的代碼和所有類都容易理解和測試，更有利於後期維護。

基於用例的應用設計

應用程式常常實現為一組用例。用例被稱為驗收標準或行為，它同時描述了程式目的。一個列表可能需要按日期、類型或名稱進行排序，這就是一個用例。用例是程式的邏輯責任層，應獨立於使用者介面實現，它們應該是小巧而明確的。決定如何將一個複雜程式拆分成較小的用例是具有挑戰性的，同時需要積累實踐經驗。但它能有效地限制各個問題和類的範圍。

用 VIPER 構建應用程式，需要實現一系列組件來滿足每個用例。應用邏輯是實現用例的重要且非唯一的組成部分。用例也會影響使用者介面。此外，需要考慮用例怎樣結合核心組件，比如網路和資料持久性。在用例中，組建就像外掛程式，VIPER 用來描述組件功能，以及它們之間彼此互動的方式。

待辦事項應用程式的一個用例或要求就是基於使用者選擇，對待辦事項進行分組。通過將資料轉換成用例的邏輯進行分離，我們能夠保持使用者介面代碼的整潔性，方便在測試中封裝用例，來確保它以正常方式繼續工作。

VIPER 的主要組件

VIPER 的主要組件有以下部分：

• 視圖：顯示展示器的要求，並返回使用者輸入。
• 互動器：包含用例指定的商務邏輯。
• 展示器：包含視圖邏輯用於準備顯示內容（從互動器接收的）並反饋使用者輸入（通過顯示器請求最新資料）。
• 實體：包含互動器所用的基本模型對象。
• 路由：包含導航邏輯來描述螢幕出現的順序。

這種分離也符合單一責任原則。互動器擔任商務分析師，展示器則成了互動設計師，視圖負責可視化設計。

下面是不同組件的以及它們的相互聯絡：

雖然 VIPER 的組件在應用中可以以任意順序組合實現，這裡我們選擇以推薦的實現順序來介紹組件。你會發現，這個順序與應用的構建過程基本一致，首先討論應用產品需要做什麼，其次是使用者如何與它進行互動。

互動器

互動代表應用程式中的一個用例，它包含商務邏輯用來操縱模型對象（實體）以進行特定任務。互動器所做的工作應該是獨立於任何使用者介面的。同樣的互動器可以在 iOS 應用或 OS X 應用中使用。

因為互動器是一個 PONSO（普通老式 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。如果你正在使用核心資料，你會希望你的管理對象最好保持在資料層後端。互動器不能直接使用 NSManagedObjects。

這是樣本應用的實體：

@interface VTDTodoItem : NSObject@property (nonatomic, strong)   NSDate*     dueDate;@property (nonatomic, copy)     NSString*   name;+ (instancetype)todoItemWithDueDate:(NSDate*)dueDate name:(NSString*)name;@end

如果你的實體都只是資料結構也別太驚訝，任何依賴於程式的邏輯，都應該在互動器中。

展示器

展示器是一個 PONSO，主要由邏輯組成來驅動使用者介面。它知道何時呈現使用者介面，收集使用者互動過程的輸入，用於即時更新 UI，並像互動器發送響應請求。

當使用者點擊+按鈕來添加新的待辦事項，addNewEntry 被調用。為了響應操作，展示器調用線框來顯示添加一個新項目的 UI：

- (void)addNewEntry{    [self.listWireframe presentAddInterface];}

展示器還可以顯示互動器接收結果，並將結果轉換成其它能在視圖中有效展示的形式。

下面是從展示器接收到待辦事項後所調用的方法。它將處理相關資料，並確定將哪些內容展現給使用者：

- (void)foundUpcomingItems:(NSArray*)upcomingItems{    if ([upcomingItems count] == 0)    {        [self.userInterface showNoContentMessage];    }    else    {        [self updateUserInterfaceWithUpcomingItems:upcomingItems];    }}

實體從來不會從互動器傳輸到展示器。相反，那些無行為的簡單資料結構卻可以傳輸。這樣可以防止任何「實際工作」在展示器中進行。展示器只負責準備視圖顯示中的資料。

視圖

視圖通常是被動的。它顯示展示器傳輸來的內容；卻不能向展示器主動請求資料。為一個視圖定義的方法（例如 LoginView 需要登入介面），應該允許展示器在更高的抽象級進行通訊，展示器直接展示其內容，而不關心該內容要如何顯示。展示器不知道 UILabel、UIButton 等控制項，只知道維護內容以及顯示時機。內容要如何展示完全取決於視圖。

視圖是一個抽象的介面，適用協議用 Objective-C 中定義。一個 UIViewController 或它的子類將實現 View 協議。例如本例中的「添加」介面有如下介面：

@protocol VTDAddViewInterface <NSObject>- (void)setEntryName:(NSString *)name;- (void)setEntryDueDate:(NSDate *)date;@end

視圖和視圖控制器還處理使用者互動和使用者輸入。所以不難理解為什麼視圖控制器通常很龐大，因為他們最容易處理使用者輸入並執行相關動作。為了保持視圖控制器傾斜，需要讓它們在使用者採取某些動作後，通知有效途徑告知有關各方。視圖控制器不對使用者動作做出響應，只將事件傳遞給回應程式法。

本例中，添加視圖控制器的事件處理屬性，有如下介面：

@protocol VTDAddModuleInterface <NSObject>- (void)cancelAddAction;- (void)saveAddActionWithName:(NSString *)name dueDate:(NSDate *)dueDate@end

當使用者點擊取消按鈕，視圖控制器告知事件處理機制，使用者需要取消此添加操作。這樣一來，該事件處理機制可以取消添加視圖控制器，並告知列表視圖以更新。

視圖和展示器之間的邊界可用於 ReactiveCocoa。在本例中，視圖控制器還能提供方法以返回表示按鈕動作的訊號。這將允許展示器更容易地對訊號做出反饋，而無需破壞責任地區的獨立。

路由

介面之間的路由在互動設計師建立的線框中定義。在 VIPER 中，路由的任務是實現展示器和線框之間的共用。線框對象包括 theUIWindow、UINavigationController 和 UIViewController 等，它負責建立視圖/視圖控制器，並在視窗中完成裝配。

由於展示器包含響應使用者輸入的邏輯，所以它知道何時該導航到其他螢幕，應導航到哪個介面，同時，線框知道如何進行導航。展示器主要使用線框實現導航功能。線框和展示器協同描述一個螢幕到下一個的路由的過程。

線框便於處理導航過渡動畫。來看看下面添加線框的例子：

@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<UIViewControllerAnimatedTransitioning>)animationControllerForDismissedController:(UIViewController *)dismissed {    return [[VTDAddDismissalTransition alloc] init];}- (id<UIViewControllerAnimatedTransitioning>)animationControllerForPresentedController:(UIViewController *)presented                                                                presentingController:(UIViewController *)presenting                                                                    sourceController:(UIViewController *)source {    return [[VTDAddPresentationTransition alloc] init];}@end

該應用程式使用自訂視圖控制器過渡來添加視圖控制器。由於線框負責執行過渡，它成為添加視圖控制器的過渡委託，並能返回恰當的過渡動畫。

用 VIPER 組織應用組件

建造 iOS 應用的架構時需要明白，作為主要開發工具，UIKit 和 Cocaa Touch 的作用是打造應用的「門面」。架構需要與應用的所有組件和平共處，但它也需要為部分架構的使用，以及處於什麼位置提供建議。

iOS 應用的主力是 UIViewController，它很時常被認為是取代 MVC 的競爭者，能大量減少使用視圖控制器。但是視圖控制器是平台的中心：他們處理方向變化、響應使用者輸入、整合系統組件比如導航控制器。（未完待續…）

敬請持續關註：《用 VIPER 構建 iOS 應用架構》系列（2）.

原文地址：Architecting iOS Apps with VIPER

本文系 OneAPM 工程師編譯整理。OneAPM 是應用效能管理領域的新興領軍企業，能協助企業使用者和開發人員輕鬆實現：緩慢的程式碼和 SQL 陳述式的即時抓取。想閱讀更多技術文章，請訪問 OneAPM 官方部落格。

用 VIPER 構建 iOS 應用架構（1）