深度重构 UIViewController

   <p>UIViewController是iOS应用的基础业务单位，每个iOS程序员都写过无数的Controller。今天和大家一起来深度解剖Controller，看看怎么来做一次深度的重构。</p>    <h3><strong>重构的前提</strong></h3>    <p>我们应该谨慎的去重构我们的代码。iOS系统提供的UIViewController一定程度上可以很好的应付简单的页面单位，对于复杂的页面，我们也可以采用市面上主流的MV(X)系列模式，比如MVP，MVVM等。但随着单个Controller内业务进一步增长，我们需要更细粒度的重构，或者说对MV(X)做进一步的定制。</p>    <p>以下图映客App两个页面为例。</p>    <p><img src="https://simg.open-open.com/show/906fd60908313036ff244a409be3319a.jpg"></p>    <p>左边页面元素少且静态，一个TableView基本上就能应付，右边的直播页面则元素多且动态，传统的MV(X)也会显得粒度太粗，这类复杂页面虽然不常遇到，但往往体现一个App的核心功能，合理的搭建或者重构这类Controller十分重要。</p>    <h3><strong>重构的本质</strong></h3>    <p>如何去定义重构，以我的理解可以归纳为两个关键词：分解，连接。</p>    <p>重构的前提是复杂，臃肿，不直观，重构的手段是分解之后再连接。以映客的直播界面为例，UI元素，用户事件，服务器交互等基础元素都非常之多，以一个简单的MVP去归类代码犹嫌不足，我们还需要进一步的分解成view1,view2…viewN,presenter1,presenter2…presenterN,model1,model2…modelN，第二个问题是如何把这一个个的类文件或者说功能单位合理组织连接起来。完成上述两步我们就完成了一次重构，每一次将代码打散再串联就是一次重构。</p>    <h3><strong>分解UIViewController</strong></h3>    <p>写了那么多Controller，让你来说下一个Controller都细分为哪些更小的功能单位，你能随口说出来么？只有做过足够多的业务，才能慢慢对Controller的构成有自己的理解。</p>    <p>当然可以回答说MVC或者MVP，但这个答案粒度太粗，一个Controller内部会发生哪些事可以说的更细，我们看下VIPER的答案：</p>    <ul>     <li><strong>View:</strong> displays what it is told to by the Presenter and relays user input back to the Presenter.</li>     <li><strong>Interactor:</strong> contains the business logic as specified by a use case.</li>     <li><strong>Presenter:</strong> contains view logic for preparing content for display (as received from the Interactor) and for reacting to user inputs (by requesting new data from the Interactor).</li>     <li><strong>Entity:</strong> contains basic model objects used by the Interactor.</li>     <li><strong>Routing:</strong> contains navigation logic for describing which screens are shown in which order</li>    </ul>    <p>View不用多说，可以分解成更多的子View，最后合成一个树形结构。</p>    <p>Entity自然是代表Model。</p>    <p>MVC当中的C，MVP当中的P，被细分成了Interactor，Presenter，和Routing。这三个角色各自负责什么职责呢？</p>    <p>Routing比较清楚，处理页面之间的跳转。我见过的项目代码里，很少有把这一部分单独拎出来的，但其实很有意义，这部分代表的是不同Controller之间耦合依赖的方式，无论是从类关系描述的角度还是Debug的角度，都能帮助我们快速定位代码。</p>    <p>Interactor和Presenter初看起来很类似，似乎都是在处理业务逻辑。但业务逻辑其实是个大的归类，可以描述任何一种业务场景和行为。Interactor当中有个很重要的术语：use case，这个术语很多技术文章中都会遇见，它代表的是一个完整的，独立的，细分过后的业务流程，比如我们App当中的登录模块，它是一个业务单位，但它其实可以进一步的细分为很多的use case：</p>    <p>use case 1: 验证邮箱长度</p>    <p>use case 2: 密码强度检验</p>    <p>use case 3: 从Server查询user name是否可用</p>    <p>…</p>    <p>user case N</p>    <p>定义use case有什么好处呢？</p>    <p>好处当然是分门别类，结构清晰。你把100本书堆一堆，或者放书架上按类别摆放，下次找书的时候那种方式你更舒服？独立出一个个的use case还有一个好处是方便unit test，如果项目对每一个use case都有写对应的unit test，每次遇到“前一发动全身“的业务更改，可以边杯茶边写代码。</p>    <p>我见过不少代码都体现不出use case的分类，可以回头看下自己当前项目的登录模块，上面我提到的这些case有没有在类文件当中合理摆放，还是都搅在一起？</p>    <p>所以VIPER当中interactor的说法是强化大家写单独的use case的意识，打开interactor.m，看到一个函数代表一个use case，同一类的use case再用#pragma mark 归在一块，别人看你代码时能不赏心悦目吗？</p>    <p>再说到Presenter，Presenter可以看做是上面一个个use case的使用者和响应者。使用者将各个use case串联起来描述一个完整详细的业务流程，比如我们的登录模块，每次用户点击按钮注册的时候，会触发一系列的use case，从检验用户输入合法性，设备网络状态，服务器资源是否可用，到最后处理结果并展示，这就是一个完整的业务流程，这个流程由Presenter来描述。响应者表示Presenter在接收到服务器反馈之后进一步改变本地的状态，比如view的展示，新的数据修改等，甚至会调用Routing发生页面跳转。</p>    <p>说到这里就比较明了了，interactor和routing都是服务的提供方，presenter是服务的使用和集成方。VIPER说白了不过是对传统的MVC当中的C做了进一步细分。</p>    <p><strong>能不能分的更细呢？</strong></p>    <p>当然可以，VIPER的分法是一种通用的做法，我们还可以从业务的角度去做细分。拿映客的直播界面做例子，比如Presenter当中包含了很多完整的业务流程：</p>    <ul>     <li>收到用户消息并展示</li>     <li>收到礼品消息并展示</li>     <li>收到弹幕消息并展示</li>     <li>收到用户进出房间的事件，处理并展示</li>     <li>收到XXX，处理并展示</li>    </ul>    <p>以Objective C语言的特性，我们可以生成更多的Presenter Category来安置这些流程，比如LivePresenter+Message, LivePresenter+Gift, LivePresenter+Danmu, LivePresenter+Room, LivePresenter+XXX。</p>    <p>不要觉得上面几个业务流程很简单，一个presenter处理绰绰有余，我前段时间刚好做过一个直播项目，Presenter类超过1000行代码很轻松。</p>    <p>还可以进一步细分，一个功能复杂繁多的页面基本上离不开UITableView，而tableview的代码量主要在于delegate和datasource。这两个职责当然可以放在presenter当中，或者我们向Android学习，把它们也独立出来放到单独的类文件中去处理，比如叫做Adapter，用代码来说就是：</p>    <pre>  <code class="language-objectivec">_tableView.delegate = self.adapter;  _tableView.dataSource = self.adapter;</code></pre>    <p>和tableView相关的这些代码都搬到了adapter当中：</p>    <pre>  <code class="language-objectivec">@protocol UITableViewDelegate    - (CGFloat)tableView:(UITableView *)tableView heightForRowAtIndexPath:(NSIndexPath *)indexPath;  - (CGFloat)tableView:(UITableView *)tableView heightForHeaderInSection:(NSInteger)section;  - (CGFloat)tableView:(UITableView *)tableView heightForFooterInSection:(NSInteger)section;    @end    @protocol UITableViewDataSource<NSObject>    @required  - (NSInteger)tableView:(UITableView *)tableView numberOfRowsInSection:(NSInteger)section;  - (UITableViewCell *)tableView:(UITableView *)tableView cellForRowAtIndexPath:(NSIndexPath *)indexPath;    @end</code></pre>    <p>我们的Presenter就变得更加干净了，看起来和刚大扫除过的房间一样令人愉悦。</p>    <p>好了，到这里我们盘子里的牛排已经被切成很多小块了，可以开始享用这些美味的代码了，继续我们的第二步工作：连接。</p>    <h3><strong>连接</strong></h3>    <p>先看下我们分解之后有哪些元素：</p>    <p>view(1…N), model(1…N), interactor, presenter(1…N), routing, adapter。看着应该粒度够细了，对于复杂的Controller，我个人习惯的做法和VIPER相近，但略有不同，Interactor当中的use case通过分层的架构被我放到server layer，分层的架构是另一个话题，这里不做细述。其他元素基本一致。</p>    <p>至于怎么连接，手段无非就是OC的几种类交互机制：</p>    <p><strong>Delegate, Target-Action, Block, Notification, KVO。</strong></p>    <p>这几者之间的差异可以参考objc.io的一篇经典文章。选择不同对耦合度，开发便捷性，调试是否方便等都会产生影响，如何应用不同的机制将各个单位串联起来就看架构师自己的积累和理解了，任何一个选择都有其优势和局限性。</p>    <p>如果拿捏不准选哪个好的时候，我个人建议就使用delegate，朴素可靠且直观。delegate需要在不同的元素之间传递，代码量会偏多一些，但优点在protocol定义清晰，耦合在哪里一目了然，记得要注意循环引用的问题。</p>    <p>我早些时候其他几种机制都在实际项目中做过尝试，最后综合比较还是倾向于选择delegate，再后来经过一番脑洞（主要是为了解决传递delegate所带来的额外代码量），利用runtime特性，做了一个CDD机制来自动串联各个功能单位。CDD的详细介绍在之前的博客中有，这里也不细述了，其本质或者说最终目的还是在于连接。</p>    <p>说完了分解和连接，Controller的重构完成了大半，还剩下一个至关重要的概念：状态分享。</p>    <h3><strong>尽量避免跨类，跨模块或跨层共享状态</strong></h3>    <p>我之前在一篇博客中谈到过对于程序状态的维护。状态是否维护得好对于程序的整体稳定性很有影响，对于Controller当中的状态维护我有一个简单的建议：</p>    <p><strong>传递状态的时候尽可能Copy</strong></p>    <p>之前流行的函数式编程其实就很强调无状态性，无状态不是让大家不定义状态变量，而是避免函数之间的状态共享，具体到OC当中，就是不要在不同的功能单位里使用指向同一块内存拷贝的地址，为什么共享状态是一件危险的事，我在之前的文章中也介绍过。</p>    <p>一般来说，我们从Model Layer或者说数据层拿到的model实例，扔给Controller使用的时候应该是一份新的拷贝，在不同的类单位里共享NSMutableString或者NSMutableArray，NSMutableDictionary很容易让你的代码变得不稳定，而且这类不稳定性一般很难调试，debug填坑的时候经常按下葫芦浮起瓢。</p>    <p>在controller内部传递model或者state的时候，我们应该也尽量使用copy行为，任何state你一旦暴露出去就不再安全，自己创建，自己修改，自己销毁才是正途。说到</p>    <p>我之前介绍非死book架构的时候就提到过，非死book当中的model layer是由一个单独开发团队维护的，应用层开发人员（Controller开发人员）获取到的都是新的拷贝，要修改某个属性不一定有接口，甚至要向model的维护团队提交增加接口的申请，对于state维护的谨慎度可见一斑。</p>    <h3><strong>使用脚本生成原型代码</strong></h3>    <p>说了这么多，Controller重构的关键点都说完了。最后再提个小Tip，一旦Controller做深度细分之后，团队成员需要对Controller的分法和构成有一致的认识，写出来的代码应该保持一致，我的做法是通过脚本的方式生成Controller各个相关的类文件，比如我的Controller是如下结构：</p>    <p style="text-align:center"><img src="https://simg.open-open.com/show/5140738f6e6eb393f34f06b7214ef67b.jpg"></p>    <p> </p>    <p> </p>    <p>来自：http://mp.weixin.qq.com/s?__biz=MzI5MjEzNzA1MA==&mid=2650264176&idx=1&sn=6cf5d0f58dfacf93e84c2dc0f9ef4afc&chksm=f4068345c3710a537a05f2897f30179258d4eab36b7e29c33278ddd1b4277128090036599748</p>    <p> </p>