首页
/ Compose Destinations 项目中的生成文件优化方案

Compose Destinations 项目中的生成文件优化方案

2025-06-25 09:33:33作者:齐冠琰

Compose Destinations 是一个用于简化 Jetpack Compose 导航的库,它能够自动生成导航相关的代码和文档。在最新版本中,开发团队针对生成文件的处理方式做出了重要优化。

问题背景

在早期版本中,Compose Destinations 会自动生成两种辅助文件:Mermaid 图表文件(.mmd)和HTML导航图文件。这些文件默认会被包含在最终构建的APK中,虽然它们对应用的运行时功能没有影响,但会带来以下问题:

  1. 增加了APK的体积
  2. 可能暴露应用内部导航结构
  3. 包含了对终端用户无用的开发辅助内容

解决方案演进

开发团队在收到反馈后,迅速响应并提供了多种解决方案:

临时解决方案

  1. 指定输出目录:开发者可以通过KSP配置明确指定生成文件的输出路径
ksp {
    arg("compose-destinations.mermaidGraph", "$rootDir/docs")
    arg("compose-destinations.htmlMermaidGraph", "$rootDir/docs")
}
  1. 打包排除规则:在模块的build.gradle文件中添加排除规则
resources {
    excludes += "com/ramcosta/composedestinations/generated/mermaid/**"
}

永久解决方案

在2.1.0-beta15及更高版本中,开发团队修改了默认行为:

  1. 不再默认生成这些辅助文件
  2. 只有当开发者明确配置输出目录时才会生成
  3. 生成的文件默认不会包含在APK中

技术实现原理

这一优化主要涉及KSP(Kotlin Symbol Processing)处理器的修改。KSP处理器现在会:

  1. 检查是否配置了输出目录参数
  2. 只有检测到有效目录时才生成辅助文件
  3. 确保生成的文件位于指定目录而非默认的资源目录

最佳实践建议

  1. 对于使用2.1.0-beta15之前版本的项目,建议采用上述临时解决方案之一
  2. 升级到最新版本以获得更简洁的构建输出
  3. 如果确实需要这些辅助文件,建议将它们输出到项目文档目录而非资源目录

这一优化体现了Compose Destinations团队对开发者体验的重视,也展示了开源项目如何通过社区反馈不断改进产品。

登录后查看全文
热门项目推荐
相关项目推荐