Spring Boot入门指南

本文为官方文档直译版本。原文链接

引言

如果您要开始学习 Spring Boot 或一般意义上的 “Spring”，请先阅读本节内容。它回答了 “是什么？”、"怎么做？"和 "为什么？"等基本问题。其中包括 Spring Boot 简介和安装说明。然后，我们将引导您构建第一个 Spring Boot 应用程序，并讨论一些核心原则。

Spring Boot 简介

Spring Boot 可帮助您创建可运行的基于 Spring 的独立生产级应用程序。我们对 Spring 平台和第三方库持开放的态度，因此您可以轻松上手。大多数 Spring Boot 应用程序只需要很少的 Spring 配置。
您可以使用 Spring Boot 创建 Java 应用程序，这些应用程序可以通过使用 java -jar 或更传统的 war 部署来启动。
我们的主要目标是：

• 为所有 Spring 开发提供更快、更广泛的入门体验。
• 开箱即有主见，但当需求开始偏离默认值时又能迅速摆脱困境。
• 提供大量项目常用的非功能性特性（如嵌入式服务器、安全性、度量、健康检查和外部化配置）。
• 绝对无需生成代码（在不使用本地镜像时），也无需 XML 配置。

系统要求

Spring Boot 3.2.0 需要 Java 17，并兼容 Java 21（含 Java 21）。还需要 Spring Framework 6.1.1 或更高版本。
为以下构建工具提供了显式构建支持：

构建工具	版本
Maven	3.6.3 or later
Gradle	7.x (7.5 or later) and 8.x

Servlet 容器

Spring Boot 支持以下嵌入式 servlet 容器：

名称	Servlet 版本
Tomcat 10.1	6.0
Jetty 12.0	6.0
Undertow 2.3	6.0

您还可以将 Spring Boot 应用程序部署到任何兼容 servlet 5.0+ 的容器中。

GraalVM 原生镜像

Spring Boot 应用程序可使用 GraalVM 22.3 或更高版本转换为原生镜像。
可以使用 GraalVM 提供的原生构建工具 Gradle/Maven 插件或原生镜像工具创建镜像。你也可以使用native-image Paketo buildpack 创建原生镜像。
支持以下版本：

名称	版本
GraalVM Community	22.3
Native Build Tools	0.9.28

安装 Spring Boot

Spring Boot 可与 “classic” Java 开发工具一起使用，也可作为命令行工具安装。无论哪种方式，您都需要 Java SDK v17 或更高版本。开始之前，应使用以下命令检查当前的 Java 安装：

$ java -version

如果您是 Java 开发新手或想尝试使用 Spring Boot，您可能想先试试 Spring Boot CLI（命令行界面）。否则，请继续阅读 “classic” 安装说明。

Java 开发人员安装说明

您可以像使用任何标准 Java 库一样使用 Spring Boot。为此，请在 classpath 中包含相应的 spring-boot-*.jar 文件。Spring Boot 不需要任何特殊的集成工具，因此您可以使用任何集成开发环境或文本编辑器。此外，Spring Boot 应用程序也没有什么特别之处，因此您可以像运行其他 Java 程序一样运行和调试 Spring Boot 应用程序。
虽然您可以复制 Spring Boot jars，但我们一般建议您使用支持依赖关系管理的构建工具（如 Maven 或 Gradle）。

安装 Maven

Spring Boot 与 Apache Maven 3.6.3 或更高版本兼容。如果您尚未安装 Maven，可以按照 maven.apache.org 上的说明进行操作。

在许多操作系统上，Maven 可通过软件包管理器安装。如果您使用 OSX Homebrew，请尝试 brew install maven。Ubuntu 用户可以运行 sudo apt-get install maven。使用 Chocolatey 的 Windows 用户可以在提升（管理员）提示下运行 choco install maven。

Spring Boot 依赖项使用 org.springframework.boot groupId。通常，您的 Maven POM 文件继承自 spring-boot-starter-parent 项目，并声明对一个或多个 “starter” 的依赖。Spring Boot 还提供了一个可选的 Maven 插件，用于创建可执行的 jar。
有关 Spring Boot 和 Maven 入门的更多详情，请参阅 Maven 插件参考指南的 “入门” 部分。

安装 Gradle

Spring Boot 兼容 Gradle 7.x（7.5 或更高版本）和 8.x。如果尚未安装 Gradle，可以按照 gradle.org 上的说明进行安装。
Spring Boot 依赖项可以通过使用 org.springframework.boot groupId来声明。通常，项目会声明对一个或多个 "starter"的依赖。Spring Boot 提供了一个有用的 Gradle 插件，可用于简化依赖关系声明和创建可执行 jar。

Gradle 包装器（Wrapper）

当你需要构建一个项目时，Gradle Wrapper 提供了一种 “获取” Gradle 的好方法。它是一个小脚本和库，与代码一起提交，用于引导构建过程。详情请参阅 docs.gradle.org/current/userguide/gradle_wrapper.html。

有关 Spring Boot 和 Gradle 入门的更多详情，请参阅 Gradle 插件参考指南的 “入门” 部分。

安装 Spring Boot CLI

Spring Boot CLI（命令行界面）是一种命令行工具，可用于快速创建 Spring 的原型。
您并不需要使用 CLI 来使用 Spring Boot，但它是一种无需集成开发环境即可快速启动 Spring 应用程序的方法。

手动安装

您可以从以下位置下载 Spring CLI 发行版：

• spring-boot-cli-3.2.0-bin.zip
• spring-boot-cli-3.2.0-bin.tar.gz

下载完成后，请按照解压压缩包中的 INSTALL.txt 说明进行操作。总之，.zip 文件的 bin/ 目录中有一个 Spring 脚本（Windows 版本为 spring.bat）。另外，你也可以使用 java -jar 加载 .jar 文件（该脚本可帮助你确保类路径设置正确）。

使用 SDKMAN 安装！

SDKMAN！(软件开发工具包管理器）可用于管理各种二进制 SDK 的多个版本，包括 Groovy 和 Spring Boot CLI。从 sdkman.io 获取 SDKMAN! 并使用以下命令安装 Spring Boot：

$ sdk install springboot
$ spring --version
Spring CLI v3.2.0

如果您为 CLI 开发功能，并希望访问您创建的版本，请使用以下命令：

$ sdk install springboot dev /path/to/spring-boot/spring-boot-cli/target/spring-boot-cli-3.2.0-bin/spring-3.2.0/
$ sdk default springboot dev
$ spring --version
Spring CLI v3.2.0

前面的说明安装了一个名为dev的本地 Spring 实例。它指向目标构建位置，因此每次重建 Spring Boot 时，spring 都是最新的。
运行以下命令即可查看：

$ sdk ls springboot

================================================================================
Available Springboot Versions
================================================================================
> + dev
* 3.2.0

================================================================================
+ - local version
* - installed
> - currently in use
================================================================================

使用 OSX Homebrew 安装

如果你使用的是 Mac 和 Homebrew，可以使用以下命令安装 Spring Boot CLI：

$ brew tap spring-io/tap
$ brew install spring-boot

Homebrew 会将 Spring 安装到 /usr/local/bin。

如果看不到公式，可能是您安装的 brew 已经过时。在这种情况下，请运行 brew update 并重试。

使用 MacPorts 安装

如果使用 Mac 并使用 MacPorts，则可以使用以下命令安装 Spring Boot CLI：

$ sudo port install spring-boot-cli

命令行完成

Spring Boot CLI 包含为 BASH 和 zsh 提供命令完成的脚本。您可以在任何 shell 中为脚本（也命名为 spring）提供源代码，也可以将其放在个人或全系统的 bash 完成初始化中。在 Debian 系统中，全系统范围的脚本位于 <安装位置>/shell-completion/bash 目录下，当新 shell 启动时，该目录下的所有脚本都会被执行。例如，如果您使用 SDKMAN! 手动安装，要运行脚本，请使用以下命令：

$ . ~/.sdkman/candidates/springboot/current/shell-completion/bash/spring
$ spring <HIT TAB HERE>
  grab  help  jar  run  test  version

如果使用 Homebrew 或 MacPorts 安装 Spring Boot CLI，命令行完成脚本会自动在 shell 中注册。

Windows Scoop 安装

如果您在 Windows 上使用 Scoop，可以使用以下命令安装 Spring Boot CLI：

> scoop bucket add extras
> scoop install springboot

Scoop 会将 spring 安装到 ~/scoop/apps/springboot/current/bin 中。

如果看不到应用程序清单，则可能是您安装的 scoop 已过期。在这种情况下，请运行 scoop update 并重试。

开发你的第一个 Spring Boot 应用程序

本节介绍如何开发一个小型的 “Hello World!” Web 应用程序，以突出 Spring Boot 的一些关键功能。您可以选择 Maven 或 Gradle 作为构建系统。

spring.io 网站包含许多使用 Spring Boot 的 “入门” 指南。如果您需要解决某个具体问题，请先查看该网站。
您可以访问 start.spring.io，从依赖关系搜索器中选择 “Web” Starter，从而缩短下面的步骤。这样做会生成一个新的项目结构，让你可以立即开始编码。更多详情请查看 start.spring.io 用户指南。

先决条件

在开始之前，请打开终端并运行以下命令，以确保您安装的 Java 版本有效：

$ java -version
openjdk version "17.0.4.1" 2022-08-12 LTS
OpenJDK Runtime Environment (build 17.0.4.1+1-LTS)
OpenJDK 64-Bit Server VM (build 17.0.4.1+1-LTS, mixed mode, sharing)

该示例需要创建在自己的目录中。后续说明假定您已创建了一个合适的目录，并且该目录就是您的当前目录。

Maven

如果要使用 Maven，请确保已安装 Maven：

$ mvn -v
Apache Maven 3.8.5 (3599d3414f046de2324203b78ddcf9b5e4388aa0)
Maven home: usr/Users/developer/tools/maven/3.8.5
Java version: 17.0.4.1, vendor: BellSoft, runtime: /Users/developer/sdkman/candidates/java/17.0.4.1-librca

Gradle

如果要使用 Gradle，请确保已安装 Gradle：

$ gradle --version

------------------------------------------------------------
Gradle 8.1.1
------------------------------------------------------------

Build time:   2023-04-21 12:31:26 UTC
Revision:     1cf537a851c635c364a4214885f8b9798051175b

Kotlin:       1.8.10
Groovy:       3.0.15
Ant:          Apache Ant(TM) version 1.10.11 compiled on July 10 2021
JVM:          17.0.7 (BellSoft 17.0.7+7-LTS)
OS:           Linux 6.2.12-200.fc37.aarch64 aarch64

使用 Maven 创建项目

我们首先需要创建一个 Maven pom.xml 文件。pom.xml 是用于构建项目的配方。打开你喜欢的文本编辑器，添加以下内容：

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0modelVersion>

  <groupId>com.examplegroupId>
  <artifactId>myprojectartifactId>
  <version>0.0.1-SNAPSHOTversion>

  <parent>
    <groupId>org.springframework.bootgroupId>
    <artifactId>spring-boot-starter-parentartifactId>
    <version>3.2.0version>
  parent>

  

project>

上面的列表应该能为你提供一个可用的构建。你可以运行 mvn package 对其进行测试（暂时可以忽略 "jar will be empty - no content was marked for inclusion!"的警告）。

此时，您可以将项目导入集成开发环境（大多数现代 Java 集成开发环境都内置了对 Maven 的支持）。为简单起见，本例中我们继续使用纯文本编辑器。

使用 Gradle 创建项目

我们首先需要创建一个 Gradle build.gradle 文件。build.gradle 是用于构建项目的构建脚本。打开你喜欢的文本编辑器，添加以下内容：

plugins {
    id 'java'
    id 'org.springframework.boot' version '3.2.0'
}

apply plugin: 'io.spring.dependency-management'

group = 'com.example'
version = '0.0.1-SNAPSHOT'
sourceCompatibility = '17'

repositories {
    mavenCentral()
}

dependencies {
}

上面的列表应该能为您提供一个可运行的构建。您可以运行 gradle classes 对其进行测试。

此时，您可以将项目导入集成开发环境（大多数现代 Java 集成开发环境都内置了对 Gradle 的支持）。为简单起见，本示例继续使用纯文本编辑器。

添加类路径依赖

Spring Boot 提供了许多 “Starters”，可让您在类路径中添加 jar。“Starters” 提供了开发特定类型应用程序时可能需要的依赖项。

Maven

大多数 Spring Boot 应用程序都在 POM 的parent部分使用 spring-boot-starter-parent。spring-boot-starter-parent 是一个特殊的Starter，提供了有用的 Maven 默认值。它还提供了一个依赖关系管理部分，这样就可以省略 “blessed” 依赖关系的version标签。
由于我们要开发的是网络应用，所以要添加 spring-boot-starter-web 依赖。在此之前，我们可以通过运行以下命令来查看当前的情况：

$ mvn dependency:tree

[INFO] com.example:myproject:jar:0.0.1-SNAPSHOT

mvn dependency:tree 命令会打印出项目依赖关系的树状图。可以看到，spring-boot-starter-parent 本身没有提供任何依赖项。要添加必要的依赖项，请编辑 pom.xml，并在parent节点下添加 spring-boot-starter-web 依赖项：

<dependencies>
  <dependency>
    <groupId>org.springframework.bootgroupId>
    <artifactId>spring-boot-starter-webartifactId>
  dependency>
dependencies>

如果再次运行 mvn dependency:tree，你会发现现在又多了一些依赖项，包括 Tomcat 网络服务器和 Spring Boot 本身。

Gradle

大多数 Spring Boot 应用程序都使用 org.springframework.boot Gradle 插件。该插件提供了有用的默认设置和 Gradle 任务。io.spring.dependency-management（依赖管理）Gradle 插件提供了依赖管理功能，让你可以省略 “blessed” 依赖的version标签。
由于我们要开发的是网络应用，所以要添加 spring-boot-starter-web 依赖。在此之前，我们可以通过运行以下命令来查看当前的情况：

$ gradle dependencies

> Task :dependencies

------------------------------------------------------------
Root project 'myproject'
------------------------------------------------------------

gradle dependencies 命令会打印出项目依赖关系的树状图。目前，该项目没有依赖项。要添加必要的依赖项，请编辑 build.gradle，在依赖项部分添加 spring-boot-starter-web 依赖项：

dependencies {
    implementation 'org.springframework.boot:spring-boot-starter-web'
}

如果再次运行 gradle dependencies，你会发现现在又多了一些依赖项，包括 Tomcat 网络服务器和 Spring Boot 本身。

编写代码

要完成应用程序，我们需要创建一个 Java 文件。默认情况下，Maven 和 Gradle 从 src/main/java 编译源代码，因此需要创建该目录结构，然后添加一个名为 src/main/java/MyApplication.java 的文件，其中包含以下代码：

package com.example;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@SpringBootApplication
public class MyApplication {

    @RequestMapping("/")
    String home() {
        return "Hello World!";
    }

    public static void main(String[] args) {
        SpringApplication.run(MyApplication.class, args);
    }

}

虽然这里的代码不多，但内容却不少。在接下来的几节中，我们将逐步介绍重要的部分。

@RestController 和 @RequestMapping 注解

MyApplication 类的第一个注解是 @RestController。这就是所谓的_印象_注解。它为阅读代码的人和 Spring 提供了提示，表明该类扮演着特定的角色。在本例中，我们的类是一个网络 @Controller，因此 Spring 在处理传入的网络请求时会考虑到它。
@RequestMapping 注解提供了 “路由” 信息。它告诉 Spring，任何带有 / 路径的 HTTP 请求都应映射到 home 方法。@RestController 注解告诉 Spring 将生成的字符串直接呈现给调用者。

@RestController 和 @RequestMapping 注解是 Spring MVC 注解（并非 Spring Boot 特有）。有关详细信息，请参阅 Spring Reference Documentation 中的 MVC 部分。

@SpringBootApplication 注解

第二个类级注解是 @SpringBootApplication。这个注解被称为元注解，它结合了 @SpringBootConfiguration、@EnableAutoConfiguration 和 @ComponentScan 三个注解。
其中，我们最感兴趣的注解是 @EnableAutoConfiguration。@EnableAutoConfiguration 可以让 Spring Boot 根据你添加的 jar 依赖关系 “猜测” 你想如何配置 Spring。由于 spring-boot-starter-web 添加了 Tomcat 和 Spring MVC，因此自动配置会假定你正在开发 Web 应用程序，并相应地设置 Spring。

Starters and Auto-configuration
自动配置旨在与 “Starters” 良好配合，但这两个概念并不直接相关。您可以自由选择starters之外的 jar 依赖项。Spring Boot 仍会尽力自动配置您的应用程序。

“main”方法

应用程序的最后一部分是 main 方法。这是一个标准方法，遵循应用程序入口点的 Java 惯例。我们的主方法通过调用 run 委托给 Spring Boot 的 SpringApplication 类。SpringApplication 会引导我们的应用程序，启动 Spring，而 Spring 又会启动自动配置的 Tomcat Web 服务器。我们需要将 MyApplication.class 作为参数传递给 run 方法，以告诉 SpringApplication 哪个是主要的 Spring 组件。我们还需要传递 args 数组，以显示任何命令行参数。

运行示例

Maven

至此，应用程序应该可以正常运行了。由于你使用了 spring-boot-starter-parent POM，所以你有了一个有用的运行目标，可以用来启动应用程序。在项目根目录下键入 mvn spring-boot:run，启动应用程序。你应该会看到与下面类似的输出：

$ mvn spring-boot:run

  .   ____          _            __ _ _
 /\\ / ___'_ __ _ _(_)_ __  __ _ \ \ \ \
( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \
 \\/  ___)| |_)| | | | | || (_| |  ) ) ) )
  '  |____| .__|_| |_|_| |_\__, | / / / /
 =========|_|==============|___/=/_/_/_/
 :: Spring Boot ::  (v3.2.0)
....... . . .
....... . . . (log output here)
....... . . .
........ Started MyApplication in 0.906 seconds (process running for 6.514)

如果打开浏览器访问 localhost:8080，应该会看到以下输出：

Hello World!

要优雅地退出应用程序，请按 ctrl-c。

Gradle

至此，应用程序应该可以正常运行了。因为使用了 org.springframework.boot Gradle 插件，所以有了一个有用的 bootRun 目标，可以用来启动应用程序。在项目根目录下键入 gradle bootRun 来启动应用程序。您应该会看到与下面类似的输出：

$ gradle bootRun

  .   ____          _            __ _ _
 /\\ / ___'_ __ _ _(_)_ __  __ _ \ \ \ \
( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \
 \\/  ___)| |_)| | | | | || (_| |  ) ) ) )
  '  |____| .__|_| |_|_| |_\__, | / / / /
 =========|_|==============|___/=/_/_/_/
 :: Spring Boot ::  (v3.2.0)
....... . . .
....... . . . (log output here)
....... . . .
........ Started MyApplication in 0.906 seconds (process running for 6.514)

如果打开浏览器访问 localhost:8080，应该会看到以下输出：

Hello World!

要优雅地退出应用程序，请按 ctrl-c。

创建可执行 Jar

最后，我们将创建一个完全独立的可执行 jar 文件，以便在生产中运行。可执行 jar（有时称为 “uber jars” 或 “fat jars”）是包含已编译类以及代码运行所需的所有 jar 依赖项的归档文件。

可执行 jar 和 Java
Java 没有提供加载嵌套 jar 文件（本身包含在一个 jar 中的 jar 文件）的标准方法。如果您想发布一个独立的应用程序，这可能会造成问题。
为了解决这个问题，许多开发人员使用 "uber "jar。uber jar 将应用程序所有依赖项中的所有类都打包到一个压缩包中。这种方法的问题是很难看出应用程序中包含哪些库。如果在多个 jar 中使用相同的文件名（但内容不同），也会造成问题。
Spring Boot 采用了不同的方法，让您可以直接嵌套 jar。

Maven

要创建可执行 jar，我们需要在 pom.xml 中添加 spring-boot-maven-plugin。为此，请在依赖关系部分下方插入以下几行：

<build>
  <plugins>
    <plugin>
      <groupId>org.springframework.bootgroupId>
      <artifactId>spring-boot-maven-pluginartifactId>
    plugin>
  plugins>
build>

spring-boot-starter-parent POM 包含用于绑定repackage goal的 配置。如果不使用父 POM，则需要自行声明此配置。详情请参见插件文档。

保存 pom.xml，然后从命令行运行 mvn package，如下所示：

$ mvn package

[INFO] Scanning for projects...
[INFO]
[INFO] ------------------------------------------------------------------------
[INFO] Building myproject 0.0.1-SNAPSHOT
[INFO] ------------------------------------------------------------------------
[INFO] .... ..
[INFO] --- maven-jar-plugin:2.4:jar (default-jar) @ myproject ---
[INFO] Building jar: /Users/developer/example/spring-boot-example/target/myproject-0.0.1-SNAPSHOT.jar
[INFO]
[INFO] --- spring-boot-maven-plugin:3.2.0:repackage (default) @ myproject ---
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------

在target目录中，你应该能看到 myproject-0.0.1-SNAPSHOT.jar。该文件大小应在 18 MB 左右。如果你想窥探里面的内容，可以使用 jar tvf，如下所示：

$ jar tvf target/myproject-0.0.1-SNAPSHOT.jar

在target目录中，你还会看到一个更小的文件，名为 myproject-0.0.1-SNAPSHOT.jar.original。这是 Maven 在 Spring Boot 重新打包之前创建的原始 jar 文件。
要运行该应用程序，请使用 java -jar 命令，如下所示：

$ java -jar target/myproject-0.0.1-SNAPSHOT.jar

  .   ____          _            __ _ _
 /\\ / ___'_ __ _ _(_)_ __  __ _ \ \ \ \
( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \
 \\/  ___)| |_)| | | | | || (_| |  ) ) ) )
  '  |____| .__|_| |_|_| |_\__, | / / / /
 =========|_|==============|___/=/_/_/_/
 :: Spring Boot ::  (v3.2.0)
....... . . .
....... . . . (log output here)
....... . . .
........ Started MyApplication in 0.999 seconds (process running for 1.253)

和之前一样，要退出应用程序，请按 ctrl-c。

Gradle

要创建可执行 jar，我们需要在命令行中运行 gradle bootJar，如下所示：

$ gradle bootJar

BUILD SUCCESSFUL in 639ms
3 actionable tasks: 3 executed

在 build/libs 目录中，你应该能看到 myproject-0.0.1-SNAPSHOT.jar。该文件大小约为 18 MB。如果你想窥探里面的内容，可以使用 jar tvf，如下所示：

$ jar tvf build/libs/myproject-0.0.1-SNAPSHOT.jar

要运行该应用程序，请使用 java -jar 命令，如下所示：

$ java -jar build/libs/myproject-0.0.1-SNAPSHOT.jar

  .   ____          _            __ _ _
 /\\ / ___'_ __ _ _(_)_ __  __ _ \ \ \ \
( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \
 \\/  ___)| |_)| | | | | || (_| |  ) ) ) )
  '  |____| .__|_| |_|_| |_\__, | / / / /
 =========|_|==============|___/=/_/_/_/
 :: Spring Boot ::  (v3.2.0)
....... . . .
....... . . . (log output here)
....... . . .
........ Started MyApplication in 0.999 seconds (process running for 1.253)

和之前一样，要退出应用程序，请按 ctrl-c。