NowInAndroid项目模块依赖图路径问题解析

问题背景

在NowInAndroid项目的开发过程中，开发团队发现:app和:app-nia-catalog两个核心模块的依赖关系图无法正常显示。这个问题影响了开发者对项目模块间依赖关系的理解，特别是在进行模块化开发和架构调整时。

问题现象

当查看这两个模块的README文档时，依赖关系图的SVG图像无法加载。经过检查发现，这是由于文档中引用的图像路径与实际存储位置不匹配导致的。

技术分析

NowInAndroid项目使用了一个自动化脚本generateModuleGraphs.sh来生成各模块的依赖关系图。这个脚本会为每个模块生成一个依赖关系图，并将其保存到文档目录中。对于大多数模块，脚本生成的相对路径是正确的，但对于顶级应用模块(:app和:app-nia-catalog)，路径计算出现了偏差。

根本原因在于：

1. 项目文档图像统一存储在docs/images/graphs/目录下
2. 对于普通模块，从模块目录到文档目录的相对路径是正确的
3. 但对于顶级应用模块，它们位于项目根目录下，需要使用../来向上导航一级才能正确引用文档目录

解决方案

修复方案需要对generateModuleGraphs.sh脚本进行修改，特别处理顶级应用模块的路径生成逻辑。具体来说：

1. 识别当前处理的模块是否为:app或:app-nia-catalog
2. 如果是，则使用../docs/images/graphs/作为基础路径
3. 否则保持原有的路径计算逻辑

这种解决方案既保持了现有模块的路径不变，又修复了顶级模块的路径问题，同时不会影响其他模块的文档显示。

影响范围

这个问题主要影响：

• 项目文档的完整性
• 新加入开发者对项目架构的理解
• 模块间依赖关系的可视化展示

修复后，所有模块的依赖关系图都能正确显示，有助于开发者更好地理解项目的模块化架构。

最佳实践建议

对于类似的多模块项目，建议：

1. 统一文档资源的存储位置
2. 在自动化脚本中考虑不同层级模块的路径差异
3. 建立文档链接的验证机制
4. 在CI流程中加入文档链接检查

这样可以避免类似问题再次发生，确保项目文档始终保持准确和完整。