Skip to content

Home

Jump to bottom
张涛(tao281.zhang) edited this page Sep 5, 2022 · 4 revisions

Android 模块化路由框架：TheRouter

hll

功能介绍

TheRouter 核心功能具备四大能力：

  • 页面导航跳转能力（Navigator） 页面跳转能力介绍
  • 跨模块依赖注入能力（ServiceProvider）跨模块依赖注入
  • 单模块自动初始化能力 （FlowTaskExecutor）单模块自动初始化能力介绍
  • 动态化能力 (ActionManager) 动态化能力支持

一、快速上手

1.1 Gradle 引入

最新版本号，请访问：(地址待补充)

// 项目根目录 build.gradle 引入
classpath 'cn.therouter:plugin:1.1.0'

// app module 中引入
apply plugin: 'therouter'

// 依赖
kapt "cn.therouter:apt:1.1.0"
implementation "cn.therouter:router:1.1.0"

1.2 初始化

框架内部包含自动初始化功能，详见单模块自动初始化能力
无需任何初始化代码。但推荐你根据业务设置否为Debug环境，用以查看日志信息。
Application.attachBaseContext() 方法中尽可能早设置当前是否为Debug环境。

@Override
protected void attachBaseContext(Context base) {
    TheRouter.setDebug(true or false);
    super.attachBaseContext(base);
}

1.3 页面参数注入

在Activity 或 Fragment 的 onCreate()方法中调用，建议直接在BaseActivity(BaseFragment)中做

@Override
protected void onCreate(@Nullable Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
    TheRouter.inject(this);
}

1.4 页面跳转

关于注解@Route的参数含义，请查看文档：页面导航跳转能力

@Route(path = "http://therouter.com/home", action = "action://scheme.com",
        description = "第二个页面", params = {"hello", "world"})
public class HomeActivity extends BaseActivity {
    @Override
    protected void onCreate(@Nullable Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        TheRouter.build("要跳转的目标页Path")
            .withInt("intValue", 12345678) // 传 int 值
            .withString("str_123_Value", "传中文字符串")
            .withBoolean("boolValue", true) 
            .withLong("longValue", 123456789012345L)
            .withChar("charValue", 'c') 
            .withDouble("double", 3.14159265358972)
            .withFloat("floatValue", 3.14159265358972F)
            .navigation();
    }
}

二、编译器配置

可在local.properties配置编译期属性（warning输出日志，error直接报错）

  • 增量编译开关
    开启增量编译能大幅加快编译速度，但在删除旧代码时，可能需要clean后重新编译，否则会报错。
    THEROUTER_OPEN_INCREMENTAL=true （true/false可选，默认是false）
  • 路由表未知Activity检测
    路由表中如果声明了一个不存在的Activity，通常是因为旧代码删除时忘记清理路由表了，这里可选报错或警告，提供参考。
    CHECK_ROUTE_MAP=warning （warning/error可选，不加则不会执行检测）
  • 初始化任务未知依赖检查
    @FlowTask的dependsOn参数声明了一个不存在的任务，通常情况下是由于任务名书写错误，建议设置为error，尽早在编译期发现问题。 CHECK_FLOW_UNKNOW_DEPEND=warning （warning/error可选，不加则不会执行检测）

三、混淆配置

-keep class androidx.annotation.Keep
-keep @androidx.annotation.Keep class * {*;}
-keepclassmembers class * {
    @androidx.annotation.Keep *;
}
-keepclasseswithmembers class * {
    @androidx.annotation.Keep <methods>;
}
-keepclasseswithmembers class * {
    @androidx.annotation.Keep <fields>;
}
-keepclasseswithmembers class * {
    @androidx.annotation.Keep <init>(...);
}
-keepclasseswithmembers class * {
    @com.therouter.router.Autowired <fields>;
}

四、从其他路由迁移至 TheRouter

4.1 迁移工具一键迁移

可使用迁移工具一键迁移：

如果项目中使用了ARouter的IProvider.init()方法，可能需要手动处理初始化逻辑。

如下图：

五、源码运行与调试

5.1 工程模块描述

TheRouter
  ├─app
  │   └──代码使用示例Demo
  ├─business-a
  │   └──用于模块化业务模块的演示模块
  ├─business-b
  │   └──用于模块化业务模块的演示模块
  ├─business-base
  │   └──用于模块化基础模块的演示模块
  ├─apt
  │   └──注解处理器相关代码
  ├─plugin
  │   └──编译期 Gradle 插件源码
  └─router
      └──路由库核心代码

5.2 项目运行

  1. 打开local.properties，声明你想要调试的模块 例如希望源码调试apt模块，则声明apt=true即可
  2. 同步 Gradle 变更

5.3 plugin 源码调试

plugin调试比较特殊，需要修改module名。

  1. 修改plugin文件夹名为buildSrc（注意大小写）
  2. 注释根目录build.gradle中的classpath引用（不需要了）
  3. 同步 Gradle 变更
Clone this wiki locally