iOS遗留系统重构实践

   <h2>背景</h2>    <p>在一个有着良好分层结构的系统中，每一层都有它自己的职责：显示层负责响应用户事件，调用业务层的逻辑，最后做数据呈现；业务逻辑层负责业务规则与数据处理；数据访问层封装底层数据库的操作，网络访问层与其并列，负责网络请求、json解析等等。无论是MVC、MVVM、VIPER，归根结底都是在”单一职责“、“关注点分离”、“高内聚低耦合”的原则下变化，只是表现形式和涵盖的层次各异。</p>    <p>而在我们的代码中，几乎所有的显示层对象，包括ViewController、ViewModel，甚至View里面都混杂了大量的CoreData API调用，直接进行数据库操作。</p>    <p>粗略统计了一下，系统中一共有25个类与NSManageContext紧紧耦合。形成了下图中混乱的局面：</p>    <p>(点击放大图像)</p>    <p><img src="https://simg.open-open.com/show/1872faefcf7c131a9b80d45af5e3b526.jpg"></p>    <p>面对这种情况，我们首先要做的就是解耦。</p>    <h2>方案选型</h2>    <p>我们最先排除掉的是重写这种简单粗暴的方式。表面上看来，我们可以通过重写得到一个干净利落的方案，层次结构清晰，职责分离；但与之相伴的是巨大的风险：</p>    <ul>     <li> <p>范围不可控——遗留系统的难点就在于牵一发而动全身，影响范围极广。稍不留神，重写的工作就会如野火燎原般蔓延开来，不可收拾。</p> </li>     <li> <p>长时间无法上线——在整个过程中，直到最后完成的那一刻之前，系统会处于一直不可用的状态。漫长的时间里，所有的新功能都被阻塞，不能交付。没有哪个产品团队能承担这样的结果。</p> </li>    </ul>    <p>第二个被排除掉的方案是特性分支。把重写的工作放到分支上完成，其他人继续在主干上开发新特性，直到重写结束再合并回主干——这种做法确实比直接重写要好上那么一点点，因为新特性还是可以不受影响的；但长期没有跟主干合并的分支，在经历上四五个月的重写之后，天知道到最后要花多长时间来处理合并冲突？</p>    <p>既想减小对系统的影响，又想不影响新功能上线，又不想处理大量的合并冲突，最后的方案就只剩下了一种，那就是抽象分支（Branch by Abstraction）+特性开关（Feature Toggle）。</p>    <h2>抽象分支</h2>    <p>抽象分支这个名字的缘起是针对版本库分支而言的，它允许开发者在一条“抽象”的分支上并行工作，无需创建一条实际的分支，从而避免无谓的合并开销。</p>    <p>Martin Fowler 和 Jez Humble 都曾在多年前撰文介绍过这个重构方案</p>    <ul>     <li> <p>http://martinfowler.com/bliki/BranchByAbstraction.html</p> </li>     <li> <p>http://continuousdelivery.com/2011/05/make-large-scale-changes-incrementally-with-branch-by-abstraction/</p> </li>    </ul>    <p>它的工作原理很简单：当我们想要替换掉系统中的某个组件——名为X——时，首先为X组件创造一个抽象层，这一层里面可能会有大大小小若干接口或是协议，把系统中对X组件的访问都隔离在抽象层之下，系统只调用抽象的接口/协议，不会接触到具体的API实现。如下图所示。</p>    <p><img src="https://simg.open-open.com/show/ce77143782d644e7bbb200c1f317e030.jpg"></p>    <p>这一步我们可以通过提取方法、提取类和接口等重构手法来完成；这以后系统就彻底跟X组件解耦了，它依赖的只是一组抽象接口，而非具体实现。这时候，我们就可以着手在这个抽象层下面，进行新组件的开发工作，让它也实现同一套接口即可。</p>    <p><img src="https://simg.open-open.com/show/2fa986e90dedef9f382e7beac0d7d192.jpg"></p>    <p>这之后，我们再使用特性开关（其原理及实现见下节），让这个抽象层在生产环境下调用旧组件，测试环境下调用新组件，从而在完全不影响交付的情况下，完成对新组件的测试。测试结束后，就可以打开开关，让系统在线上使用新组件，等彻底稳定后，把开关代码和旧组件代码全部删掉，替换工作就完成了。</p>    <p><img src="https://simg.open-open.com/show/249860ee5844aae932f645b37367aacb.jpg"></p>    <p>在上述整个开发过程中，任何一个阶段都可以做到细粒度的任务分解，然后小步提交，每次提交都自动触发单元测试和集成测试，保证不影响现有功能。在频繁提交的情况下，也不会出现大量的代码合并冲突，无论是做组件替换还是新特性开发，开发人员都可以基于同一套代码库工作。这就大大减少了对系统的冲击和交付风险。</p>    <h2>特性开关</h2>    <p>先看一段代码：</p>    <p><img src="https://simg.open-open.com/show/3bf4f8a0dfd6ed1d8913ed5725a336ba.jpg"></p>    <p>在这个例子中，我们要替换一个Storyboard的布局和相关ViewController的功能，耗时很久，如果直接在主干上修改，就会直接影响到现有的App，在功能完成之前都无法上线；如果拉一条分支出来做，未来就又会有大量的合并冲突。使用如上的特性开关就会避免上述问题。</p>    <p>当shouldDisplayNewSearchResultsScreen的值返回为真，就使用新的Storyboard，返回为假，就使用旧的Storyboard。这样一来，只要开关处于关闭状态，未完成的功能就是对用户不可见的，我们就既可以在开发环境下自测，也可以部署到测试环境下做验收测试，还可以针对开关为真的情况写对应的单元测试，让每次代码提交都有持续集成验证。这期间还可以继续发布新版本，用户完全感知不到影响，直到我们决定打开开关为止。</p>    <p>特性开关可以有多种实现方式。</p>    <ul>     <li> <h3>预编译参数</h3> </li>    </ul>    <p>在预编译参数中传值，让不同的xcconfig文件传入不同的值，然后在代码中做判断。</p>    <p>我们系统中绝大部分的特性开关都是用这种方式实现的。</p>    <ul>     <li> <h3>NSUserDefaults</h3> </li>    </ul>    <p>有些功能可能对App有破坏性的影响，即便是设成只对Internal Target可见，也会影响到QA的回归测试。我们给Internal Target做了个Developer Settings界面，让开发人员可以自己修改开关状态，把开关的值存放在NSUserDefaults里面，默认返回false，只有在界面上手工切换之后才会返回true。测试和开发互相不受影响。</p>    <p>我们向Realm迁移的特性开关使用的就是这种方式。</p>    <ul>     <li> <h3>服务器取值</h3> </li>    </ul>    <p>配置参数的值也可以通过服务器下发。这种做法的好处是比较灵活，在启用/禁用某项功能的时候不需要发布新版本，只需要后台配置，缺点是会增加集成和后台开发的工作量。</p>    <ul>     <li> <p>A/B测试</p> </li>    </ul>    <p>还有一个办法是使用第三方的A/B测试服务，如果缺少后台开发人员的话，这也是一个选择。但第三方的稳定性往往就会成为制约因素，Parse为推送通知提供过A/B测试服务，但是它到了17年就会被关闭了；我们用Amazon的A/B测试框架用了一段时间，然后Amazon也宣布今年8月份停用……目前我们还在寻找备选方案。</p>    <h2>具体实现</h2>    <p>在具体落实抽象分支和特性开关的时候，一共分成了如下几个阶段：</p>    <h2>建立数据访问层</h2>    <p>我们首先把跟数据请求有关的操作从ViewController中提取成一个方法，放到另一个对象中实现，以便日后替换。然后把所有的数据访问的方法都提取成一个协议，让数据层之上的对象都依赖于这个协议，而不是具体对象。这样一来，原先的ViewController就从下图中的样子：</p>    <p><img src="https://simg.open-open.com/show/a2ecc8bc22a260717d72eaa2da320ceb.jpg"></p>    <p>变成了这样：</p>    <p><img src="https://simg.open-open.com/show/02f844976426bf692206b6d8a1822231.jpg"></p>    <h2>为数据对象提取协议</h2>    <p>除了数据访问的代码以外，我们还把所有的数据对象上的公有属性和方法都提取了相应的协议，然后修改了整个App，让它使用协议，而不是具体的数据对象。这也是为以后的切换做准备。</p>    <h2>使用Realm实现</h2>    <p>前两步完成之后，我们就建立起了一个完整的抽象层。在这层之上，App里已经没有了对CoreData和数据对象的依赖，我们可以在这层抽象之下，提供一套全新的实现，用来替换CoreData。</p>    <p>在实现过程中，我们还是遇到了不少需要磨合的细节，比如Realm中的一对多关联是通过RLMArray实现的，并不是真正的NSArray，为了保证接口的兼容性，我们就只能把property定义为RLMArray，再提供一个NSArray的getter方法。种种问题不一而足。</p>    <h2>切换开关状态</h2>    <p>上篇文章说到，我们在迁移过程中的特性开关是用NSUserDefaults实现的，在界面上手工切换开关状态。这样的好处是开发过程不会影响在Hockey和TestFlight上内部发布。直到实现完成后，我们再把开关改成</p>    <pre>  + (BOOL)shouldUseRealm {  return isInternalTarget; }</pre>    <p>让测试人员可以在真机上测试。回归测试结束之后，再让开关直接返回true，就可以向App Store提交了。</p>    <h2>数据迁移</h2>    <p>这个无需多说，写个MigrationManager之类的类，用来把数据从CoreData中读出，写到Realm里面去。这个类大概要保留上三四个版本，等绝大部分用户都已经升级到新版本之后才会删掉。</p>    <h2>后续清理</h2>    <p>特性开关是不能一直存活下去的，否则代码中的分支判断会越来越多。我们一般都会在上线一两个星期之后，发现没有出现特别严重的crash，就把跟开关有关的代码全都删掉。</p>    <p>在第一步建立数据访问层的时候，我们创建出了一个特别庞大的PersistenceService，它里面含有所有的数据访问方法。这只是为了方便切换而已，切换完成后，我们还是要根据访问数据的不同，建立一个个小的Repository，然后让ViewModel对象访问Repository读写数据，把PersistenceService删掉。</p>    <p>最后形成的架构如图所示：</p>    <p><img src="https://simg.open-open.com/show/b52fa8918ffbcd6983724928a8e31204.jpg"></p>    <h2>总结</h2>    <p>首先，要勇敢面对遗留代码库，团队里一定要有人站出来跟大家说，我们不能让代码继续腐烂下去，我们要有清晰的目标和正确的策略，在重构中让优秀的设计渐渐涌现。这才是正途。</p>    <h3>要有正确的方法</h3>    <p>在遗留代码中工作，Long-Term Refactoring是不可或缺的。人们需要预见到在未来的产品规划中，哪些组件应当被替换，哪部分架构需要作出调整，把它们放到迭代计划里面来，当做日常工作的一部分。抽象分支和特性开关在Long-Term Refactoring可以发挥显著的效果，它们是持续交付的保障。</p>    <h3>设计会过时，但设计原则不会</h3>    <p>很多技术决策都不是非黑即白的，它们更像是在种种约束下做出的权衡。时光会褪色，框架会过时，脱离了具体场景，今天的优秀设计也会沦落成明天的遗留代码，但设计原则有着不动声色的力量。我们无法预见未来，只能根据当前的情况做出简单而灵活的设计。这样的设计应当服从这些设计原则：单一职责、关注点分离、不要和陌生人说话……让我们的代码尽可能保持高内聚低耦合，保证良好的可测试性。</p>    <h3>标题</h3>    <p>Q：单元测试与集成测试，采用的是哪些工具呢？是Xcode自带的吗？</p>    <p>A：单元测试针对oc用的是Kiwi，针对swift用的是Quick</p>    <p>Q：李剑老师说的repo具体是什么，就是把persistentanceService拆分的是什么？</p>    <p>A：repo具体来说就是针对不同的数据对象封装的读写操作的类，比如代码中有person, event等等，那就会有PersonRepo, EventRepo。先前为了FeatureToggle方便，我们是把所有数据操作集中在persistentanceService里面。但是这个类就太大了，在切换完成后我们要分拆。</p>    <p>Q：数据访问层是一个单例抽象的吗？在这一层封装了所有数据访问的方法吗？</p>    <p>A：在迁移过程中数据访问层是一个单例对象，迁移完毕后根据具体职责不同，再拆分成更小的对象</p>    <p>Q：一个特别庞大的PersistenceService，以后是怎么拆分的。是根据具体的业务拆分么？</p>    <p>A：主要是根据所要读写的数据对象不同而拆分。如果出现需要读写多个数据对象的情况，如果逻辑不会重用，我们一般就都让ViewModel来处理，如果需要重用，就再提取一个类出来做。</p>    <p>Q：realm坑多吗？</p>    <p>A：坑不少，跟CoreData相比，学习曲线很低，也很灵活。但是处理对象关联关系的时候有点绕。然后它目前对fine grained notification的支持也不好，给我们的抽象层带来了不少麻烦。</p>    <p>Q：是出于什么原因考虑使用realm的？相比coredata和fmdb之类的有什么比较么？为什么不用sqlite，再数据存储上realm的效率跟sqlite有什么优点么？</p>    <p>A：CoreData学习曲线太高，而且我们都觉得它的设计已经陈腐了，如果直接用sqlite，最常见的库也就是fmdb了，可是fmdb跟Java里面jdbc也没啥差别，不想手工来做读取ResultSet，一点点构造对象这种事情，还是希望有一个ORM</p>    <p>Q：中间层的构建有什么好的经验，如何保证中间层的健壮性 ？</p>    <p>A：中间层的构建，我觉得比较重要的是要有明确的界限，职责清晰。在跟第三方库集成的时候，要考虑到如果有一天要去掉这个库或者替换它，会有多大的难度。</p>    <p>我没有太多的可以泛泛而谈的东西，只能说架构这种东西都是权衡，在各种约束下的权衡。比如在本文的例子中，当CoreData被Realm所替换以后，抽象层还要不要保留？ViewModel应该直接调用Repository，还是RepositoryProtocol？有人会觉得这一层抽象就好比只有单一实现的接口一样，没有存在的价值，有人会觉得几年后Realm也会过时被新的数据库取代，如果保留这层抽象，就会让那时候的迁移工作变得简单。但无论怎么做，过上一两年后，新加入团队的人都可能会觉得之前那些人做的很傻。我们只能说尽量服从设计原则。</p>    <p>Q：原来的一堆代码，本来就没有model之类的单一职责类，代码本来就严重耦合，分享的直接就来替换下层实现，那中间层就代码本来就不具有，怎么把新的mode引入又不影响新功能的开发?</p>    <p>A：我们的代码严重耦合，体现在视图层直接访问数据库上，我们首先提取出一个persistenceService，把数据访问的代码做封装，这样视图层跟数据库就有了隔离。替换完成后，再把persistenceService拆成一个个小的repository，这样就有了一个良好的数据访问层。再接下来，按照抽象分支和特性开关的做法，架构可以一步步优化出来。</p>    <p>Q：从coredata进行的数据库层迁移，有考虑过magicalrecord吗？为何选择realm。理论上这样成本更低，magicalrecord是基于coredata的，使用也很广泛。</p>    <p>A：我记得我们问过他是否推荐magicalrecord，他的回答是他建议使用Realm……另外就是我们对CoreData的这一套设计已经受够了，migration成本也高。</p>    <p>来自： http://www.infoq.com/cn/articles/ios-legacy-codebase-refactor</p>