千元一行错误 - SBT + PlayFramework-java教程-PHP中文网

千元一行错误 - SBT + PlayFramework

PHPz

发布： 2024-07-17 16:05:23

原创

327 人浏览过

The thousand dollars one line mistake - SBT + PlayFramework

现在每个人都在谈论拥有良好的开发者体验是多么重要，因为它会带来很多好的副作用，例如但不限于：

开发速度/生产力
代码质量/维护
节省成本等

但是，我们经常会在过去的某个时间从事项目，添加一小段代码以使项目更快，甚至修复某些问题，也许有人试图使构建更快，或者甚至试图给工程师更好的开发体验。这个故事就是这种情况。

几年前，在我们工作的一个项目中（在我加入公司之前），发现了构建 SBT、Scala 和 play 框架的问题，其中本地构建项目的编译时间很长大约 3 到 5 分钟，具体取决于机器。已尝试解决该问题。项目结构分为 2 部分，如下所示：
之前

ProjectA
  /api
 /core
 /app

登录后复制

之后

ProjectA
 /core
 /app

ProjectApi
  /api

登录后复制

以下内容已添加到 build.sbt

lazy val projectA = (project in file("."))
  .enablePlugins(...)
  .settings(commonSettings)
  .aggregate(api)
  .dependsOn(api)

lazy val api = project.settings(commonSettings)

登录后复制

通过这样做，它确实提高了编译时间，只是在 CI 管道上构建期间，我不确定它在开发阶段是否有帮助，但是，它增加了一个新的可怕的错误，使开发人员浪费了数千美元工作时间。

添加此行后，开发人员开始注意到运行一个简单的代码需要多长时间
sbt 在本地运行，对于现在代码库中的每一个更改，都需要完整的编译。

理解问题的旅程

根据 SBT 参考手册 - 多项目中的记录

重要的是要注意聚合的两个定义，并且取决于

聚合意味着在聚合项目上运行任务也会在聚合项目上运行

一个项目可能依赖于另一个项目中的代码。这是通过添加 dependentOn 方法调用来完成的。例如，如果核心在其类路径上需要 util。

花了一两天阅读文档并多次尝试解决问题后，我最终到达了这个 Github - Spurious recompilation in multi-project build 这并不是修复本身，但是，最终给了我光明了解问题确实与多项目设置有关。

更进一步，我明白发生了什么，现在我的 build.sbt 文件就这么简单：

lazy val projectA = (project in file("."))
  .enablePlugins(...)
  .settings(commonSettings)
  .dependsOn(api)

lazy val api = (project in file("api"))
  .settings(commonSettings)

登录后复制

我们在 SBT 中设置项目 A 的方式存在问题。我们告诉 SBT 包含项目的 API（这是正确的），但 API 定义指向整个项目根。这意味着：

每当API需要编译时，SBT也会尝试编译projectA本身。
由于projectA需要API进行编译，因此会触发另一个API编译。
这造成了无限循环，迫使开发人员终止 SBT，并为每次代码更改手动清理和编译所有内容。
用更简单的术语来说，这是发生的事情：

我们告诉 SBT 包含该项目的 API。
API定义指向整个项目。
编译 API 触发了完整的项目编译（再次包括 API）。
这个循环使得 SBT 非常慢并且让开发者感到沮丧。

团队已经为这个问题工作了至少 4 年......

后果 - 解决问题

当我对我的队友说我已经在master上合并了一个令人惊讶的功能后，人们不明白发生了什么，但是，我想看到他们脸上的幸福，我告诉整个团队将master拉入任何他们中的一些人在第一次尝试时没有注意到任何事情，另一些人开始注意到在更改代码库中的任何代码后，它只在几秒钟内编译受影响的文件，而不是像以前那样几分钟。最令人惊讶的是，一名队友注意到了这一点，并在办公室大声说道。