首页
/ 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团队对开发者体验的重视,也展示了开源项目如何通过社区反馈不断改进产品。

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

项目优选

收起
docsdocs
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
146
1.94 K
kernelkernel
deepin linux kernel
C
22
6
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
192
274
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
145
189
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
930
554
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
8
0
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
965
395
金融AI编程实战金融AI编程实战
为非计算机科班出身 (例如财经类高校金融学院) 同学量身定制,新手友好,让学生以亲身实践开源开发的方式,学会使用计算机自动化自己的科研/创新工作。案例以量化投资为主线,涉及 Bash、Python、SQL、BI、AI 等全技术栈,培养面向未来的数智化人才 (如数据工程师、数据分析师、数据科学家、数据决策者、量化投资人)。
Jupyter Notebook
75
66
CangjieCommunityCangjieCommunity
为仓颉编程语言开发者打造活跃、开放、高质量的社区环境
Markdown
1.11 K
0
openHiTLS-examplesopenHiTLS-examples
本仓将为广大高校开发者提供开源实践和创新开发平台,收集和展示openHiTLS示例代码及创新应用,欢迎大家投稿,让全世界看到您的精巧密码实现设计,也让更多人通过您的优秀成果,理解、喜爱上密码技术。
C
64
513