ARouter 使用教程

ARouter 使用教程

ARouter💪 A framework for assisting in the renovation of Android componentization (帮助 Android App 进行组件化改造的路由框架)项目地址:https://gitcode.com/gh_mirrors/ar/ARouter

项目介绍

ARouter 是阿里巴巴开源的一个用于 Android 组件化改造的框架，支持模块之间的路由、通信、拦截等功能。它能够帮助开发者更高效地进行模块化开发，提高代码的可维护性和可扩展性。

项目快速启动

添加依赖

首先，在项目的 build.gradle 文件中添加 ARouter 的依赖：

dependencies {
    // ARouter API
    implementation 'com.alibaba:arouter-api:1.5.0'
    // ARouter 注解处理器
    annotationProcessor 'com.alibaba:arouter-compiler:1.2.2'
}

配置路由表自动加载

在项目的 build.gradle 文件中配置路由表自动加载插件：

apply plugin: 'com.alibaba.arouter'

buildscript {
    repositories {
        google()
        jcenter()
    }
    dependencies {
        classpath 'com.android.tools.build:gradle:3.0.1'
        // ARouter 注册插件
        classpath "com.alibaba:arouter-register:1.0.2"
    }
}

初始化 ARouter

在 Application 类中初始化 ARouter：

public class MyApplication extends Application {
    @Override
    public void onCreate() {
        super.onCreate();
        if (BuildConfig.DEBUG) {
            // 开启日志
            ARouter.openLog();
            // 开启调试模式
            ARouter.openDebug();
        }
        ARouter.init(this);
    }
}

应用内跳转

在需要跳转的 Activity 上添加 @Route 注解：

@Route(path = "/test/activity")
public class TestActivity extends AppCompatActivity {
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_test);
    }
}

使用 ARouter 进行跳转：

ARouter.getInstance().build("/test/activity").navigation();

应用案例和最佳实践

携带参数跳转

在跳转时携带参数：

ARouter.getInstance()
    .build("/test/1")
    .withLong("key1", 666L)
    .withString("key3", "888")
    .withObject("key4", new Test("Jack", "Rose"))
    .navigation();

通过 Uri 跳转

创建一个用于监控 Scheme 事件的 Activity，并直接传递 Uri 给 ARouter：

public class SchemeFilterActivity extends Activity {
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        Uri uri = getIntent().getData();
        ARouter.getInstance().build(uri).navigation();
        finish();
    }
}

在 AndroidManifest.xml 中配置 SchemeFilterActivity：

<activity android:name=".SchemeFilterActivity">
    <intent-filter>
        <data android:scheme="http" android:host="www.example.com" />
        <action android:name="android.intent.action.VIEW" />
        <category android:name="android.intent.category.DEFAULT" />
        <category android:name="android.intent.category.BROWSABLE" />
    </intent-filter>
</activity>

典型生态项目

ARouter 不仅支持基本的应用内跳转和参数传递，还支持服务调用、拦截器等功能。以下是一些典型的生态项目：

• ARouter-annotation: 包含 ARouter 的注解。
• ARouter-api: ARouter 的核心 API。
• ARouter-compiler: 注解处理器，用于生成路由表。
• ARouter-gradle-plugin: Gradle 插件，用于自动注册路由表。
• ARouter-idea-plugin: Android Studio 插件，提供快速导航功能。

通过这些生态项目，ARouter 提供了完整的组件化解决方案，帮助开发者更高效地进行 Android 应用开发。

ARouter💪 A framework for assisting in the renovation of Android componentization (帮助 Android App 进行组件化改造的路由框架)项目地址:https://gitcode.com/gh_mirrors/ar/ARouter