Git子模块整合多SBT项目遇类找不到错误求正确方案

问题原因分析 #

你之前用RootProject引入子项目的方式，会将子项目视为外部独立项目，SBT不会自动处理它们的依赖传递到父项目的运行环境，同时IDE的跨项目代码导航支持也不够完善，这是导致运行时类缺失（NoClassDefFoundError）和导航繁琐的核心原因。

正确配置方案 #

1. 确认Git子模块结构 #

确保父项目目录下已通过Git子模块引入三个项目，结构如下：

aggregator/
├── core/          # Git子模块：core项目
├── plugins/       # Git子模块：plugins项目
├── utils/         # Git子模块：utilities项目
└── build.sbt      # 父项目构建文件

2. 父项目build.sbt配置 #

将子项目作为本地子项目而非外部RootProject，同时通过aggregate整合所有项目，确保IDE能识别完整的项目依赖关系：

ThisBuild / version := "0.1.0-SNAPSHOT"
ThisBuild / scalaVersion := "2.12.16"

// 声明每个子项目，直接关联本地目录的SBT项目
lazy val core = project.in(file("core"))
lazy val utilities = project.in(file("utils"))
// 根据实际依赖关系调整：比如plugins依赖core和utilities
lazy val plugins = project.in(file("plugins"))
  .dependsOn(core, utilities)

// 父聚合项目，整合所有子项目
lazy val root = (project in file("."))
  .aggregate(core, utilities, plugins)
  .settings(
    name := "aggregator",
    // 跳过父项目的发布（因为不需要生成胖jar）
    publish / skip := true
  )

3. 子项目依赖补全 #

确保每个子项目的build.sbt中正确声明自身依赖，比如用到okhttp3的项目（如core或plugins）需添加：

// 在core/build.sbt或plugins/build.sbt中添加
libraryDependencies += "com.squareup.okhttp3" % "okhttp" % "4.10.0"

4. IDE导入与代码导航 #

用IntelliJ IDEA或VS Code（搭配Metals插件）导入父项目的build.sbt：

• IDE会自动识别所有子项目，将它们整合为一个工程
• 跨项目代码跳转、查看调用栈、重构等操作都可以直接完成，无需切换Git仓库

5. 运行项目（可选） #

如果需要运行某个子项目的主类，直接在SBT中指定子项目：

# 运行core项目的主类
sbt core/run

# 运行plugins项目的主类
sbt plugins/run

这种方式会自动加载子项目及其依赖的所有jar包，避免NoClassDefFoundError。

关键优势 #

• 完美满足便捷代码导航需求，IDE中所有项目统一管理
• SBT自动处理依赖传递，解决运行时类缺失问题
• 保留各子项目的Git独立性（通过子模块），不影响原有项目的版本管理

内容的提问来源于stack exchange，提问作者D. belvedere