1.为什么要组件化?
国内都比较流行开发超级APP,也就是我全都要,什么功能都想加进去,这导致业务逻辑变得越来越复杂.
这时我们会开始面临两个问题:
- 首先,我们的
res文件夹下的资源将会迎来爆炸式地增长,并且我们都知道res文件夹不能分层,它只能按module进行划分,所以你的layout和mipmap等文件夹将最先被迫害,当这两个文件夹的资源变多时,你要查找一个layout或者一张图片都会变得十分费劲 - 其次,如果此时你的
APP还是只有一个module,还将会可能导致业务逻辑耦合无法复用,除非你的编程习惯十分良好,但是绝大多数人都做不到,所以我们需要用组件化来给自己一些约束,以此创造更高质量的应用程序.
2.使用ARouter对项目进行组件化改造
我特别喜欢ARouter简介中的一句话:解耦不是前提而是过程.接下来我将介绍如何使用ARouter对项目进行组件化改造
要组件化,首先你需要创建module来分割你的业务逻辑.要创建新的module可以在你的project名字上右键,然后New->Module
Android Library即可. 工程中有一个
host的
com.android.application壳
module,其他包含业务逻辑的
module以
com.android.library实现,
host依赖其他
module,这就可以实现组件化中的热插拔了.
这里列出我对自己项目里组件化改造后的目录结构的摘要
dng(project) //项目根
—— host(module) //壳模块
———— AppGlobal.java //自定义Application类
———— HostActivity.java //用来启动程序的Activity
—— common(module) //公共模块
———— PR.java //所有path的常量的集合
———— TTSService.java //从ai模块下沉的接口
———— Utils.java //通用工具类
—— ai(module) //业务逻辑模块
———— SpeakerFragment.java //业务逻辑
———— TTSServiceImpl.java //TTSService的具体实现类
—— navi(module) //业务逻辑模块
———— NaviFragment.java //业务逻辑
———— NaviViewModel.java //业务逻辑
复制代码解释一下:
先说common模块,这个模块需要包含项目中要使用的所有依赖和一些公用的工具类,之后每个模块都依赖common模块,这样就可以把common模块的依赖轻松地依赖导入到其他模块中去而不用在其他模块的build.gradle中重复地写一大堆脚本.
要想使用ARouter,先要在common模块的build.gradle中使用api(老版本是compile)引入ARrouter的运行时依赖(下面的版本可能不是最新的,获取最新版本请到Github获取最新版本的ARouter)
api 'com.alibaba:arouter-api:1.4.1'
复制代码类似R文件我们还可以在common模块中定义一个PR的java文件,来保存我们项目中所用到的所有路由的path
public final class PR
{
public static final class navi
{
public static final String navi = "/navi/navi";
public static final String location_service = "/navi/location";
}
public static final class ai
{
public final static String tts_service = "/ai/tts";
public final static String asr_service = "/ai/asr";
public final static String speaker = "/ai/speaker";
}
}
复制代码这可以帮助我们更好的对页面按模块进行分类,同时,其他模块导入common模块时,也会将PR导入进去,但又不需要依赖某个具体实现的模块,我们可以在页面跳转时直接引用这些常量,并且集中起来也好统一管理.
这里需要注意一点,在ARouter中是使用path来映射到页面的,每个path都必须至少有两级,并且每个页面的第一级不可以是其他模块已经使用过的.
host模块是,是一个空的APP壳模块,基本不实现任何业务逻辑,通过在build.gradle中,引用其他模块为自己添加功能.
implementation project(':common')
implementation project(':navi')
implementation project(':ai')
复制代码AppGlobal是我自定义的Application,我们需要在这里面给ARouter进行初始化.注意循序不要错,否则你可能会看不到一些log,而且在Debug模式下一定要openDebug,否则ARouter只会在第一次运行的时候扫描Dex加载路由表.
public final class AppGlobal extends MultiDexApplication
{
@Override
public void onCreate()
{
super.onCreate();
if (BuildConfig.DEBUG)
{
ARouter.openLog(); // Print log
ARouter.openDebug();
}
ARouter.init(this);
}
}
复制代码我的HostActivity中差不多就只有这些代码,可以看到我获取了ARouter的单例,然后使用build引用PR传入path,最后调用navigation获取其他模块的Fragment用来添加到当前Activity中.
Fragment fragment = (Fragment) ARouter.getInstance()
.build(PR.navi.navi)
.navigation();
getSupportFragmentManager()
.beginTransaction()
.add(R.id.fragment_container, fragment, PR.ux.desktop)
.setTransition(FragmentTransaction.TRANSIT_FRAGMENT_OPEN)
.commit();
复制代码然后是navi模块,因为这个模块使用了ARouter的注解,记得要先在build.gradle配置ARouter注解处理器的环境(host模块如果也使用了那么也要配置)
android {
//省略...
//ARouter注解处理器启动参数
javaCompileOptions {
annotationProcessorOptions {
arguments = [AROUTER_MODULE_NAME: project.getName()]
}
}
}
dependencies {
//省略..
//导入公共依赖
implementation project(':common')
//声明ARouter注解处理器
annotationProcessor 'com.alibaba:arouter-compiler:1.2.2'
}
复制代码我们在navi模块中使用@Route注解将PR.navi.navi映射到具体的Fragment或者Activity
这样:
@Route(path = PR.navi.navi)
public class NaviFragment extends Fragment
复制代码或者这样:
@Route(path = PR.navi.navi)
public class NaviActivity extends AppCompatActivity
复制代码ARouter这种使用path解耦的方式允许我们在开发的过程中更换PR.navi.navi映射到的Fragment或Activity,而在代码修改时把对调用方的影响降低到最小.
但值得注意的是,ARouter对不同类型的处理是不一样的,如果path指向的是Fragment,你需要获取navigation的返回值并手动把它添加到FragmentManager中.(如果不了解Fragment的同学可以看这篇文章 从Activity迁移到Fragment)
Fragment fragment = (Fragment) ARouter.getInstance()
.build(PR.navi.navi)
.navigation();
复制代码而Activity则不需要,它会立即显示
ARouter.getInstance()
.build(PR.navi.navi)
//还可以设置参数,ARouter会帮你存在Bundle中
.withString("pathId",UUID.randomUUID().toString())
//Activity 或 Context
.navigation(this);
复制代码navi模块是典型的业务逻辑模块,这里你可导入一些只有这个模块才会使用的专属第三方SDK,比如我在navi模块中使用了高德地图的SDK,其他模块只需要我这个模块的地图功能,但它不应该知道我到底使用的是高德还是百度还是腾讯地图,这就提高了封装性,在未来改变此模块的具体实现时,代价也会小得多.
3.自定义全局拦截器、全局降级策略、全局重定向
ARouter实现了module间的路由操作,同时也实现了拦截器的功能,拦截器是一种AOP(面向切面编程),比较经典的使用场景就是处理页面登录与否的问题.拦截器会在跳转之间执行，多个拦截器会按优先级顺序依次执行.通过实现IInterceptor接口并标注@Interceptor注解,这样一来,这个拦截器就被注册到ARouter当中了.
process方法会传入Postcard和InterceptorCallback,Postcard携带此次路由的关键信息,而InterceptorCallback则用于处理此次拦截,调用onContinue则放行,又或者调用onInterrupt抛出自定义异常.
拦截器会在ARouter初始化的时候进行异步(不在主线程)初始化,如果第一次路由发生时,还有拦截器没有初始化完毕,那么ARouter会等待该拦截器初始化完毕才进行路由.
@Interceptor(priority = 8)
public class TestInterceptor implements IInterceptor {
@Override
public void process(Postcard postcard, InterceptorCallback callback) {
callback.onContinue(postcard); // 处理完成，交还控制权
// callback.onInterrupt(new RuntimeException("我觉得有点异常"));
// 觉得有问题，中断路由流程
// 以上两种至少需要调用其中一种，否则不会继续路由
}
@Override
public void init(Context context) {
// 拦截器的初始化，会在ARouter初始化的时候调用该方法，仅会调用一次
}
}
复制代码当页面未找到时,我们可以定义一种降级策略来让程序继续运行,此时我们需要实现DegradeService接口,并用@Route(必须)标注,然后它会在全局范围内生效,你可以在onLost回调中自定义降级逻辑.
@Route(path = "/xxx/xxx")
public class DegradeServiceImpl implements DegradeService {
@Override
public void onLost(Context context, Postcard postcard) {
// do something.
}
@Override
public void init(Context context) {
}
}
复制代码有时候页面我们需要将path其重定向别的path,这时我们可以实现PathReplaceService接口,并用@Route(必须)标注,然后它会在全局范围内生效.所以若没有重定向需求记得返回原path
@Route(path = "/xxx/xxx")
public class PathReplaceServiceImpl implements PathReplaceService {
String forString(String path) {
return path; // 按照一定的规则处理之后返回处理后的结果
}
Uri forUri(Uri uri) {
return url; // 按照一定的规则处理之后返回处理后的结果
}
@Override
public void init(Context context) {
}
}
复制代码以上上三种接口中的init方法,只有拦截器的调用时间是特殊的,其他两种,都是在第一次使用时才会进行初始化.
4.接口下沉->暴露服务
有的时候我们可能需要的不是另外一个模块的页面,而是它提供的服务(MVC中的Model层),这时这时我们需要为自己想要的服务编写一个接口,并让他实现IProvider接口,然后把它放到common模块中, 但是接口的实现依然放在非common的具体的模块中,比如common模块的TTSService和ai模块的TTSServiceImpl.
这种做法被称为接口下沉,其实它并不是严格符合解耦思想的,但是它非常有用,就像你使用了ARouter,但没人规定你就不能用startActivity了一样,框架最终的目的还是为了方便我们编码的,而不是为了给我们添堵,更何况最终结果各模块依然是松散耦合的.
服务的初始化时机也是在第一次使用的时候.我们在common模块中声明TTSService接口:
public interface TTSService extends IProvider
{
void send(String text);
void stop();
}
复制代码并在ai模块中实现它并使用@Route注解标注
@Route(path = PR.ai.tts_service)
public class TTSServiceImpl implements TTSService
{
//省略...
}
复制代码这样我们就能在其他模块使用该服务了
TTSService ttsService = (TTSService) ARouter.getInstance()
.build(PR.ai.tts_service)
.navigation()
复制代码5.ContentProvider->模块内的Application
有些第三方SDK初始化是必须要在Application的onCreate中进行初始化的,但是如果我们编写独立于host的module时,要怎么初始化它们呢?
ARouter并没有提供官方的解决方案,但是经过我的实践,我们可以通过声明ContentProvider并在模块内AndroidManifest中注册它来实现初始化功能.
//java
public class ModuleLoader extends ContentProvider
{
@Override
public boolean onCreate()
{
Context context = getContext();
//TODO
return true;
}
//......
}
//AndroidManifest
"${applicationId}.navi-module-loader"
android:exported="false"
android:name=".app.ModuleLoader"/>
复制代码 ContentProvider#onCreate在Application#attachBaseContext调用之后Application#onCreate调用之前执行,并且可以通过getContext拿到Application的Context.这样就解决了部分第三方SDK初始化的问题.
6.ARouter是如何实现的?
简单概括起来其实也就是两个知识点:
- 使用
APT注解处理器通过注解生成RouteMeta元数据到指定包下 - 启动时扫描
Dex指定包下class,加载并缓存路由表,然后在navigation是对path映射到的不同类型尽可能地抽象出同一套接口
如果还想深入理解ARouter,可能就需要去读源码了.
7.ARouter的缺点
ARouter目前暂时不支持多进程开发,这是我觉得比较遗憾的,希望未来能够支持吧.
8.结语
ARouter的介绍就到此为止了,如果还想了解ARouter的依赖注入功能请移步Github.
如果喜欢我的文章记得给我点个赞,拜托了,这对我真的很重要.