乐趣区

关于android:ARouter-在多-module-项目中实战

jiezi

本文已首发微信公众号「code 小生」，大家能够搜寻关注，专一安卓技术分享。

必要阐明

本文仅作案例演示，不便学习和把握基础知识，不进行源码级别的探索。上面先明确一下能实现的性能和用到的技术点以及环境。

技术点：

  • 多 module 工程，有 baseLib 和主 APP 以及多业务 module
  • 多 module，实现某个 module 可独立运行
  • 多 module 之间跳转，应用 ARouter 框架
  • ARouter 拦截器应用

环境：

  • Android Studio4.1.2
  • 语言：Java
  • 手机：三星 A6s Android10

路由利用场景

安卓的我的项目构造倒退越来越偏向于多模块，而模块间的跳转如果应用原生形式（Intent 跳转），那么会随着我的项目的发展壮大，最终导致盘根错节的import xxx，从而给保护带来很大的麻烦，如下图这样：

彩色线条： 示意依赖关系，有了依赖，就能够在以后模块援用其余模块的类，就能够应用 Intent 跳转。<br/>
蓝色线条： 示意从 app 模块要跳转 login,live,work 模块的某个页面，那么必须依赖对应模块才能够援用到相干类，从而实现跳转。<br/>
红色线条： 业务须要，从 work 模块能够间接进入直播间，那么 work 模块就必须依赖 live 模块；反之亦然。<br/>
绿色线条： 当用户没有登录，或者登录状态生效，亦或者账号在别处登录了，那么须要从以后模块跳转到 login 模块，所以其余根底模块都要依赖 login 模块。

这样随着我的项目性能的拓展，带来的问题就很显著了。

而 ARouter 的呈现，就很好的解决了这个问题，官网地址：https://github.com/alibaba/ARouter/，其性能很弱小，对于多模块的我的项目，无论是否组件化，都很好的解决了相互依赖和跳转带来的保护老本。如下繁难图：

彩色线条： 示意依赖关系，这里的依赖次要是解决资源共用问题，而不是跳转。如果用不到 baselib 中的资源，那么无需依赖。<br/>
其余虚线条： 示意无需相互依赖，就能够实现页面跳转和通信，这就是路由的弱小之处。<br/>

工程 Module 配置

新建工程

我这里命名为MyArouter，而后别离 new Module：baseLib、circle、home 抉择 Android Library 类型，编译实现如下图，则为失常状态；

增加依赖关系

win 零碎通过快捷键 Ctrl+Shift+Alt+S 调出 Project Structure 面板，当然你也能够通过点击菜单栏的File->Project Structure 来关上这个面板。

如图抉择不同的模块，增加依赖模块即可，我这里的依赖是这样的：

  • app 模块依赖：baseLib、circle、home
  • baseLib 模块：不依赖任何功能模块
  • circle 模块依赖：baseLib
  • home 模块依赖：baseLib

模块阐明

  • baseLib：我的项目的公共根底模块，个别能够包含共用的工具类、公共资源、公共代码片段、共用三方援用等等能够放在这里，这样做能够防止很多的反复代码、进步代码的可浏览性和程序的易保护。
  • app：是整个我的项目的宿主模块，也就是说该模块的优先级是高于其余功能模块的，因为程序的主入口是这里。
  • 其余模块，都是依照业务性能来划分，负责具体的业务。

工程 ARouter 配置

第一步：baseLib模块配置

关上 baseLib 下的 build.gradle 文件，在 dependencies 下增加如下代码

api 'com.alibaba:arouter-api:1.5.2'

接着在 baseLib 下新建 BaseApplication 类，残缺代码如下：

public class BaseApplication extends Application {

    @Override
    public void onCreate() {super.onCreate();

        initRouter(this);
    }

    public static void initRouter(Application application) {if (BuildConfig.DEBUG) {ARouter.openLog();
            ARouter.openDebug();}
        ARouter.init(application);
    }

}

而后新建类ARouterPath，该类的性能是提供对立的路由跳转页面门路，也就是 ARouter 中的 path 值；

public class ARouterPath {public static final String CIRCLE_CIRCLE="/circle/home";}

第二步：其余模块配置

顺次在 app、circle、home 模块，关上对应的 build.gradle 文件

  • 在 dependencies 下增加如下代码

    annotationProcessor 'com.alibaba:arouter-compiler:1.5.2'

  • 在 defaultConfig 下增加如下代码

    javaCompileOptions {
  annotationProcessorOptions {arguments = [AROUTER_MODULE_NAME: project.getName()]
  }
}

到这里，其实路由的援用配置曾经实现，但咱们还没有增加 Application，也很简略了，在 app 模块下，新建 AppApplication 继承自BaseApplication，并将其增加到该模块下的清单文件中。

public class AppApplication extends BaseApplication {}

这里不做实现是因为演示 demo，用不到第三方的货色，理论开发中依据需要进行初始化即可。之所以继承，是因为后面咱们曾经初始化了路由配置。

测试 ARouter 跳转

配置工作咱们曾经做完了，本文的次要目标就是测试页面跳转，当然跳转就会蕴含是否携带参数、跳转是否须要有返回值、以及没有依赖关系的模块间是否可跳转，上面进行分组测试：

tips：为了防止写findViewById()，我这里应用了ViewBinding，用法很简略，一看就懂，这里不做具体阐明。

模块内应用路由跳转

模块内的话，齐全能够应用 intent 形式跳转，但本文的主题是探索路由的跳转用法，我这里以 app 模块内跳转为例，新建了一个名为 MyInfoActivity 的页面，显示默认值，通过在 MainActivity 携带参数跳转赋值来展现应用示例。

如果你的配置都没有错，还是无奈跳转，那么卸载 APP 从新运行，就是 Ok 的，因为路由地址 path 有映射，缓存下来了，尽管前面改了，但走的还是缓存。

传参阐明

ARouter 提供了多种形式传递参数，也反对原生的参数值类型，如下图：

这里不演示全副办法的应用，只有会了上面几个罕用的，其余都相似。

  • with(Bundle bundle)：如果要传递多个参数，举荐应用该办法。
  • withBundle(String key, Bundle bundle)：仍然是传递一个 Bundle，但能够自定义 key .
  • with 封装数据类型(String key, 根本数据类型值)：如果只传递一个参数，且是根本数据类型，那么这些办法十分实用。

其余常应用的像传递序列化对象、汇合等，大家自行尝试。上面说下如何取参数。如下代码是咱们的 MyInfoActivity 的传参：

ARouter.getInstance().build(ARouterPath.APP_MY_INFO)
          .withInt(KEY_TYPE, 100)
          .withString(KEY_NAME, "codexiaosheng")
          .withString(KEY_WEIXIN, "xiaoshengcode")
          .navigation();

补充：可能有仔细的敌人留神到，那带返回值形式的跳转如何写呢？

  • 第三个办法就等同于咱们原生写法startActivityForResult()
  • 第四个办法还提供了监听，前面要分享的拦挡性能就会应用到。

取参阐明

对应下面三个传参办法：

  • with(Bundle bundle)：取参数通过 getIntent().getExtras() 取得 Bundle，而后就和咱们原生用法雷同。
  • withBundle(String key, Bundle bundle) 和 with 封装数据类型 (String key, 根本数据类型值)：取参数形式雷同，能够先看一下下面给出的MyInfoActivity 的代码：
@Route(path = ARouterPath.APP_MY_INFO)
public class MyInfoActivity extends AppCompatActivity {

    private ActivityMyInfoBinding myInfoBinding;

    @Autowired
    public int u_type;
    @Autowired(name = MainActivity.KEY_NAME)
    public String uName;
    @Autowired(name = MainActivity.KEY_WEIXIN)
    public String uWeixin;

    @Override
    protected void onCreate(Bundle savedInstanceState) {super.onCreate(savedInstanceState);
        myInfoBinding = ActivityMyInfoBinding.inflate(getLayoutInflater());
        setContentView(myInfoBinding.getRoot());

        ARouter.getInstance().inject(this);

        myInfoBinding.tvName.setText("name:" + uName + "用户类型：" + u_type);
        myInfoBinding.tvWeixin.setText("weixin:" + uWeixin);
    }

}

能够看到这里和咱们平时取参数有几点不同：

  1. 应用了 @Autowired 注解
  2. 多了 ARouter.getInstance().inject(this); 这行代码
  3. 接管参数的字段都是 public 修饰符
  4. 并没有显式的 getXXX 取值代码

对 @Autowired 注解的阐明：<br/>

  • 所注解的变量必须是 public 的
  • 如果变量的名字和传参的 key 不雷同，那么须要手动给注解增加 name 值，即传参的 key.

除 with(Bundle bundle) 这种形式传参形式，其余形式要在接管参数的页面增加上面这行代码：

ARouter.getInstance().inject(this);

如果应用的 with(Bundle bundle) 传参形式，那么取参数通过 getIntent().getExtras() 取得 Bundle，操作即可。

综合看起来，还是比较简单的，少了很多判断代码。

模块间互相跳转

这里我应用 with(Bundle bundle) 形式传递参数做演示。先来看一个总体的成果：

这种形式传递参数，在接管的页面上既不必增加 @Autowired 注解，也不必增加 ARouter.getInstance().inject(this); 这行代码，应用咱们原来的形式 getIntent().getExtras() 即可。

下面的演示成果中波及 app 模块跳转 home 和circle模块、home模块和 circle 模块互相跳转，还记得后面的依赖关系吗？home和 circle 间接是没有依赖关系的，但能够通过路由间接跳转，如果咱们我的项目的 module 比拟多，这就会很不便，升高代码耦合性。

看一下跳转 home 模块的代码：

// 跳转 home 模块页面
mainBinding.jumpHomePage.setOnClickListener(v -> {if (mainBinding.cbHome.isChecked()) {Bundle bundle = new Bundle();
        bundle.putInt(KEY_TYPE, 500);
        bundle.putString(KEY_NAME, "home module");
        bundle.putString(KEY_WEIXIN, "is home module~");

        ARouter.getInstance().build(ARouterPath.HOME_HOME).with(bundle).navigation();} else {ARouter.getInstance().build(ARouterPath.HOME_HOME).navigation();}
});

外围代码都贴出来了，到这根本的演示性能就实现了，本文是以 java 来演示的，kotlin配置参考官网。

对于路由的高级应用，比方：拦挡以及模块可独自运行，下一篇博客会揭晓。

跳转原理

ARouter 通过注解主动注册并且在编译期间生成映射关系，在运行的时候就能够加载文件，通过 path 就能够顺利跳转到指标页面。

本文总结

  1. 看不到对应的 R.layout.xxx_layout 文件名了, 能够通过点击 XXXBinding.getRoot() 跳转至对应 xml
  2. 如果我的项目各模块间跳转比拟多，倡议对立应用路由跳转
  3. ARouter 还能够跳转fragment，具体应用查看官网 demo
  4. 常见的跳转动画设置，ARouter 跳转也是能够的，传入动画资源文件 id 即可

本文全副代码获取：关注微信公众号 code 小生 回复arouter

退出移动版