ARouter 开源项目教程

ARouter 开源项目教程

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

1. 项目的目录结构及介绍

ARouter 项目的目录结构如下：

arouter-annotation/       # 注解相关
arouter-api/             # 核心API
arouter-compiler/        # 注解处理器
arouter-gradle-plugin/   # Gradle插件
arouter-idea-plugin/     # IDEA插件
demo/                    # 示例项目
gradle/                  # Gradle相关文件
module-java-export/      # Java模块导出
module-java/             # Java模块
module-kotlin/           # Kotlin模块
LICENSE                  # 许可证
README.md                # 英文README
README_CN.md             # 中文README
build.gradle             # 根目录下的build.gradle
gradle.properties        # Gradle属性文件
gradlew                  # Gradle wrapper脚本
gradlew.bat              # Gradle wrapper脚本（Windows）
settings.gradle          # 项目设置文件

目录结构介绍

• arouter-annotation/: 包含ARouter的注解定义。
• arouter-api/: 包含ARouter的核心API实现。
• arouter-compiler/: 包含注解处理器，用于在编译时生成路由表。
• arouter-gradle-plugin/: 包含ARouter的Gradle插件。
• arouter-idea-plugin/: 包含ARouter的IDEA插件，方便在IDE中进行路由跳转。
• demo/: 包含ARouter的示例项目，展示了如何使用ARouter进行组件化开发。
• module-java-export/, module-java/, module-kotlin/: 包含不同语言的模块示例。
• LICENSE: 项目的许可证文件。
• README.md, README_CN.md: 项目的介绍文档，分别提供英文和中文版本。
• build.gradle, gradle.properties, gradlew, gradlew.bat, settings.gradle: Gradle相关的配置文件和脚本。

2. 项目的启动文件介绍

ARouter 的启动文件主要涉及 Application 类的初始化。以下是初始化代码示例：

public class MyApplication extends Application {
    @Override
    public void onCreate() {
        super.onCreate();
        // 必须在初始化ARouter之前配置
        if (BuildConfig.DEBUG) {
            // 日志开启
            ARouter.openLog();
            // 调试模式开启
            ARouter.openDebug();
        }
        ARouter.init(this);
    }
}

启动文件介绍

• MyApplication: 自定义的 Application 类，用于初始化ARouter。
• onCreate(): 在应用启动时调用，初始化ARouter。
• ARouter.openLog(): 开启日志功能，方便调试。
• ARouter.openDebug(): 开启调试模式，确保在开发模式下正常运行。
• ARouter.init(this): 初始化ARouter，必须在应用启动时调用。

3. 项目的配置文件介绍

ARouter 的配置文件主要涉及 build.gradle 文件和 AndroidManifest.xml 文件。

build.gradle 文件配置

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

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

在模块的 build.gradle 文件中配置ARouter的注解处理器选项：

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

AndroidManifest.xml 文件配置

在 AndroidManifest.xml 文件中声明自定义的 Application 类：

<application
    android:name=".MyApplication"
    ... >
    ...
</application>

配置文件介绍

• build.gradle: 配置ARouter的依赖和注解

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