Detekt项目中的模块依赖优化：分离detekt-api与detekt-psi-utils

在静态代码分析工具Detekt的开发过程中，项目团队发现了一个值得优化的模块依赖关系问题。核心模块detekt-api对detekt-psi-utils存在不必要的依赖，这种设计不仅增加了模块间的耦合度，也影响了项目的整体架构清晰度。

问题背景

Detekt作为一款强大的Kotlin静态代码分析工具，其内部采用模块化设计。其中，detekt-api模块作为核心API层，理论上应该保持最小依赖原则，只包含最基本的接口和抽象定义。然而在实际实现中，该模块却依赖了detekt-psi-utils这个实用工具模块，这种依赖关系在架构设计上显得不够合理。

技术分析

深入分析后发现，这种依赖关系主要源于FilePath类的使用。FilePath类原本定义在detekt-psi-utils模块中，但却被detekt-api广泛使用。这种跨模块的类引用导致了不必要的依赖链。

更具体地说，当前实现在KtFile中存储了三种路径信息：

• relativePath（相对路径）
• absolutePath（绝对路径）
• basePath（基础路径）

这种设计存在明显的冗余问题。实际上，只需要其中两种路径信息就能推导出第三种，而basePath更是所有KtFile共享的相同值，完全不需要在每个文件中重复存储。

优化方案

开发团队提出了几个优化方向：

1. 简化路径存储：将三种路径信息精简为两种（relativePath和basePath），通过计算获得第三种路径。

2. 统一工作目录：通过确保System.getProperty("user.dir")始终与basePath一致，可以进一步简化设计，使relativePath的absolute()方法调用始终返回预期结果。

3. 更彻底的架构调整：考虑利用Kotlin编译器提供的KtFile.virtualFile.path来获取绝对路径，而相对路径则可以通过基础路径计算得出。这种方案需要调整autocorrect功能的实现方式，但能带来更清晰的架构。

实施效果

经过优化后，项目成功实现了：

• 移除了FilePath类，简化了代码结构
• 消除了detekt-api对detekt-psi-utils的依赖
• 使各模块职责更加清晰
• 为后续可能的架构演进奠定了基础

架构启示

这个优化案例给我们带来了几点重要的架构设计启示：

1. 核心API模块应保持最小依赖原则
2. 避免在多个地方存储可推导的数据
3. 合理利用语言和框架提供的原生能力
4. 在功能完整性和架构简洁性之间寻找平衡点

通过这次优化，Detekt项目的代码结构变得更加清晰，模块间的边界更加明确，为未来的功能扩展和维护打下了更好的基础。