IntelliJ IDEA
 
2023.2
快捷方式：Windows
获取 IntelliJ IDEA
  1. Scala
  2. sbt

sbt

最后修改时间：2023 年 9 月 5 日

打开现有的 sbt 项目

笔记

要创建新项目，请启动新建项目向导并按照向导中建议的步骤进行操作，例如选择Scala和sbt；指定项目的位置、JDK 以及 sbt 和 Scala 版本。（sbt 和 Scala 版本会自动获取。）

确保 sbt 和 Scala 版本兼容性

通常，您在团队中共享您的项目，并且需要使用特定版本的 sbt。您可以覆盖项目的build.properties文件中的 sbt 版本。

笔记

当您尝试导入包含旧版本 sbt 的 sbt 项目时，您可能会收到错误。我们建议您升级到 sbt 版本 1.0 及更高版本，它们与 Scala 版本 2.12 兼容（需要 Java 8）。

SBT项目结构

当您创建或导入 sbt 项目时，IntelliJ IDEA 会生成以下 sbt 结构：

  • sbt 项目（正确的构建），它定义一个项目并包含build.sbt文件、src和目标目录、模块；与常规项目相关的任何内容。

    项目工具窗口

  • sbt构建项目，其定义在项目子目录中。它包含属于构建定义一部分的附加代码。

    sbt 源根

  • sbt工具窗口，其中包含您可以执行的sbt 任务、命令和设置。

    sbt工具窗口

提示

有关sbt项目结构的更多信息，请参阅相关的sbt文档。

管理 sbt 项目

当您使用 sbt 项目时，您可以使用build.sbt文件对项目进行主要更改，因为 IntelliJ IDEA 将 sbt 配置视为单一事实来源。

每次在编辑器中手动更改build.sbt时，都需要加载更改。IntelliJ IDEA 在编辑器的右侧显示一个通知图标，建议加载对项目所做的sbt 更改( )。CtrlShift0O

build.sbt 文件：加载 sbt 更改

如果您想控制项目的导入过程，可以手动触发操作或配置自动重新加载过程。

重新加载 sbt 项目

  1. 在sbt工具窗口中，右键单击链接的项目。

  2. 从上下文菜单中，选择“重新加载项目” 重新加载项目图标。

    调用此操作时，IntelliJ IDEA 会解析sbt工具窗口中的项目结构。

    IntelliJ IDEA 无法仅重新加载项目的一部分，它会重新加载整个项目，包括子项目和依赖项。

提示

要重新加载所有 sbt 项目，请单击sbt重新加载所有 sbt 项目图标工具窗口中工具栏上的。

配置自动重新加载

  1. 在“设置”对话框 ( ) 中，转到“构建、执行、部署”| 构建工具。CtrlAlt0S

    或者，在sbt工具窗口中，单击构建工具设置并选择“自动重新加载设置”选项。

    sbt 工具窗口

  2. 在构建工具设置中，指定以下选项：

    构建工具设置

    • 重新加载构建脚本中的更改：默认情况下选择此选项。如果您想禁用自动重新加载并手动控制重新加载过程，请取消选中此复选框。

    • 任何更改：如果您希望在对build.sbt进行任何更改或外部更改后自动重新加载项目，请选择此选项。

      每次在编辑器中手动更改 sbt 构建脚本时，都需要加载更改。IntelliJ IDEA 在编辑器的右侧显示一个通知图标，建议加载对项目所做的sbt 更改( )。CtrlShift0O

      sbt构建脚本

      使用“任何更改”选项，IntelliJ IDEA 会自动重新加载所有更改。

    • 外部更改：当您选择此选项时，IntelliJ IDEA 仅在 VCS 更改以及对 IDE 外部的构建文件进行更改后自动重新加载项目。

  1. 打开你的build.sbt。

  2. 指定以下代码：

    val localDep = RootProject(file("/path/to/project"))

    localDep在本例中，项目位于文件系统的某个位置，并将作为模块导入。

  3. 重新加载您的项目。（单击sbt应用程序操作刷新工具窗口中的。）

    IntelliJ IDEA 在“项目”工具窗口以及sbt工具窗口中显示添加的项目。

  1. 在编辑器中打开build.sbt 。

  2. 指定，例如：

    lazy val sampleModule = (project in file("sampleModule"))

    "sampleModule"在本例中是您要添加的子项目。您可以指定多个子项目。

  3. 重新导入您的项目。（单击sbt重新导入项目工具窗口中的。）

    IntelliJ IDEA 生成一个包含适当信息的子项目目录，并将其显示在Project和sbt工具窗口中。

如果您希望子项目在更改 Scala 版本时自动更新，请为每个子项目指定commonSettings并调用方法。settings

  1. 打开build.sbt。

  2. 例如，指定以下代码：

    lazy val commonSettings = Seq(
    organization := "com.example",
    version := "0.1.0-SNAPSHOT",
    scalaVersion := "2.12.6"
)
lazy val moduleSample = (project in file("moduleSample"))
        .settings(
            commonSettings
        )

    适当的 Scala 版本将添加到Project工具窗口中的子项目目录中，并作为子项目中的依赖项添加到sbt工具窗口中。

将库添加到 sbt 项目

您可以通过build.sbt文件添加sbt 依赖项，也可以在.scala文件中使用该语句。import

笔记

一旦 IntelliJ IDEA 检测到build.sbt中的更改，就会出现一条通知，建议您刷新项目。刷新您的项目。（单击sbt应用程序操作刷新工具窗口中的。）

或者，使用sbt 设置中的自动导入选项。

使用 sbt shell

sbt shell 嵌入在 sbt 项目中，并在项目启动时可用。您可以使用 sbt shell 执行 sbt 命令和任务、运行和调试项目。

运行 sbt 任务

提示

您可以像执行sbt 任务一样执行 sbt命令和设置。

使用 sbt 设置

使用sbt 设置来配置 sbt 项目的构建和运行操作、sbt 版本、项目更改的导入等。

访问 sbt 设置

  1. 按打开 IDE 设置，然后选择“构建”、“执行”、“部署”| 顺便说一句。CtrlAlt0S

  2. 或者，单击sbtsbt设置工具窗口工具栏上的来访问 sbt 设置。

  3. 在 sbt 设置页面上，配置以下值得注意的操作：

    • 要将正在运行的构建委托给 sbt，请在Use sbt shell旁边，选择用于导入和用于构建选项。

    • 要通过 sbt shell 调试代码，请选择启用 sbt shell 调试应用程序操作启动调试器选项，以启用sbt shell 工具窗口中的调试按钮。

      有关调试的更多信息，请参阅使用 sbt 进行调试。

    • 要更改项目中的.ivy缓存位置或设置其他sbt 属性，请使用VM 参数字段。

    笔记

    如果您想为您的项目配置项目重新加载选项，请参阅构建工具设置。

  4. 单击“确定”保存更改。

要检查最常见的 sbt 问题和解决方法，请参阅sbt 故障排除部分。