Compose Destinations 多模块导航图配置要点解析

Compose Destinations 是一个优秀的 Jetpack Compose 导航库，它通过注解处理器简化了导航图的定义和使用。在多模块项目中配置导航图时，开发者可能会遇到一些需要注意的技术细节。

多模块导航图基础配置

在多模块项目中，通常会有一个主模块（app模块）和若干功能模块。每个功能模块可以定义自己的导航图，然后通过主模块进行整合。

主模块导航图定义：

private const val MAIN_GRAPH = "main_nav_graph"

@NavHostGraph(
    defaultTransitions = DefaultTransitions::class,
    route = MAIN_GRAPH,
    visibility = CodeGenVisibility.INTERNAL
)
annotation class MainGraph {
    @ExternalNavGraph<BottomNavigationNavGraph>(start = true)
    companion object Includes
}

功能模块导航图定义：

private const val BOTTOM_NAVIGATION_GRAPH = "bottom_navigation_graph"

@NavGraph<ExternalModuleGraph>(
    route = BOTTOM_NAVIGATION_GRAPH,
    start = true,
    navArgs = Nothing::class,
    deepLinks = []
)
annotation class BottomNavigationNavGraph

关键配置注意事项

1. 命名规范：功能模块的导航图注解类名必须以"NavGraph"结尾，这是Compose Destinations的命名约定。例如BottomNavigationNavGraph是正确的，而BottomNavigationGraph会导致编译错误。

2. 可见性控制：

   • 主模块可以使用CodeGenVisibility.INTERNAL限制生成的导航代码的可见性
   • 功能模块的导航图不能使用CodeGenVisibility.INTERNAL，因为这会破坏模块间的可见性规则，导致主模块无法访问功能模块的导航图

3. 依赖关系：

   • 功能模块需要先编译，主模块才能正确引用其导航图
   • 确保模块间的依赖关系正确配置

最佳实践建议

1. 对于多模块项目，建议采用清晰的命名规范，如使用模块名作为导航图前缀

2. 在功能模块中，可以定义多个层级嵌套的导航图，但只有最外层的导航图需要暴露给其他模块

3. 考虑使用KSP注解处理器而不是kapt，以获得更好的编译性能

4. 对于复杂的导航结构，建议先在小规模测试项目中验证配置，再应用到主项目

通过遵循这些配置要点，开发者可以避免常见的多模块导航图集成问题，构建出结构清晰、可维护性高的导航架构。