ARouter 在多 module 项目中实战

r囧r小猫 2022-09-15 05:55 173阅读 0赞

code小生 一个专注大前端领域的技术平台公众号回复`Android`加入安卓技术群

> 本文已首发微信公众号「code小生」，大家可以搜索关注，专注安卓技术分享。

### 必要说明 ###

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

技术点：

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

环境：

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

#### 路由应用场景 ####

安卓的项目结构发展越来越倾向于多模块，而模块间的跳转如果使用原生方式（`Intent跳转`），那么会随着项目的发展壮大，最终导致错综复杂的`import xxx`，从而给维护带来很大的麻烦，如下图这样：

![804b824a6479ffec1f068cd4d6207b13.png][] 不使用路由的多模块

> `黑色线条：` 表示依赖关系，有了依赖，就可以在当前模块引用其他模块的类，就可以使用`Intent` 跳转。  
> `蓝色线条：` 表示从app模块要跳转login,live,work模块的某个页面，那么必须依赖对应模块才可以引用到相关类，从而实现跳转。  
> `红色线条：` 业务需要，从work模块可以直接进入直播间，那么work模块就必须依赖live模块；反之亦然。  
> `绿色线条：` 当用户没有登录，或者登录状态失效，亦或者账号在别处登录了，那么需要从当前模块跳转到login模块，所以其他基础模块都要依赖login模块。

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

而`ARouter`的出现，就很好的解决了这个问题，官网地址：`https://github.com/alibaba/ARouter/` ，其功能很强大，对于多模块的项目，无论是否组件化，都很好的解决了相互依赖和跳转带来的维护成本。如下简易图：

![554ac5077116987ac83e3d6f74e41463.png][] 使用路由的多模块

> `黑色线条：` 表示依赖关系，这里的依赖主要是解决资源共用问题，而不是跳转。如果用不到baselib中的资源，那么无需依赖。  
> `其他虚线条：` 表示无需相互依赖，就可以实现页面跳转和通信，这就是路由的强大之处。  
>

### 工程 Module 配置 ###

#### 新建工程 ####

我这里命名为`MyArouter`，然后分别 new Module：`baseLib`、`circle`、`home` 选择 Android Library 类型，编译完成如下图，则为正常状态；

![2c42d061705c14617d68b14bb2b27fee.png][]

#### 添加依赖关系 ####

win 系统通过快捷键 `Ctrl+Shift+Alt+S` 调出 `Project Structure` 面板，当然你也可以通过点击菜单栏的`File->Project Structure` 来打开这个面板。

![39aab4d27ffe9b26b70cd015468cac34.png][] 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`携带参数跳转赋值来展示使用示例。

![c64d1011e84399a1c522f3d04983e58b.gif][] 跳转传参

> 如果你的配置都没有错，还是无法跳转，那么卸载APP重新运行，就是Ok的，因为路由地址`path`有映射，缓存下来了，虽然后面改了，但走的还是缓存。

**传参说明**

ARouter提供了多种方式传递参数，也支持原生的参数值类型，如下图：

![103b24b64607a9cb6d54e47d78a0c213.png][] 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();

*补充*：可能有细心的朋友注意到，那带返回值方式的跳转如何写呢？

![21ec65f8229265086eff037323a9cea8.png][] 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`注解的说明：

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

除`with(Bundle bundle)`这种方式传参方式，其他方式要在接收参数的页面添加下面这行代码：

ARouter.getInstance().inject(this);

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

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

#### 模块间相互跳转 ####

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

![cce4628d28f007083ab28e3e69b80984.gif][]

这种方式传递参数，在接收的页面上既不用添加`@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`

![a9b3376da74417c1201494901c128dcc.png][]

[804b824a6479ffec1f068cd4d6207b13.png]: /images/20220828/a4fada3654b24c84b7a945eb79b88d7d.png
[554ac5077116987ac83e3d6f74e41463.png]: /images/20220828/21f358baefaa490fa153b027ff53665f.png
[2c42d061705c14617d68b14bb2b27fee.png]: /images/20220828/d36dc1b1bfe9459abc0633d1c998a0e2.png
[39aab4d27ffe9b26b70cd015468cac34.png]: /images/20220828/0b919f1de1ef4d308be28553922d068f.png
[c64d1011e84399a1c522f3d04983e58b.gif]: /images/20220828/d7e8493668a9483ba43b722c070bf4d3.png
[103b24b64607a9cb6d54e47d78a0c213.png]: /images/20220828/49ee15845bef4ce09aa3c19a5f7afa5c.png
[21ec65f8229265086eff037323a9cea8.png]: /images/20220828/4fc0977c28fe4b82a128714dd4f356d1.png
[cce4628d28f007083ab28e3e69b80984.gif]: /images/20220828/1620cf76aadc4780b8ecde504e8b1b6d.png
[a9b3376da74417c1201494901c128dcc.png]: /images/20220828/964138d55d5c4c5ea683fe9d94851068.png