模块依赖图插件使用指南

模块依赖图插件使用指南

项目介绍

module-dependency-graph 是一个 Gradle 插件，旨在帮助开发者可视化项目中各个模块之间的依赖关系。通过生成模块依赖图，开发者可以更直观地理解和管理项目结构，尤其是在处理大型多模块项目时。

项目快速启动

安装插件

首先，在项目的根 build.gradle 文件中应用插件：

plugins {
    id 'com.savvasdalkitsis.module-dependency-graph' version '<latest_version>'
}

生成依赖图

在命令行中运行以下命令以生成模块依赖图：

./gradlew graphModules

这将创建一个 PNG 格式的依赖图，并使用系统默认的应用程序打开该图像。

应用案例和最佳实践

过滤特定模块

在处理复杂的依赖树时，可以指定要包含的模块，以简化图表：

./gradlew graphModules -PgraphFilter=core,presentation,api,network

指定输出格式

除了默认的 PNG 格式，还可以生成 SVG 格式的图表：

./gradlew graphModules -PgraphOutputFormat=svg

禁用自动打开图表

如果不需要自动打开生成的图表，可以禁用此功能：

./gradlew graphModules -PautoOpenGraph=false

典型生态项目

IntelliJ IDEA

IntelliJ IDEA 提供了强大的模块依赖图管理功能，可以与 module-dependency-graph 插件结合使用，进一步提升开发效率。在 IntelliJ IDEA 中，可以通过以下步骤查看和管理模块依赖图：

1. 打开项目视图（View | Tool Windows | Project）。
2. 选择一个模块，右键点击并选择“Show Diagram”。
3. 使用快捷键（如 Alt+鼠标滚轮）缩放图表，F4 跳转到源代码，Ctrl+F 快速定位模块等。

通过这些功能，开发者可以更高效地管理和优化项目结构。