源码解析：modules-graph-assert如何从Gradle配置中提取并构建模块依赖图

源码解析modules-graph-assert如何从Gradle配置中提取并构建模块依赖图【免费下载链接】modules-graph-assertGradle plugin to keep your modules graph healthy and lean.项目地址: https://gitcode.com/gh_mirrors/mo/modules-graph-assertmodules-graph-assert 是一款面向 Gradle 多模块项目的开源插件它能够自动从 Gradle 配置中提取各模块之间的依赖关系构建出一张模块依赖图并基于这张图完成树高断言、依赖白/黑名单检查帮助你把模块依赖治理得健康而精简。本文将带你从源码层面完整拆解它读取配置 → 提取依赖 → 构建图 → 消费图的完整链路即使你是刚接触 Gradle 插件开发的新手也能轻松读懂。 整体架构速览一条清晰的依赖图数据流在深入源码前先建立全局视角。整个构建流程可以概括为 4 步阶段核心文件职责① 入口注册plugin/src/main/kotlin/com/jraska/module/graph/assertion/ModuleGraphAssertionsPlugin.kt创建扩展、注册任务、延迟建图② 依赖提取plugin/src/main/kotlin/com/jraska/module/graph/assertion/GradleDependencyGraphFactory.kt从 Gradle 配置中捞出项目间依赖③ 构建依赖图plugin/src/main/kotlin/com/jraska/module/graph/DependencyGraph.kt邻接表建图、求根、算树高与最长路径④ 任务消费plugin/src/main/kotlin/com/jraska/module/graph/assertion/tasks/目录断言、导出 Graphviz、输出统计一、插件入口在 afterEvaluate 时机延迟构建依赖图Gradle 的api、implementation依赖往往要在所有构建脚本执行完即afterEvaluate阶段才能读取完整。这正是该插件的设计关键点。ModuleGraphAssertionsPlugin.kt 中依赖图是一个by lazy属性private val moduleGraph by lazy { GradleDependencyGraphFactory.create(evaluatedProject, configurationsToLook).serializableGraph() }这里有两个值得学习的设计点afterEvaluate时机插件在 apply 方法 中先注册moduleGraphAssert扩展规则配置类等到project.afterEvaluate后才收集配置并注册断言任务此时依赖信息已完整。序列化为SerializableGraph建图结果被立即转成可序列化形态随后注入到各个 Task 的Input属性中。这既满足了 Gradle 对任务输入可序列化、可校验的要求又避免在多个任务间共享非线程安全对象。任务注册方面插件会把assertModuleGraph聚合任务挂到check任务之下见 L50-L56所以执行./gradlew check时依赖图断言会自动运行。二、核心提取如何从 Gradle 配置中捞出模块依赖真正干活的是 GradleDependencyGraphFactory.kt。它的私有方法listAllDependenciesL32-L43是整个插件提取依赖的灵魂(rootProject.subprojects rootProject) .map { project - project.moduleDisplayName() to project.configurations .filter { configurationsToLook.contains(it.name) } .flatMap { configuration - configuration.dependencies.filterIsInstanceProjectDependency() .map { project.project(it.path) } } .map { it.moduleDisplayName() } }逐行拆解这段代码的 4 个关键动作遍历所有子模块rootProject.subprojects rootProject保证根项目自己也被纳入扫描范围。过滤目标配置默认只看api和implementation两种配置该默认值定义在 Api.kt 的API_IMPLEMENTATION_CONFIGURATIONS中用户可通过扩展修改如 Kotlin Multiplatform 场景。只保留项目间依赖filterIsInstanceProjectDependency()是精髓——它把 Maven 坐标等外部依赖全部过滤掉只留下模块之间的边。规范化模块名通过moduleDisplayName()定义在 ModuleGraphAssertionsPlugin.kt L162-L164把 Gradle 的显示名如project :app清洗为干净的路径如:app确保图上节点键名统一。提取完成后create 方法 还做了三层分支处理依赖为空→ 返回单节点图createSingular兼容只有一个模块的项目插件应用在根项目→ 直接返回全图插件应用在子模块→ 调用subTree(moduleDisplayName)只截取该模块依赖向下的子树这让你在app模块上应用插件时断言的正是 app 视角的依赖图。另外GradleModuleAliasExtractor.kt 会顺带收集各模块的moduleNameAssertAlias属性允许你用模块类型别名如App、Api而非模块路径来书写规则这对扁平化架构治理非常实用。三、建图DependencyGraph 用邻接表构建有向图DependencyGraph.kt 是一个纯 Kotlin 实现、不依赖任何图论库的轻量图模型核心结构只有两个节点Node(key)内部持有dependsOn: MutableSetNode邻接表建图create工厂方法L157-L165遍历(from, to)依赖对getOrCreate节点后addEdge重复模块名自动合并。在此之上提供了 4 个图分析能力正是断言任务所依赖的度量方法位置作用findRoot()L8-L18找出没有被任何节点依赖的节点并在候选根中取树高最大者Node.height()L120-L126树高叶子为 0否则1 子节点最大高度lazy记忆化避免重复计算longestPath()L134-L145递归沿最高子节点走得到最长依赖链Graphviz 导出时以红色高亮subTree()L61-L72DFS 截取子树DFS 过程中顺带做环检测发现循环依赖立即抛IllegalStateException并给出完整环路最后是 serializableGraph()把图拍扁为dependencyPairs全部边firstModule入口模块的可序列化结构。任务执行时再通过DependencyGraph.create(SerializableGraph)还原回完整图——提取一次处处复用。四、消费环节三类任务如何复用同一张依赖图图建好后由三个任务分工消费注册逻辑见 ModuleGraphAssertionsPlugin.kt L86-L1031️⃣ 断言任务assertMaxHeight / assertRestrictions / assertAllowed所有断言共用同一个任务骨架 AssertGraphTask.kt从SerializableGraph还原图然后执行注入的GraphAssert实现。三类规则全部在moduleGraphAssert {}扩展中配置GraphRulesExtension.kt树高断言maxHeight 4依赖链过深说明模块图退化成链表构建性能会受损黑名单restricted形如:feature-[a-z]* -X :forbidden-lib禁止特定模块依赖白名单allowed形如:feature.* - :lib.*只允许列出的依赖未匹配即失败。规则字符串由 RegexpDependencyMatcher.kt 解析Parse.kt负责按-/-X切分两侧正则。2️⃣ Graphviz 导出任务generateModulesGraphvizTextGenerateModulesGraphTask.kt 把图转成 Graphviz 文本最长路径会以红色标出。两个实用参数-Pmodules.graph.of.module:feature-one只导出指定子模块的子图-Pmodules.graph.output.gvall_modules将结果写入文件而非打印到控制台。3️⃣ 统计任务generateModulesGraphStatisticsGenerateModulesGraphStatisticsTask.kt 输出四个健康度指标模块数、边数、树高、最长路径。配合 GraphStatistics.kt 数据结构可以持续量化模块图是否在变胖。五、源码设计亮点小结 时机选择正确afterEvaluatelazy保证在配置完全求值后才建图规避了读不到依赖的经典坑只看ProjectDependency一行filterIsInstance精准分离内部模块依赖与外部库依赖序列化作为任务输入SerializableGraph作为Input注入任务兼顾 Gradle 增量构建模型与跨任务共享零依赖的图实现DependencyGraph不引入第三方图论库邻接表 懒计算 DFS 环检测代码量小却覆盖了根节点、树高、最长路径、子树截取全部所需能力测试覆盖到位提取逻辑有 GradleDependencyGraphFactoryTest.kt 等完整项目级集成测试验证单模块场景由 GradleDependencyGraphFactorySingleModuleProjectTest.kt 兜底。一句话总结modules-graph-assert 的精髓在于用约百行代码打通了Gradle 配置 → 依赖对列表 → 邻接表有向图 → 断言/导出/统计的完整链路。理解了这条链路你甚至可以照着 DependencyGraph.kt 为自己项目写一个最小可用的依赖图治理工具。【免费下载链接】modules-graph-assertGradle plugin to keep your modules graph healthy and lean.项目地址: https://gitcode.com/gh_mirrors/mo/modules-graph-assert创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考