如何自动生成多模块 Android 项目的模块依赖关系图？

2024-03-16 05:04:30

为多模块 Android 项目自动化生成模块图

引言

在大型多模块 Android 项目中，理解模块间的依赖关系至关重要。手动生成模块图既耗时又容易出错。本文将介绍如何使用 Gradle 插件和自定义 Gradle 任务自动生成模块依赖关系图，从而提高项目可视化和可维护性。

手动生成模块图

可以使用 Module Graph Assert 插件手动生成每个模块的依赖关系图。具体命令为：

./gradlew generateModulesGraphvizText -Pmodules.graph.output.gv=my_module_dependency_graph.gv -Pmodules.graph.of.module=:my_module

其中，my_module 为要生成图的模块名称。

自动生成模块图

为避免手动操作的繁琐，我们可以创建一个自定义 Gradle 任务，使用插件自动生成所有模块的依赖关系图：

task generateModuleGraphs {
    doLast {
        // 获取所有模块名称
        def modules = project.gradle.includedBuild.rootProject.childProjects.collect { it.name }

        // 为每个模块生成依赖关系图
        modules.each { module ->
            exec {
                commandLine = [
                    "./gradlew",
                    "generateModulesGraphvizText",
                    "-Pmodules.graph.output.gv=my_module_dependency_graph_${module}.gv",
                    "-Pmodules.graph.of.module=:${module}"
                ]
            }
        }
    }
}

此任务将逐个模块执行 generateModulesGraphvizText 命令，生成依赖关系图。

集成到 CI

将任务集成到持续集成 (CI) 流程中，可在构建期间自动生成所有模块的依赖关系图：

task ci(dependsOn: ['generateModuleGraphs']) {}

这样，generateModuleGraphs 任务将在其他 CI 任务之前执行，确保依赖关系图的生成。

示例代码

以下代码示例展示了如何使用自定义 Gradle 任务自动生成模块图：

// build.gradle

task generateModuleGraphs {
    doLast {
        def modules = project.gradle.includedBuild.rootProject.childProjects.collect { it.name }

        modules.each { module ->
            exec {
                commandLine = [
                    "./gradlew",
                    "generateModulesGraphvizText",
                    "-Pmodules.graph.output.gv=my_module_dependency_graph_${module}.gv",
                    "-Pmodules.graph.of.module=:${module}"
                ]
            }
        }
    }
}

task ci(dependsOn: ['generateModuleGraphs']) {}