安居客Android项目架构演进

标签: 组件化 模块化开发 模块化 架构设计 Android | 发表时间:2017-02-24 15:54 | 作者:BaronZhang
分享到:
出处:https://segmentfault.com/blogs

入职安居客三年从工程师到Team Leader,见证了Android团队一路走来的发展历程。因此有心将这些记录下来与大家分享,也算是对自己三年来一部分工作的总结。希望对大家有所帮助,更希望能得到大家宝贵的建议。

三网合并

三年前入职时安居客在业务上刚完成了三网合并(新房、二手房、好租和商业地产多个平台多个网站合成现在的anjuke.com,这在公司的历史上称之为三网合并),因此app端也将原先的新房、二手房、好租和商业地产多个app合并成为了现在的安居客app。所谓的合并也差不多就是将多个项目的代码拷贝到了一起组成了新的Anjuke Project。下面这张图能更加直观的呈现当时的状况。
clipboard.png

这一时期代码结构混乱、层次不清,各业务技术方案不统一,冗余代码充斥项目的各个角落;甚至连基本的包结构也是胡乱不堪,项目架构更是无从谈起。大家只不过是不停地往上堆砌代码添加新功能罢了。于是我进入公司的第一件事就是向Leader申请梳理了整个项目的结构。

而后随着项目的迭代,我们不断引入了Retrofit、UniversalImageLoader、OKHttp、ButterKnife等一系列成熟的开源库,同时我们也开发了自己的UI组件库UIComponent、基础工具库CommonUtils、基于第三方地图封装的MapSDK、即时聊天模块ChatLibrary等等。这之后安居客项目架构大致演变成了由基础组件层、业务组件层和业务层组成的三层架构。如下图:
clipboard.png

其中业务层是一种非标准的MVC架构,Activity和Fragment承担了View和Controller的职责:
clipboard.png

前面这种分层的架构本身是没太大问题的,即使到了现在我们的业务项目也已然是基于这种分层的架构来构建的,只不过在不断的迭代中我们做了些许调整(分层架构后面在介绍组件化和模块化的时候会详细介绍)。但是随着业务的不断迭代,我们慢慢发现业务层这种非标准的MVC架构带来了种种影响团队开发效率的问题:

  • Activity和Fragment越来越多的同时承担了Controller和View的职责,导致他们变得及其臃肿且难以维护;

  • 由于Controller和View的揉合,导致单元测试起来很困难;

  • 回调嵌套太多,面对负责业务时的代码逻辑不清晰,难以理解且不利于后期维护;

  • 各层次模块之间职责不清晰等等

鉴于三网合并时期我还未加入安居客,所以对这一块的理解难免有偏差,如果有安居客的老同事发现文章中的描述有不对的地方还望批评指正。

由RxJava驱动的MVP架构

一种技术架构无法满足所有的业务项目,更不可能有一种架构方案能够一劳永逸。正如上一节中提到的随着业务的不断迭代,现有架构的缺陷逐渐浮出水面,项目架构必需不断升级迭代才能更好地服务于业务。

MVP的设计与实现

在研究了Google推出的基于MVP架构的demo后,我们发现MVP架构能解决现在所面临过的很多问题,于是我们学习并引入到了我们的项目中来,并针对性的做了部分调整。下图呈现的是安居客MVP方案:
clipboard.png

以前面提到的三层架构的方案来看是这样的:
clipboard.png

基于此架构我在GitHub上开源了一个项目 MinimalistWeather,有兴趣的小伙伴可以去clone下来看看,如果觉得对你有帮助就给个star吧。 :)

  • View Layer: 只负责UI的绘制呈现,包含Fragment和一些自定义的UI组件,View层需要实现ViewInterface接口。Activity在项目中不再负责View的职责,仅仅是一个全局的控制者,负责创建View和Presenter的实例;

  • Model Layer: 负责检索、存储、操作数据,包括来自网络、数据库、磁盘文件和SharedPreferences的数据;

  • Presenter Layer: 作为View Layer和Module Layer的之间的纽带,它从model层中获取数据,然后调用View的接口去控制View;

  • Contact: 我们参照Google的demo加入契约类Contact来统一管理View和Presenter的接口,使得某一功能模块的接口能更加直观的呈现出来,这样做是有利于后期维护的。

另外这套MVP架构还为我们带来了一个额外的好处: 我们有了足够明确的开发规范和标准。细致到了每一个类应该放到哪个包下,哪个类具体应该负责什么职责等等。这对于我们的Code Review、接手他人的功能模块等都提供了极大的便利。前面提到的 MinimalistWeather就是为了定规范定标准而开发的。

这一时期我们还在项目中引入了RxJava,很好的解决了前面提到的嵌套回调的问题,同时能够帮助我们简化复杂业务场景下的代码逻辑(当然RxJava的好处远远不止这么一点,对RxJava不了解的同学可以去翻翻我之前 一系列关于RxJava的文章)。我们也将网络库升级到了Retrofit2+OKHttp3,它们和RxJava之间能更好的配合。

MVP带来的新问题及解决方案

是不是升级到了MVP架构就高枕无忧了呢?很明显不是这样!MVP架构也会带来以下新的问题:

  • 由于大量的业务逻辑处理转移到了Presenter层,在一些复杂的业务场景中Presenter同样会变得臃肿难懂。细心的同学可能注意到了前面的架构图中的Model层有个Data Repository模块,Data Repository在这里有两个作用:一是可以将原本由Presenter处理的部分逻辑转移到这里来处理,包括数据的校验、部分单纯只与数据相关的逻辑等等,向Presenter屏蔽数据处理细节,比如作为Presenter就不必关心Model层传递过来的数据到底是来至网络还是来至数据库还是来至本地文件等等;二是我们引入了RxJava,但是只有网络层中的Retrofit能返回Observable对象,其他模块都是返回的还是一些非Observable的Java对象,为了能在整个Presenter层中都体验RxJava带来的美妙之处,因此可以通过Data Repository做一层转换;

  • 现在的MVP架构中最重的部分就是Model Layer了,这一点从前面的架构图中就能体现。因此这就要求我们在Model层的设计过程中职责划分要足够清晰,分包更明确,耦合度更低。至于分包大家可以参考 MinimalistWeather的方案:db包为数据库模块、http包为网络模块、preference包是对SharedPreferences的一些封装、repository包就是前面提到的Data Repository模块;

  • 同时还有一点需要注意,很多人在使用RxJava的过程中往往忘记了对生命周期的管理,这很容易造成内存泄露。 MinimalistWeather中采用了CompositeSubscription来管理,你也可以使用RxLifecycle这类开源库来管理生命周期。

组件化与模块化

去年下半年我们Android团队内部成立了技术小组,基础组件的开发是技术小组很重要的一部分工作,所以组件化是我们正在做的事;模块化更多的是现有的方案受到来自业务上的挑战以及受到了Oasis Feng在MDCC上的分享和整个大环境的启发,现在正处于设计规划和demo开发的阶段。

组件化

组件化不是个新概念,通俗的讲组件化就是基于可重用的目的,将一个大的软件系统拆分成一个个独立组件。

组件化的带来的好处不言而喻:

  • 避免重复造轮子,节省开发维护成本;

  • 降低项目复杂性,提升开发效率;

  • 多个团队公用同一个组件,在一定层度上确保了技术方案的统一性。

现在的安居客有是三个业务团队:安居客用户app、经纪人app、集客家app。为了避免各个业务团队重复造轮子,团队中也需要有一定的技术沉淀,因此组件化是必须的。从本篇的第一节大家就能看到组件化的影子,只不过在这之前我们做的并不好。现在我们需要提供更多的、职能单一、性能更优的组件供业务团队使用。根据业务相关性,我们将这些组件分为:基础组件和业务组件。后面在介绍模块化的时候会有进一步的描述。

模块化

自从Oasis Feng在去年的MDCC2016上分享了模块化的经验后,模块化在Android社区越来越多的被提起。我们自然也不落俗的去做了一些研究和探索。安居客现在面临很多问题:例如全量编译时间太长(我这台13款的MacBook Pro打一次包得花十多分钟);例如新房、二手房、租房等等模块间耦合严重,不利于多团队并行开发测试;另外在17年初公司重新将租房app捡起推广,单独让人来开发维护一个三年前的项目并不划算,所以我们希望能直接从现在的安居客用户端中拆分出租房模块作为一个单独的app发布上线。这样看来模块化似乎是一个不错的选择。

所以我们做模块化的目的大致是这样的:

  • 业务模块间解耦

  • 单个业务模块单独编译打包,加快编译速度

  • 多团队间并行开发、测试

  • 解决好租App需要单独维护的问题,降低研发成本

15年Trinea还在安居客的时候开发了一套插件化框架,但受限于当时的团队规模并且插件化对整个项目的改造太大,因此在安居客团队中插件化并未实施下来。而模块化其实是个很好的过渡方案,将项目按照模块拆分后各业务模块间解耦的问题不存在了,后续如有必要,再进行插件化改造只不过是水到渠成的事。

来看看安居客用户app的模块化设计图:
clipboard.png

整个项目分为三层,从下往上分别是:

  • Basic Component Layer: 基础组件层,顾名思义就是一些基础组件,包含了各种开源库以及和业务无关的各种自研工具库;

  • Business Component Layer: 业务组件层,这一层的所有组件都是业务相关的,例如上图中的支付组件AnjukePay、数据模拟组件DataSimulator等等;

  • Business Module Layer: 业务module层,在Android Studio中每块业务对应一个单独的module。例如安居客用户app我们就可以拆分成新房module、二手房module、IM module等等,每个单独的Business Module都必须准遵守前面提到的MVP架构。

同时针对模块化我们也需要定义一些自己的游戏规则:

  • 对于Business Module Layer,各业务模块之间的通讯跳转采用路由框架Router来实现(可能会采用成熟的开源库,也可能会选择重复造轮子);

  • 对于Business Component Layer,单一业务组件只能对应某一项具体的业务,对于有个性化需求的对外部提供接口让调用方定制;

  • 合理控制各组件和各业务模块的拆分粒度,太小的公有模块不足以构成单独组件或者模块的,我们先放到类似于CommonBusuness的组件中,在后期不断的重构迭代中视情况进行进一步的拆分(这一点的灵感来源于 Trinea的文章);

  • 上层的公有的业务或者功能模块可以逐步下放到下层,合理把握好度就好;

  • 各Layer间严禁反向依赖,横向依赖关系由各业务Leader和技术小组商讨决定。

对于模块化项目,每个单独的business module都可以单独编译成APK。在开发阶段需要单独打包编译,项目发布的时候又需要它作为项目的一个module来整体编译打包。简单的说就是开发时是application,发布时是library。因此需要你在business module的gradle配置文件中加入如下代码:

  if(isBuildModule.toBoolean()){
    apply plugin: 'com.android.application'
}else{
    apply plugin: 'com.android.library'
}

如果我们需要把租房模块打包成一个单独的租房app,像下面这样就好:
clipboard.png

我们可以把Basic Component Layer和Business Component Layer放在一起看做是Anjuke SDK,新的业务或者项目只需要依赖Anjuke SDK就好(这一点同样是受到了 Trinea文章的启发)。甚至我们可以做得更极致一些,开发一套自己的组件管理平台,业务方可以根据自己的需求选择自己需要的组件,定制业务专属的Anjuke SDK。业务端和Anjuke SDK的关系如下图所示:
clipboard.png

最后看看安居客模块化的整体设计图:
clipboard.png

模块化拆分对于安居客这种比较大型的商业项目而言,由于历史比较久远很多代码都运行五六年了;各个业务相互交叉耦合严重,所以实施起来还是有很大难度的。过程中难免会有预料不到的坑,这就需要我们对各个业务有较深的理解同时也要足够的耐心和细致。虽然辛苦,但是一旦完成模块化拆分对整个团队及公司业务上的帮助是很大的。

以上是我的简单总结以及对模块化的一些思考,不足之处还望大家批评指正。后面模块化的demo完善后我会把它放到GitHub,并再出一篇文章详细介绍模块化的设计实现细节。

参考资料:

如果你喜欢我的文章,就关注下我的知乎专栏或者在GitHub上添个star吧!

相关 [安居 android 项目] 推荐:

安居客Android项目架构演进

- - SegmentFault 最新的文章
入职安居客三年从工程师到Team Leader,见证了Android团队一路走来的发展历程. 因此有心将这些记录下来与大家分享,也算是对自己三年来一部分工作的总结. 希望对大家有所帮助,更希望能得到大家宝贵的建议. 三年前入职时安居客在业务上刚完成了三网合并(新房、二手房、好租和商业地产多个平台多个网站合成现在的anjuke.com,这在公司的历史上称之为三网合并),因此app端也将原先的新房、二手房、好租和商业地产多个app合并成为了现在的安居客app.

Canonical 宣布 Ubuntu for Android 项目

- - Wow! Ubuntu
Canonical 正式宣布推出 Ubuntu for Android 项目,从官方介绍来看,这个项目并不是要取代 Android 作为手机操作系统,而是把整个 Ubuntu 桌面系统无缝整合到 Android 中,Android 与 Ubuntu 会共用一个 Linux 内核. 在安装 Ubuntu for Android 后,用户就可以把这台 Android 手机当作一台便携式电脑,你可以通过支持 HDMI 接口的配件与显示器连接,这样就可以体验 Ubuntu Unity 界面了.

Android优秀开源项目

- - CSDN博客移动开发推荐文章
Android经典的开源项目其实非常多,但是国内的博客总是拿着N年前的一篇复制来复制去,实在是不利于新手学习. 今天爬爬把自己熟悉的一些开源项目整理起来,希望能对 Android开发同学们有所帮助. 另外,如果你有比较好的项目推荐,也烦请在评论里分享出来,我会定期更新博客内容. Apollo音乐播放器:就一个播放器,但是实现的很好.

Google code android开源项目(四)

- - CSDN博客推荐文章
一个简洁的android rss阅读器. 创建者写的一些应用包括:闹钟和调节屏幕亮度小工具等. 远程控制winamp(5.5以上版本).  Tesseract OCR(HP实验室开源的)封装的 Android APIs. 使用 visual studio 开发Android NDK C/C++ . android版quake2.

GitHub 优秀的 Android 开源项目

- - 移动开发 - ITeye博客
GitHub 优秀的 Android 开源项目. 转自:http://blog.csdn.net/shulianghan/article/details/18046021. 主要介绍那些不错个性化的View,包括ListView、ActionBar、Menu、ViewPager、Gallery、GridView、ImageView、ProgressBar及其他如Dialog、Toast、EditText、TableView、Activity Animation等等.

Android上运行QT项目Necessitas的基本原理

- - CSDN博客推荐文章
by 宋宝华 <21cnbao@gmail.com>. 作者:21cnbao 发表于2012-1-18 16:25:46 原文链接. 阅读:11 评论:0 查看评论.

Google 将 Android 4.0.4 源代码送交 AOSP 开源项目

- - Engadget 中国版
分类: 智能手机, 平板电脑. 我们先来解释下 AOSP ,实际上就是 Android Open-Source Project 的缩写,中文直接理解就是 Android 开放源代码项目. 虽然官方并没有正式宣布 Android 4.0.4 开源,但看来这个时间点应该很快. Ice Cream sandwich 最新的版本在早前已经发布了,Moto 的 Xoom 平板 抢先尝到.

Android项目快速开发框架探索(Mysql + OrmLite + Hessian + Sqlite)

- - 博客园_首页
结合之前所用的ormlite和hessian,再加上SAE已经支持JAVA,把服务端切换到JAVA,也就有了本文. 使用hessian来做数据传输,ormlite来实现客户端与服务端的数据存储,极大的减少了CRUD工作. 本文为探索贴,未正式用于大型项目,欢迎大家讨论使用.   欢迎转载,但请保留文章原始出处:).

直接拿来用!最火的Android开源项目(完结篇)

- - ITeye博客
转至:http://www.csdn.net/article/2013-05-21/2815370-Android-open-source-projects-finale/1. 前,CSDN移动频道推出的GitHub平台上“最受欢迎的开源项目”系列文章引发了许多读者的热议,在“直接拿来用. 最火的Android开源项目”系列文章.

直接拿来用!最火的Android开源项目(二)

- - CSDN博客推荐文章
摘要:GitHub上的开源项目不胜枚举,通过这些项目,也能让开发者在应用开发过程中事半功倍,作为开发者的你,在用这些开源项目吗. 今天我们将介绍另外20个在GitHub上备受欢迎的Android开源项目,你准备好了吗. 最火的Android开源项目(一)》中,我们详细地介绍了GitHub上最受欢迎的TOP20 Android开源项目,引起了许多读者的热议,作为开发者,你最常用的是哪些开源项目.