# Spring Boot
> For the complete documentation index, see [llms.txt](https://www.jetbrains.com.cn/help/idea/llms.txt).
[Spring Boot](https://spring.io/projects/spring-boot) 是 [Spring](https://spring.io/) 框架的扩展，可简化 Spring 应用程序的初始配置。 它使您能够快速创建一个带有最少默认配置的独立工作 Spring 应用程序。
[Spring Initializr](https://start.spring.io/) 是一个可以生成 Spring Boot 项目的 Web 应用程序。 您可以选择所需的配置，包括构建工具、语言、Spring Boot 框架版本以及项目的任何依赖项。 IntelliJ IDEA 提供了 Spring Initializr 项目向导，其与 Spring Initializr API 集成，以便直接从 IDE 生成和导入您的项目。
Procedure: 通过 Spring Boot 向导创建一个新的 Spring Boot 项目
1. 在主菜单中，前往 `文件 | 新建 | 项目…` 。
2. 在 新建项目 向导的左侧窗格中，选择 Spring Boot 。
3. 请按照 [Spring Boot 项目向导](spring-initializr-project-wizard.html) 的步骤进行。
例如，请参考 [教程：创建您的第一个 Spring 应用程序](your-first-spring-application.html)。 有关构建带数据库的 REST API 的多部分示例，请参阅 [教程：构建 Spring Boot REST API](spring-boot-rest-api-tutorial.html)。
Spring Initializr 生成具有以下文件的有效项目结构：
* 一个构建配置文件，例如， `build.gradle` 对于 Gradle 或 `pom.xml` 对于 Maven。
* 用于引导应用程序的 `main()` 方法的类。
* 一个空的 JUnit 测试类。
* 一个空的 Spring 应用程序配置文件： `application.properties`
Procedure: 向现有的 Spring Boot 项目添加启动器
使用 IntelliJ IDEA 创建新的 Spring Boot 项目时，可以在 [专用的新项目向导](null) 中添加启动器。 您还可以使用构建文件中的 添加启动器 内嵌提示将它们添加到现有项目中。
1. 打开您的 `pom.xml` 文件或 `build.gradle(.kts)` 文件。
2. 在 `dependencies` 块中，点击  添加启动器 。
3. 在打开的 添加启动器 对话框中，选择您想要添加的起始器。
将会相应地修改您的构建文件。 以这种方式添加依赖项时，IntelliJ IDEA 会考虑 Spring Boot 版本，免去担心兼容依赖项版本的麻烦。
您可以在 IDE 设置（ `Ctrl+Alt+S` (Windows), `⌘ Comma` (macOS), `⌘ Comma` (IntelliJ IDEA Classic (macOS)), `⌘ Comma` (macOS System Shortcuts), `Ctrl+Alt+S` (XWin), `Ctrl+Alt+S` (GNOME), `Ctrl+Alt+S` (KDE), `Ctrl+Alt+S` (Emacs), `Ctrl+Alt+S` (Sublime Text), `⌘ Comma` (Sublime Text (macOS)), `Ctrl+Alt+S` (Visual Studio), `⌘ Comma` (Visual Studio (macOS)), `Ctrl+Alt+S` (NetBeans), `Ctrl+Alt+S` (Eclipse), `⌘ Comma` (Eclipse (macOS))）中的 `编辑器 | 内嵌提示 | 其他` 内，在 Groovy 、 Kotlin 和 XML 下禁用或启用此嵌入提示。
默认情况下，IntelliJ IDEA 会将 [代码格式化](reformat-and-rearrange-code.html)应用到生成的文件中。 如果您希望文件保持由 Spring Initializr 生成时的格式，请使用 `Ctrl+Alt+S` (Windows), `⌘ Comma` (macOS), `⌘ Comma` (IntelliJ IDEA Classic (macOS)), `⌘ Comma` (macOS System Shortcuts), `Ctrl+Alt+S` (XWin), `Ctrl+Alt+S` (GNOME), `Ctrl+Alt+S` (KDE), `Ctrl+Alt+S` (Emacs), `Ctrl+Alt+S` (Sublime Text), `⌘ Comma` (Sublime Text (macOS)), `Ctrl+Alt+S` (Visual Studio), `⌘ Comma` (Visual Studio (macOS)), `Ctrl+Alt+S` (NetBeans), `Ctrl+Alt+S` (Eclipse), `⌘ Comma` (Eclipse (macOS))打开 IDE 设置，选择 `语言＆框架 | Spring | Spring Initializr` 并禁用 创建新项目时重新格式化代码 选项。
Procedure: 运行 Spring Boot 应用程序
* 打开带有 `main()` 方法的类（通常也用 `@SpringBootApplication` 注解标识），点击装订区域的 ，然后选择运行类。
或者，您可以在编辑器中打开类文件时按 `Ctrl+Shift+F10` (Windows), `⌃ ⇧ R` (macOS), `⌃ ⇧ F10` (IntelliJ IDEA Classic (macOS)), `⌃ ⇧ R` (macOS System Shortcuts), `Ctrl+Shift+F10` (XWin), `Ctrl+Shift+F10` (GNOME), `Ctrl+Shift+F10` (KDE), `Ctrl+Shift+F10` (Emacs), `Ctrl+Shift+F10` (Sublime Text), `Ctrl+Shift+F10` (Sublime Text (macOS)), `Ctrl+Alt+F5` (Visual Studio), `⌃ ⌥ F5` (Visual Studio (macOS)), `Alt+Shift+F6` (NetBeans), `Ctrl+Shift+F10` (Eclipse), `⌃ ⇧ R` (Eclipse (macOS))。
IntelliJ IDEA 创建并执行 Spring Boot 运行配置。 更多信息请参阅 [Spring Boot 运行配置](run-debug-configuration-spring-boot.html)。
Procedure: 使用 Gradle 运行 Spring Boot
默认情况下，对于基于 Spring Boot Gradle 的应用程序，IntelliJ IDEA 使用 Gradle 来构建项目，并使用 IntelliJ IDEA 来运行它。 您可以配置 IDE 使用 Gradle 而不是 IntelliJ IDEA 来运行 Spring Boot 应用程序。
1. 转到 高级设置 设置页面 `Ctrl+Alt+S` (Windows), `⌘ Comma` (macOS), `⌘ Comma` (IntelliJ IDEA Classic (macOS)), `⌘ Comma` (macOS System Shortcuts), `Ctrl+Alt+S` (XWin), `Ctrl+Alt+S` (GNOME), `Ctrl+Alt+S` (KDE), `Ctrl+Alt+S` (Emacs), `Ctrl+Alt+S` (Sublime Text), `⌘ Comma` (Sublime Text (macOS)), `Ctrl+Alt+S` (Visual Studio), `⌘ Comma` (Visual Studio (macOS)), `Ctrl+Alt+S` (NetBeans), `Ctrl+Alt+S` (Eclipse), `⌘ Comma` (Eclipse (macOS))。
2. 在 框架。 Spring Boot 下选择 使用 Gradle 运行 。
如果在 `构建、执行、部署 | 构建工具 | Gradle | 使用构建和运行` 中选择了 %instance% ， 使用 Gradle 运行 复选框将无效。 在这种情况下，IntelliJ IDEA 将用于构建和运行您的 Spring Boot 应用程序。
> **Tip:**
> `高级设置 | 使用 Gradle 运行` 的值是 IDE 级别的设置，而 `构建、执行、部署 | 构建工具 | Gradle` 下的设置可以针对每个项目单独配置。
## 自定义配置文件
Spring Initializr 创建的默认配置文件可能并不总是足够用于开发。 如果您不想使用默认配置文件，或者想在不同的环境中运行您的代码，可以使用在项目中定义的自定义配置文件。
让 IntelliJ IDEA 知道项目中哪些文件是配置文件，以启用相关的高亮显示和代码辅助：
Procedure: 定义项目配置文件
1. 在主菜单中，前往 `文件 | 项目结构` 或按 `Ctrl+Alt+Shift+S` (Windows), `⌘ ;` (macOS), `⌘ ;` (IntelliJ IDEA Classic (macOS)), `⌘ ⇧ Comma` (macOS System Shortcuts), `Ctrl+Alt+Shift+S` (XWin), `Ctrl+Alt+Shift+S` (GNOME), `Ctrl+Alt+Shift+S` (KDE), `Ctrl+Alt+Shift+S` (Emacs), `Ctrl+Alt+Shift+S` (Sublime Text), `⌘ ;` (Sublime Text (macOS)), `Ctrl+Alt+Shift+S` (Visual Studio), `⌘ ;` (Visual Studio (macOS)), `Ctrl+Alt+Shift+S` (NetBeans), `Ctrl+Alt+Shift+S` (Eclipse), `⌘ ;` (Eclipse (macOS))以打开 项目结构 对话框。
2. 从左侧列表中添加 Spring 面，选择 Facet ，点击 ，然后选择 Spring 。
3. 在右侧部分，选择 配置文件 并点击工具栏中的  ( 自定义 Spring Boot )。
4. 如果您想使用自定义配置文件而不是默认文件，请在 `spring.config.name` 字段中输入其名称。
如果您想要使用多个配置文件，请点击 ，然后从项目树中选择文件。
有效的配置文件会用  标记。
5. 点击 OK 并应用更改。
> **Note:**
> 一些自定义配置文件会被自动检测。 例如，与当前命名模式匹配的特定于配置文件的配置文件将被添加到上下文中。
## 运行时端点
Spring Boot 包含额外的功能，通过 HTTP endpoints 或 Java Management Extensions (JMX) 在生产环境中监控和管理您的应用程序状态。 有关详情，请参阅 [Spring Boot Actuator: Production-ready Features](https://docs.spring.io/spring-boot/docs/current/reference/html/production-ready-features.html)。
Procedure: 启用 Spring Boot actuator 端点
1. 在您的 `pom.xml` 或 `build.gradle` 文件中，点击 添加启动器… 内嵌提示，紧挨着 `dependencies` 列表。
或者，按 `Alt+Insert` (Windows), `⌘ N` (macOS), `⌃ N` (IntelliJ IDEA Classic (macOS)), `⌘ N` (macOS System Shortcuts), `Alt+Insert` (XWin), `Alt+Insert` (GNOME), `Alt+Insert` (KDE), `Alt+Insert` (Emacs), `Ctrl+N` (Sublime Text), `⌘ N` (Sublime Text (macOS)), `Ctrl+N` (Visual Studio), `⌘ N` (Visual Studio (macOS)), `Alt+Insert` (NetBeans), `Alt+Insert` (Eclipse), `⌘ N` (Eclipse (macOS)) 文件中的任意位置，然后选择 添加启动器 。
2. 在打开的窗口中，选择 Spring Boot Actuator 。
或者您可以手动添加 `spring-boot-starter-actuator` 依赖：
Maven:
打开 `pom.xml` 文件，并在 `dependencies` 下添加以下依赖项：
```XML
org.springframework.boot
spring-boot-starter-actuator
```
Gradle Groovy:
打开 `build.gradle` 文件，并在 `dependencies` 下添加以下依赖项：
```GROOVY
implementation 'org.springframework.boot:spring-boot-starter-actuator'
```
Gradle Kotlin:
打开 `build.gradle.kts` 文件，并在 `dependencies` 下添加以下依赖项：
```KOTLIN
implementation("org.springframework.boot:spring-boot-starter-actuator")
```
当您运行包含此依赖项的应用程序时，您将能够通过 HTTP 访问暴露的 actuator 端点。 例如，如果应用程序在 localhost 端口号 8080 上运行，则 `健康` 端点的默认 URL 将是 [http://localhost:8080/actuator/health](http://localhost:8080/actuator/health)。
Procedure: 查看 Spring Boot actuator 端点
1. 运行您的 Spring Boot 应用程序并打开 [服务](services-tool-window.html) 工具窗口：选择 `查看 | 工具窗口 | 服务` 或按 `Alt+8` (Windows), `⌘ 8` (macOS), `⌘ 8` (IntelliJ IDEA Classic (macOS)), `⌘ 8` (macOS System Shortcuts), `Alt+8` (XWin), `Alt+8` (GNOME), `Alt+8` (KDE), `Alt+8` (Emacs), `Alt+8` (Sublime Text), `⌘ 8` (Sublime Text (macOS)), `Alt+8` (Visual Studio), `Alt+8` (Visual Studio (macOS)), `Alt+8` (NetBeans), `Alt+8` (Eclipse), `⌘ 8` (Eclipse (macOS))。
2. 选择正在运行的 Spring Boot 应用程序，并使用以下选项卡从 actuator 端点获取信息：
* [Bean](#endpoints-beans)
* [运行状况](#endpoints-health)
* [映射](#endpoints-mappings)
* [环境](#endpoints-environment)
> **Note:**
> 如果 服务 工具窗口中没有 Spring Boot 运行配置，请 [添加它们](services-tool-window.html#run-configs)，或使用 运行 或 调试 工具窗口。
### Bean
Bean 选项卡显示了您的 Spring Boot 应用程序的 [runtime beans](https://docs.spring.io/spring-boot/docs/current/actuator-api/html/#beans)。 双击任意 bean 以在编辑器中打开其声明。 这些 bean 使用沟槽中的  图标表示。 点击此图标以查看依赖项和注入的 bean。
Bean 选项卡包含以下工具栏操作：
| 操作 | 描述 |
| --- | --- |
|  刷新 | 刷新由 JMX 代理收集的运行时 bean 信息。 |
|  图表模式 | 显示所有运行时 bean 的完整图表，而不是列表。 必需插件： Diagrams （已捆绑）。 |
|  显示库 Bean | 显示来自库的 Bean。 |
|  显示上下文 | 显示可用的 [Spring application contexts](spring-projects.html#create-application-context)。 |
|  显示配置文件 | 显示可用的配置文件。 |
|  显示 Bean 文档 | 显示所选 bean 的文档。 |
|  显示 Bean 图谱 | 显示所选 bean 的直接依赖项。 必需插件： Diagrams （已捆绑）。 |
### 运行状况
运行状况 选项卡显示了您的应用程序的状态。 这里有一些 [自动配置的健康指示器](https://docs.spring.io/spring-boot/docs/current/reference/html/production-ready-features.html#production-ready-health-indicators)，您还可以 [编写自定义健康指示器](https://docs.spring.io/spring-boot/docs/current/reference/html/production-ready-features.html#writing-custom-healthindicators)。
更多信息，请参阅 [Health](https://docs.spring.io/spring-boot/docs/current/actuator-api/html/#health)。
### 映射
映射 选项卡显示了您的应用程序的 [request mappings](https://docs.spring.io/spring-boot/docs/current/actuator-api/html/#mappings)。 它列出了所有带有 `@RequestMapping` 注解或其快捷方式（如 `@GetMapping` ）的方法。
如果您点击路径映射 URI，您可以选择运行相应的 HTTP 请求，使用该请求打开 HTTP 请求文件，或者在网页浏览器中打开请求 URL（如果这是一个 `GET` 请求）。 更多信息请参阅 [HTTP 客户端](http-client-in-product-code-editor.html)。
双击方法以在编辑器中打开其声明。 Spring 会将此类方法注册为处理程序，并且 IntelliJ IDEA 会在沟槽中使用 图标来指示它们。 点击此图标以运行相应的 HTTP 请求，或在请求文件中打开它，或者在网页浏览器中打开它（如果它是 `GET` 请求）。
映射 选项卡包含以下工具栏操作：
| 操作 | 描述 |
| --- | --- |
|  刷新 | 刷新 JMX agent 收集的请求映射。 |
|  在浏览器中打开 | 在网络浏览器中打开根应用程序 URL。 |
|  请求方法 | 选择显示哪些请求方法。 |
|  显示库映射 | 显示来自库的请求映射。 |
### 环境
环境 选项卡显示了 Spring Environment，其中包含从 `/actuator/env` 端点获取的信息。 它包括来自各种配置源的所有可用属性，例如应用程序属性和环境变量。
在高于 3.0 的 Spring Boot 版本中，由 Spring Environment 提供的值已完全脱敏（替换为 `******` ）。 在较早的 Spring Boot 版本中，默认情况下仅与凭据相关的键会被脱敏。 在这两种情况下，可以通过点击工具栏上的  或右键点击属性并选择 显示值 来显示隐藏的值。 此操作将重新启动应用程序，并将必要的标志添加到 重写配置属性 部分的 [Spring Boot run](run-debug-configuration-spring-boot.html#spring-boot) 配置中。 在高于 3.0 的 Spring 版本中，它是 `management.endpoint.env.show-values=when_authorized` ；在较早的版本中，它是 `management.endpoint.env.keys-to-sanitize` ，值为空。
要再次隐藏这些值，请再次点击 ，或右键点击属性并选择 隐藏值 。 这也将重新启动应用程序，并从运行配置中移除添加的属性。
## 应用更新策略
使用 `spring-boot-devtools` 模块后，您的应用程序将在 classpath 上的文件更改时重新启动。 如果 IntelliJ IDEA 被配置为持续编译已更改的文件，您可以设置一个触发文件。 在这种情况下，您的应用程序只有在您修改触发文件后才会重新启动。 如需更多信息，请参阅 [Automatic Restart](https://docs.spring.io/spring-boot/docs/current/reference/html/using-spring-boot.html#using-boot-devtools-restart)。
Procedure: 启用自动重启
* 为您的项目添加 `spring-boot-devtools` 模块依赖。
Maven:
打开 `pom.xml` 文件，并在 `dependencies` 下添加以下依赖项：
```XML
org.springframework.boot
spring-boot-devtools
true
```
将 `spring-boot-devtools` 依赖项设置为 `可选` 可防止它被使用项目的其他模块使用。
Gradle:
打开 `build.gradle` 文件，并在 `dependencies` 下添加以下依赖项：
```GRADLE
developmentOnly("org.springframework.boot:spring-boot-devtools")
```
将 `spring-boot-devtools` 依赖项设置为 `developmentOnly` 可防止它被使用项目的其他模块使用。
要更新正在运行的应用，请转到主菜单中的 `运行｜调试操作｜更新运行中应用程序` `Ctrl+F10` (Windows), `⌘ F10` (macOS), `⌘ F10` (IntelliJ IDEA Classic (macOS)), `⌘ F10` (macOS System Shortcuts), `Ctrl+F10` (XWin), `Ctrl+F10` (GNOME), `Ctrl+F10` (KDE), `Ctrl+F10` (Emacs), `Ctrl+F10` (Sublime Text), `⌘ F10` (Sublime Text (macOS)), `Ctrl+F10` (Visual Studio), `⌘ F10` (Visual Studio (macOS)), `Ctrl+F10` (NetBeans), `Ctrl+F10` (Eclipse), `⌘ F10` (Eclipse (macOS))，或在 [服务](services-tool-window.html)工具窗口中选择您的应用，然后点击 。 根据您的需要，您可以配置执行此操作时 IDE 的行为。
> **Note:**
> 如果 服务 工具窗口中没有 Spring Boot 运行配置，请 [添加它们](services-tool-window.html#run-configs)，或使用 运行 或 调试 工具窗口。
Procedure: 配置应用更新策略
1. 在主菜单中，前往 `运行 | 编辑配置` 。
2. 选择必要的 Spring Boot 运行配置以打开其设置。 点击 修改选项 。
3. 在打开的列表中，指向 执行“更新”操作时 。 您可以选择仅更新资源，更新类和资源（构建您的应用程序），更新触发文件（这将触发重启），或者尝试执行类热交换，若失败，则更新触发文件。
> **Note:**
> 为了 更新触发器文件 和 如果失败，则热更新类并更新触发器文件 策略，当您启动应用程序时，IDE 会设置一个触发文件。
4. 在 修改选项 列表中，指向 框架停用时 并选择在您切换到另一个应用程序后的 IDE 将执行的操作：更新资源或构建您的应用程序。
> **Tip:**
> 您可以创建多个 Spring Boot 运行/调试配置，并使用不同的更新策略在它们之间切换。
## See also
### 参考
[Spring Boot 运行配置](run-debug-configuration-spring-boot.html)
### 外部链接
[Spring Boot Developer Tools](https://docs.spring.io/spring-boot/docs/current/reference/html/using-boot-devtools.html)