欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

android源代码情景分析(android开发环境的搭建步骤)

程序员文章站 2023-11-17 23:24:28
前言androidcomponent使用指南单独调试和发布组件交互ui跳转集成调试代码边界生命周期组件化拆分的感悟0前言今年6月份开始,我开始负责对“得到app”的android代码进行组件化拆分,在...
  • 前言
  • androidcomponent使用指南
    • 单独调试和发布
    • 组件交互
    • ui跳转
    • 集成调试
    • 代码边界
    • 生命周期
  • 组件化拆分的感悟

0

前言

今年6月份开始,我开始负责对“得到app”的android代码进行组件化拆分,在动手之前我查阅了很多组件化或者模块化的文章,虽然有一些收获,但是很少有文章能够给出一个整体且有效的方案,大部分文章都只停留在组件单独调试的层面上,涉及组件之间的交互就很少了,更不用说组件生命周期、集成调试和代码边界这些最棘手的问题了。有感于此,我觉得很有必要设计一套完整的组件化方案,经过几周的思考,反复的推倒重建,终于形成了一个完整的思路,整理在我的第一篇文章中android彻底组件化方案实践。这两个月以来,得到的android团队按照这个方案开始了组件化的拆分,经过两期的努力,目前已经拆分两个大的业务组件以及数个底层lib库,并对之前的方案进行了一些完善。从使用效果上来看,这套方案完全可以达到了我们之前对组件化的预期,并且架构简单,学习成本低,对于一个急需快速组件化拆分的项目是很适合的。现在将这套方案开源出来,欢迎大家共同完善。

虽说开源的是一个整体的方案,代码量其实很少,简单起见demo中做了一些简化,请大家在实际应用中注意一下几点:

(1)目前组件化的编译脚本是通过一个gradle plugin提供的,现在这个插件发布在本地的repo文件夹中,真正使用的使用请发布到自己公司的maven库

(2)组件开发完成后发布aar到公共仓库,在demo中这个仓库用componentrelease的文件夹代替,这里同样需要换成本地的maven库

(3)方案更侧重的是单独调试、集成编译、生命周期和代码边界等方面,我认为这几部分是已发表的组件化方案所缺乏的或者比较模糊的。组件之间的交互采用接口+实现的方式,ui之间的跳转用的是一个*路由的方式,在这两方面目前已有一些更完善的方案,例如通过注解来暴露服务以及自动生成ui跳转代码等,这也是该方案后面需要着力优化的地方。如果你已经有更好的方案,可以替换,更欢迎推荐给我。

1

androidcomponent使用指南

首先我们看一下demo的代码结构,然后根据这个结构图再次从单独调试(发布)、组件交互、ui跳转、集成调试、代码边界和生命周期等六个方面深入分析,之所以说“再次”,是因为上一篇文章我们已经讲了这六个方面的原理,这篇文章更侧重其具体实现。

android源代码情景分析(android开发环境的搭建步骤)

代码中的各个module基本和图中对应,从上到下依次是:

  • app是主项目,负责集成众多组件,控制组件的生命周期
  • reader和share是我们拆分的两个组件
  • componentservice中定义了所有的组件提供的服务
  • basicres定义了全局通用的theme和color等公共资源
  • basiclib中是公共的基础库,一些第三方的库(okhttp等)也统一交给basiclib来引入

图中没有体现的module有两个,一个是componentlib,这个是我们组件化的基础库,像router/uirouter等都定义在这里;另一个是build-gradle,这个是我们组件化编译的gradle插件,也是整个组件化方案的核心。

我们在demo中要实现的场景是:主项目app集成reader和share两个组件,其中reader提供一个读书的fragment给app调用(组件交互),share提供一个activity来给reader来调用(ui跳转)。主项目app可以动态的添加和卸载share组件(生命周期)。而集成调试和代码边界是通过build-gradle插件来实现的。

1 单独调试和发布

单独调试的配置与上篇文章基本一致,通过在组件工程下的gradle.properties文件中设置一个isrunalone的变量来区分不同的场景,唯一的不同点是在组件的build.gradle中不需要写下面的样板代码:

android源代码情景分析(android开发环境的搭建步骤)

而只需要引入一个插件com.dd.comgradle(源码就在build-gradle),在这个插件中会自动判断apply com.android.library还是com.android.application。实际上这个插件还能做更“智能”的事情,这个在集成调试章节中会详细阐述。

单独调试所必须的androidmanifest.xml、application、入口activity等类定义在src/main/runalone下面,这个比较简单就不赘述了。

如果组件开发并测试完成,需要发布一个release版本的aar文件到*仓库,只需要把isrunalone修改为false,然后运行assemblerelease命令就可以了。这里简单起见没有进行版本管理,大家如果需要自己加上就好了。值得注意的是,发布组件是唯一需要修改isrunalone=false的情况,即使后面将组件集成到app中,也不需要修改isrunalone的值,既保持isrunalone=true即可。所以实际上在androidstudio中,是可以看到三个application工程的,随便点击一个都是可以独立运行的,并且可以根据配置引入其他需要依赖的组件。这背后的工作都由com.dd.comgradle插件来默默完成。

android源代码情景分析(android开发环境的搭建步骤)

2 组件交互

在这里组件的交互专指组件之间的数据传输,在我们的方案中使用的是接口+实现的方式,组件之间完全面向接口编程。

在demo中我们让reader提供一个fragment给app使用来说明。首先reader组件在componentservice中定义自己的服务

android源代码情景分析(android开发环境的搭建步骤)

然后在自己的组件工程中,提供具体的实现类readbookserviceimpl:

android源代码情景分析(android开发环境的搭建步骤)

提供了具体的实现类之后,需要在组件加载的时候把实现类注册到router中,具体的代码在readerapplike中,readerapplike相当于组件的application类,这里定义了oncreate和onstop两个生命周期方法,对应组件的加载和卸载。

android源代码情景分析(android开发环境的搭建步骤)

在app中如何使用如reader组件提供的readerfragment呢?注意此处app是看不到组件的任何实现类的,它只能看到componentservice中定义的readbookservice,所以只能面向readbookservice来编程。具体的实例代码如下:

android源代码情景分析(android开发环境的搭建步骤)

这里需要注意的是由于组件是可以动态加载和卸载的,因此在使用readbookservice的需要进行判空处理。我们看到数据的传输是通过一个*路由router来实现的,这个router的实现其实很简单,其本质就是一个hashmap,具体代码大家参见源码。

通过上面几个步骤就可以轻松实现组件之间的交互,由于是面向接口,所以组件之间是完全解耦的。至于如何让组件之间在编译阶段不不可见,是通过上文所说的com.dd.comgradle实现的,这个在第一篇文章中已经讲到,后面会贴出具体的代码。

3 ui跳转

页面(activity)的跳转也是通过一个*路由uirouter来实现,不同的是这里增加了一个优先级的概念。(这块的代码参考了我之前在网易的技术老大的实现思路,在这里表示感谢,老大你永远是我的老大

android源代码情景分析(android开发环境的搭建步骤))。具体的实现就不在这里赘述了,代码还是很清晰的。

页面的跳转通过短链的方式,例如我们要跳转到share页面,只需要调用

android源代码情景分析(android开发环境的搭建步骤)

具体是哪个组件响应componentdemo://share这个短链呢?这就要看是哪个组件处理了这个schme和host,在demo中share组件在自己实现的shareuirouter中声明了自己处理这个短链,具体代码如下:

android源代码情景分析(android开发环境的搭建步骤)

在这里如果已经组件已经响应了这个短链,就返回true,这样更低优先级的组件就不会接收到这个短链。

目前根据schme和host跳转的逻辑是开发人员自己编写的,这块后面要修改成根据注解生成。这部分已经有一些优秀的开源项目可以参考,如arouter等。

4 集成调试

集成调试可以认为由app或者其他组件充当host的角色,引入其他相关的组件一起参与编译,从而测试整个交互流程。在demo中app和reader都可以充当host的角色。在这里我们以app为例。

首先我们需要在根项目的gradle.properties中增加一个变量mainmodulename,其值就是工程中的主项目,这里是app。设置为mainmodulename的module,其isrunalone永远是true。

然后在app项目的gradle.properties文件中增加两个变量:

android源代码情景分析(android开发环境的搭建步骤)

其中debugcomponent是运行debug的时候引入的组件,compilecomponent是release模式下引入的组件。我们可以看到debugcomponent引入的两个组件写法是不同的,这是因为组件引入支持两种语法,module或者modulepackage:module,前者直接引用module工程,后者使用componentrelease中已经发布的aar。

注意在集成调试中,要引入的reader和share组件是不需要把自己的isrunalone修改为false的。我们知道一个application工程是不能直接引用(compile)另一个application工程的,所以如果app和组件都是isrunalone=true的话在正常情况下是编译不过的。秘密就在于com.dd.comgradle会自动识别当前要调试的具体是哪个组件,然后把其他组件默默的修改为library工程,这个修改只在当次编译生效。

如何判断当前要运行的是app还是哪个组件呢?这个是通过task来判断的,判断的规则如下:

  • assemblerelease → app
  • app:assemblerelease或者 :app:assemblerelease → app

  • sharecomponent:assemblerelease 或:sharecomponent:assemblerelease→ sharecomponent

上面的内容要实现的目的就是每个组件可以直接在androidstudio中run,也可以使用命令进行打包,这期间不需要修改任何配置,却可以自动引入依赖的组件。这在开发中可以极大加快工作效率。

5 代码边界

至于依赖的组件是如何集成到host中的,其本质还是直接使用compile project(…)或者compile modulepackage:module@aar。那么为啥不直接在build.gradle中直接引入呢,而要经过com.dd.comgradle这个插件来进行诸多复杂的操作?原因在第一篇文章中也讲到了,那就是组件之间的完全隔离,也可以称之为代码边界。如果我们直接compile组件,那么组件的所有实现类就完全暴露出来了,使用方就可以直接引入实现类来编程,从而绕过了面向接口编程的约束。这样就完全失去了解耦的效果了,可谓前功尽弃。

那么如何解决这个问题呢?我们的解决方式还是从分析task入手,只有在assemble任务的时候才进行compile引入。这样在代码的开发期间,组件是完全不可见的,因此就杜绝了犯错误的机会。具体的代码如下:

android源代码情景分析(android开发环境的搭建步骤)

6 生命周期

在上一篇文章中我们就讲过,组件化和插件化的唯一区别是组件化不能动态的添加和修改组件,但是对于已经参与编译的组件是可以动态的加载和卸载的,甚至是降维的。

首先我们看组件的加载,使用章节5中的集成调试,可以在打包的时候把依赖的组件参与编译,此时你反编译apk的代码会看到各个组件的代码和资源都已经包含在包里面。但是由于每个组件的唯一入口applicationlike还没有执行oncreate方法,所以组件并没有把自己的服务注册到*路由,因此组件实际上是不可达的。

在什么时机加载组件以及如何加载组件?目前com.dd.comgradle提供了两种方式,字节码插入和反射调用。

  • 字节码插入模式是在dex生成之前,扫描所有的applicationlike类(其有一个共同的父类),然后通过javassisit在主项目的application.oncreate中插入调用applicationlike.oncreate的代码。这样就相当于每个组件在application启动的时候就加载起来了。
  • 反射调用的方式是手动在application.oncreate中或者在其他合适的时机手动通过反射的方式来调用applicationlike.oncreate。之所以提供这种方式原因有两个:对代码进行扫描和插入会增加编译的时间,特别在debug的时候会影响效率,并且这种模式对instant run支持不好;另一个原因是可以更灵活的控制加载或者卸载时机。

这两种模式的配置是通过配置com.dd.comgradle的extension来实现的,下面是字节码插入的模式下的配置格式,添加applicatonname的目的是加快定位application的速度。

android源代码情景分析(android开发环境的搭建步骤)

demo中也给出了通过反射来加载和卸载组件的实例,在app的首页有两个按钮,一个是加载分享组件,另一个是卸载分享组件,在运行时可以任意的点击按钮从而加载或卸载组件,具体效果大家可以运行demo查看。

android源代码情景分析(android开发环境的搭建步骤)

2

组件化拆分的感悟

在最近两个月的组件化拆分中,终于体会到了做到剥丝抽茧是多么艰难的事情。确定一个方案固然重要,更重要的是克服重重困难坚定的实施下去。在拆分中,组件化方案也不断的微调,到现在终于可以欣慰的说,这个方案是经历过考验的,第一它学习成本比较低,组内同事可以快速的入手,第二它效果明显,得到本来run一次需要8到10分钟时间(不过后面换了顶配mac,速度提升了很多),现在单个组件可以做到1分钟左右。最主要的是代码结构清晰了很多,这位后期的并行开发和插件化奠定了坚实的基础。

总之,如果你面前也是一个庞大的工程,建议你使用该方案,以最小的代价尽快开始实施组件化。如果你现在负责的是一个开发初期的项目,代码量还不大,那么也建议尽快进行组件化的规划,不要给未来的自己增加徒劳的工作量。