当前位置：首页 > article >正文

Android ARouter的详细使用指南

article 2025/3/19 18:37:43

Android ARouter的详细使用指南。我需要先确定用户的基础，可能他们已经有Android开发经验，但对ARouter不太熟悉。首先，我应该介绍ARouter是什么，解决什么问题，比如模块化中的页面跳转问题。然后，需要分步骤讲解，从集成到基本使用，再到高级功能。

用户可能需要的详细步骤包括如何添加依赖，记得要提到Kotlin和Java的不同配置，还有annotationProcessor。然后，初始化部分，如何在Application中初始化，以及可能遇到的坑，比如混淆配置。

接下来是基本使用，如何用@Route注解标注Activity，如何跳转，可能需要代码示例。这里要区分Kotlin和Java的写法吗？或者统一用Java？可能用户两种都有，所以最好都提到。还有参数传递，用withString之类的，以及如何自动注入。

高级功能部分，拦截器是重点，用户可能想实现登录检查或者权限控制。需要给出拦截器的例子，说明执行顺序和注意事项。还有跨模块调用服务，服务注册和发现的流程，这里可能需要用IProvider接口的例子。

另外，用户可能会遇到问题，比如Proguard配置，或者页面未找到的情况，常见问题解答部分应该涵盖这些。比如检查注解是否正确，路由路径是否正确，初始化是否完成。

需要注意，用户可能是在进行模块化开发，所以需要强调ARouter在解耦方面的优势，比如不同模块间不需要直接依赖。同时，要提醒用户路径的管理，最好统一管理路由路径，避免硬编码。

最后，总结一下ARouter的好处，以及适用的场景。可能还需要给出官方文档的链接，方便用户进一步查阅。确保整个指南结构清晰，步骤明确，代码示例正确，并且覆盖常见问题。

以下是一份详细的 Android ARouter 使用指南，涵盖基本配置、核心功能及高级用法，帮助你在项目中高效实现组件化通信。

一、ARouter 简介

ARouter 是阿里开源的路由框架，用于解决模块间跳转、服务调用等解耦问题，适用于组件化开发场景。其核心能力包括：

页面跳转：支持跨模块、跨进程的 Activity/Fragment 跳转。
参数传递：自动注入参数，支持序列化对象。
拦截器：全局控制跳转逻辑（如登录检查）。
服务发现：跨模块调用服务，实现接口与实现分离。

二、快速集成

1. 添加依赖

在 build.gradle 中添加：

android {
    defaultConfig {
        // 确保使用 Java 8
        compileOptions {
            sourceCompatibility JavaVersion.VERSION_1_8
            targetCompatibility JavaVersion.VERSION_1_8
        }
    }
}

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

    // 如果是 Kotlin 项目，使用 kapt
    kapt 'com.alibaba:arouter-compiler:1.5.2'
}

2. 初始化 ARouter

在 Application 中初始化：

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

3. 配置 Proguard（可选）

添加混淆规则：

-keep public class com.alibaba.android.arouter.routes.**{*;}
-keep public class com.alibaba.android.arouter.facade.**{*;}
-keep class * implements com.alibaba.android.arouter.facade.template.ISyringe{*;}

三、基础使用

1. 页面跳转

1.1 注册路由

为目标页面添加 @Route 注解：

@Route(path = "/app/main")
public class MainActivity extends AppCompatActivity {
    // ...
}

1.2 发起跳转

通过路径进行跳转：

// 普通跳转
ARouter.getInstance().build("/app/main").navigation();

// 带参数跳转
ARouter.getInstance()
    .build("/app/detail")
    .withString("title", "详情页")
    .withInt("id", 1001)
    .navigation();

1.3 参数自动注入

在目标页面中自动注入参数：

@Route(path = "/app/detail")
public class DetailActivity extends AppCompatActivity {
    @Autowired  // 自动注入字段
    String title;

    @Autowired(name = "id") // 指定参数名
    int productId;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        ARouter.getInstance().inject(this); // 必须调用注入方法
        // 直接使用 title 和 productId
    }
}

2. 获取 Fragment

@Route(path = "/app/home_fragment")
public class HomeFragment extends Fragment {
    // ...
}

// 获取实例
Fragment fragment = (Fragment) ARouter.getInstance().build("/app/home_fragment").navigation();

3. 跳转结果回调

ARouter.getInstance()
    .build("/app/login")
    .navigation(this, new NavigationCallback() {
        @Override
        public void onFound(Postcard postcard) {
            // 路由找到
        }

        @Override
        public void onLost(Postcard postcard) {
            // 路由未找到
        }

        @Override
        public void onArrival(Postcard postcard) {
            // 跳转完成
        }

        @Override
        public void onInterrupt(Postcard postcard) {
            // 被拦截器中断
        }
    });

四、高级功能

1. 拦截器（Interceptor）

实现全局拦截逻辑（如登录检查）：

@Interceptor(priority = 8, name = "登录拦截器")
public class LoginInterceptor implements IInterceptor {
    @Override
    public void process(Postcard postcard, InterceptorCallback callback) {
        if (postcard.getPath().equals("/app/profile")) {
            if (!isLogin()) {
                // 跳转到登录页
                ARouter.getInstance().build("/app/login").navigation();
                callback.onInterrupt(null); // 中断当前路由
                return;
            }
        }
        callback.onContinue(postcard); // 继续执行
    }

    @Override
    public void init(Context context) {
        // 拦截器初始化
    }
}

2. 跨模块服务调用

2.1 定义服务接口

public interface IUserService extends IProvider {
    String getUserName();
    boolean isLogin();
}

2.2 实现服务

@Route(path = "/service/user")
public class UserServiceImpl implements IUserService {
    @Override
    public String getUserName() {
        return "Alice";
    }

    @Override
    public boolean isLogin() {
        return true;
    }

    @Override
    public void init(Context context) {
        // 初始化
    }
}

2.3 调用服务

IUserService userService = ARouter.getInstance().navigation(IUserService.class);
if (userService != null && userService.isLogin()) {
    String name = userService.getUserName();
}

3. 路由分组与降级策略

3.1 分组管理

通过 group 参数分组管理路由：

@Route(path = "/group1/activity1", group = "group1")
public class Group1Activity extends AppCompatActivity { ... }

3.2 降级策略

处理未找到的路由：

public class DegradeServiceImpl implements DegradeService {
    @Override
    public void onLost(Context context, Postcard postcard) {
        // 跳转到统一错误页
        context.startActivity(new Intent(context, ErrorActivity.class));
    }

    @Override
    public void init(Context context) { ... }
}