sbt dependencyTree异常显示Test依赖及打包问题技术问询

问题场景 #

以下是极简复现项目配置：

name := "root"
ThisBuild / scalaVersion := "2.13.15"

lazy val common = project
lazy val a = project.dependsOn(common)
lazy val b = project.dependsOn(common % Test)

现象对比 #

• 针对项目a执行dependencyTree，输出符合预期，仅展示编译作用域下的common依赖：

❯ sbt a/dependencyTree
[info] welcome to sbt 1.10.6 (Eclipse Adoptium Java 23.0.1)
…
[info] a:a_2.13:0.1.0-SNAPSHOT [S]
[info]   +-common:common_2.13:0.1.0-SNAPSHOT [S]

• 针对项目b执行相同命令，却意外输出了common，但common仅为b的Test作用域依赖，不属于主代码的依赖树：

❯ sbt b/dependencyTree
[info] welcome to sbt 1.10.6 (Eclipse Adoptium Java 23.0.1)
…
[info] b:b_2.13:0.1.0-SNAPSHOT [S]
[info] common:common_2.13:0.1.0-SNAPSHOT

实际负面影响 #

尽管sbt b/compile不会编译common，但使用sbt-native-packager执行b/stage打包时，会额外编译common并生成其文档、POM文件，造成编译时间浪费和最终包体积冗余：

❯ sbt b/compile
…
[info] compiling 1 Scala source to …/b/target/scala-2.13/classes ...
[success] Total time: 2 s, completed 14 Dec 2024, 12:48:16

❯ sbt b/stage
…
[info] Wrote …/b/target/scala-2.13/b_2.13-0.1.0-SNAPSHOT.pom
[info] Main Scala API documentation to …/b/target/scala-2.13/api...
[info] Main Scala API documentation successful.
[info] Wrote …/common/target/scala-2.13/common_2.13-0.1.0-SNAPSHOT.pom
[info] Main Scala API documentation to …/common/target/scala-2.13/api...
[info] compiling 1 Scala source to …/common/target/scala-2.13/classes ...
[info] Main Scala API documentation successful.
[success] Total time: 2 s, completed 14 Dec 2024, 12:48:24

结论与解决方案 #

这不是配置遗漏，而是sbt处理子项目依赖时的行为特性（部分场景可视为bug级别的不一致）：

1. 关于dependencyTree显示问题 #

sbt dependencyTree默认会加载并展示所有作用域的依赖（包括Test），但未明确标注作用域，导致视觉上误解为主依赖。解决方法是指定作用域过滤：
执行sbt b/dependencyTree compile仅查看编译作用域的依赖，此时common不会出现在输出中。

2. 关于sbt-native-packager打包时编译common的问题 #

sbt stage任务会触发关联子项目的publishLocal相关前置任务（如生成POM、API文档），即使该子项目仅为Test作用域依赖。这是因为sbt的任务依赖传递逻辑中，Test作用域的子项目仍会被标记为关联项目，触发其必要构建步骤。

临时解决办法：

• 调整项目结构：将common中供测试使用的代码拆分到单独的测试子项目，避免主common项目被Test依赖关联。
• 若无需Test依赖参与打包，可通过调整aggregate配置排除common，但需注意这可能导致b的测试任务无法正常引用common，需谨慎操作。

内容的提问来源于stack exchange，提问作者waterfallweb