Android多包路由方案： ARouter 路由库

news2025/2/12 22:41:27

1. ARouter 简介

目标：ARouter 专门为 Android 组件化开发设计，解决跨模块路由和依赖问题。
功能：
- 支持使用注解的方式注册路由（如 Activity、Fragment 或 Service）。
- 提供统一的路由接口，用于跨包跳转和数据传递。
- 支持拦截器和降级机制，方便统一处理异常情况。

2. 为什么使用多包路由方案

在组件化项目中，不同模块（包）间的业务代码相对独立，但页面之间需要跳转，这时就需要一个统一的路由中间件来协调各模块间的依赖。使用 ARouter 的好处包括：

降低耦合：各模块不需要直接引用其他模块中的 Activity/Fragment，通过路由路径进行解耦。
灵活扩展：模块可以独立开发和测试，在主工程中统一集成路由。
便于维护：通过注解生成代码，统一管理路由信息，便于修改和维护。

3. 实现步骤

(1) 添加依赖

在项目根目录的 build.gradle 中添加 ARouter 相关依赖：

buildscript {
    dependencies {
        // ARouter 编译期依赖，用于代码生成
        classpath 'com.alibaba:arouter-register:1.2.2'
    }
}

在各模块的 build.gradle 中添：

dependencies {
    // ARouter 核心库
    implementation 'com.alibaba:arouter-api:1.5.2'
    kapt 'com.alibaba:arouter-compiler:1.2.2'
}

(2) 初始化 ARouter

在 Application 类中初始化 ARouter（建议在主 App 模块中做初始化）：

@HiltAndroidApp  // 如果你使用 Hilt，也可配合初始化
public class MyApp extends Application {
    @Override
    public void onCreate() {
        super.onCreate();
        if (BuildConfig.DEBUG) {
            // 打开日志和调试模式
            ARouter.openLog();
            ARouter.openDebug();
        }
        ARouter.init(this);
    }
}

(3) 为各个页面注册路由

在需要跳转的 Activity 中，使用 @Route 注解注册路由地址：

@Route(path = "/home/MainActivity")
public class MainActivity extends AppCompatActivity {
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        // 其他初始化代码
    }
}

(4) 跨模块调用

在其他模块或同一模块中，通过 ARouter 进行页面跳转：

ARouter.getInstance()
    .build("/test/activity")
    .withString("name", "张三")
    .withInt("age", 18)
    .withParcelable("user", userObject) // 如果你传递的是 Parcelable 对象
    .navigation();

(5) 参数接收

在目标 Activity 中定义成员变量，并使用 @Autowired 注解标注参数键来接收。例如：

@Route(path = "/test/activity")
public class TestActivity extends AppCompatActivity {

    // 使用 @Autowired 注解标注需要接收的参数
    @Autowired(name = "name")
    public String name;

    @Autowired(name = "age")
    public int age;

    @Autowired(name = "user")
    public User user; // 假设 User 实现了 Parcelable 接口

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_test);

        // 注入参数
        ARouter.getInstance().inject(this);

        // 现在你可以使用这些参数
        Log.d("TestActivity", "name: " + name + ", age: " + age);
    }
}

这样，即使 MainActivity 位于另一个包或模块中，也能通过路由地址访问到它。