4.开始使用

如果您刚开始使用 Spring Boot，或者一般的“Spring”，请先阅读本节。它回答了基本的 “什么”、“如何” 和 “为什么” 问题。它包括 Spring Boot 的简介以及安装说明。然后，我们将引导您构建您的第一个 Spring Boot 应用程序，并在此过程中讨论一些核心原则。

4.1 Spring Boot 简介

Spring Boot 可帮助您创建可以运行的基于 Spring 的独立生产级应用程序。我们对 Spring 平台和第三方库持固执己见的看法，因此您可以毫不费力地开始使用。大多数 Spring Boot 应用程序只需要很少的 Spring 配置。

您可以使用 Spring Boot 创建可以使用java -jar或更传统的 war 部署启动的 Java 应用程序。我们还提供了一个运行 “spring scripts” 的命令行工具。

我们的主要目标是：

为所有 Spring 开发提供极其快速且可广泛访问的入门体验。
开箱即用，但当需求开始与默认值不同时，请迅速离开。
提供一系列大型项目通用的非功能性功能（例如嵌入式服务器、安全性、指标、运行状况检查和外部化配置）。
绝对不需要代码生成，也不需要 XML 配置。

4.2 系统要求

Spring Boot 2.7.18 需要 Java 8，并且与 Java 21 兼容。还需要 Spring Framework 5.3.31 或更高版本。

为以下构建工具提供显式构建支持：

构建工具	版本
Maven 系列	3.5+
Gradle	6.8.x、6.9.x、7.x 和 8.x

4.2.1 Servlet 容器

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

名称	Servlet 版本
Tomcat 9.0	4.0
Jetty 9.4	3.1
Jetty 10.0	4.0
Undertow 2.0	4.0

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

4.3 安装 Spring Boot

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

shell

java -version

如果您不熟悉 Java 开发，或者想尝试 Spring Boot，则可能需要先尝试 Spring Boot CLI（命令行界面）。否则，请继续阅读 “经典” 安装说明。

4.3.1 Java 开发人员的安装说明

您可以像使用任何标准 Java 库一样使用 Spring Boot。为此，请在 Classpath 中包含适当的spring-boot-*.jar文件。 Spring Boot 不需要任何特殊的工具集成，因此您可以使用任何 IDE 或文本编辑器。此外，Spring Boot 应用程序没有什么特别之处，因此您可以像运行任何其他 Java 程序一样运行和调试 Spring Boot 应用程序。

尽管您可以复制 Spring Boot jar，但我们通常建议您使用支持依赖项管理的构建工具（例如 Maven 或 Gradle）。

Maven 安装

Spring Boot 与 Apache Maven 3.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，并将依赖项声明给一个或多个 “Starters”。 Spring Boot 还提供了一个可选的 Maven 插件来创建可执行 jar

Gradle 安装

Spring Boot 与 Gradle 6.8、6.9、7.x 和 8.x 兼容。如果您尚未安装 Gradle，可以按照 gradle.org 中的说明进行操作。

Spring Boot 依赖项可以使用 org.springframework.boot group. 通常，您的项目会声明对一个或多个 “Starters” 的依赖关系。 Spring Boot 提供了一个有用的 Gradle 插件，可用于简化依赖项声明和创建可执行 jar

TIP

Gradle 包装器

当您需要构建项目时，Gradle Wrapper 提供了一种 “获取” Gradle 的好方法。它是一个小型脚本和库，您可以将其与代码一起提交，以引导构建过程。有关详细信息，请参阅 docs.gradle.org/current/userguide/gradle_wrapper.html。

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

4.3.2 安装 Spring Boot CLI

Spring Boot CLI（命令行界面）是一个命令行工具，可用于快速使用 Spring 进行原型设计。它允许您运行 Groovy 脚本，这意味着您拥有熟悉的类似 Java 的语法，而无需太多的样板代码。

您不需要使用 CLI 来使用 Spring Boot，但这是在没有 IDE 的情况下启动 Spring 应用程序的快速方法。

手动安装

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

下载后，请按照解压后的存档中的INSTALL.txt说明进行操作。总之，在.zip文件的目录bin/中有一个脚本spring.bat（适用于 Windows）。或者，您也可以使用java -jar运行.jar文件（该脚本可帮助您确保 Classpath 设置正确）

使用 SDKMAN 安装！

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

shell

$ sdk install springboot
$ spring --version
Spring CLI v2.7.18

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

shell

$ sdk install springboot dev /path/to/spring-boot/spring-boot-cli/target/spring-boot-cli-2.7.18-bin/spring-2.7.18/
$ sdk default springboot dev
$ spring --version
Spring CLI v2.7.18

上述说明安装名为dev的spring本地实例。它指向您的目标构建位置，因此每次重新构建 Spring Boot 时，spring 都是最新的

您可以通过运行以下命令来查看它：

shell

$ sdk ls springboot

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

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

OSX Homebrew 安装

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

shell

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

Homebrew 安装spring到/usr/local/bin。

提示

如果您没有看到公式，则您的 brew 安装可能已过期。在这种情况下，请运行brew update并重试。

MacPorts 安装

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

shell

$ sudo port install spring-boot-cli

命令行补全

Spring Boot CLI 包括为 BASH 和 zsh shell 提供命令完成的脚本。您可以在任何 shell 中使用脚本（也称为 spring），也可以将其放在您个人或系统范围的 bash 完成初始化中。在 Debian 系统上，系统范围的脚本都在/shell-completion/bash中，并且该目录中的所有脚本都会在新的 shell 启动时执行。例如，如果已使用 SDKMAN！进行安装，要手动运行脚本，请使用以下命令

shell

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

TIP

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

Windows Scoop 安装

如果您使用的是 Windows 并使用 Scoop，则可以使用以下命令安装 Spring Boot CLI：

shell

scoop bucket add extras
scoop install springboot

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

快速入门 Spring CLI 示例

您可以使用以下 Web 应用程序来测试您的安装。首先，创建一个名为app.groovy的文件，如下所示：

groovy

@RestController
class ThisWillActuallyRun {

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

}

然后从 shell 运行它，如下所示：

shell

$ spring run app.groovy

提示

应用程序的首次运行速度很慢，因为会下载依赖项。后续运行要快得多。

在您喜欢的 Web 浏览器中打开。您应该会看到以下输出：localhost:8080

txt

Hello World!

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

本节介绍如何开发一个小型的 “Hello World！” Web 应用程序，其中重点介绍了 Spring Boot 的一些关键功能。我们使用 Maven 来构建这个项目，因为大多数 IDE 都支持它。

TIP

spring.io Web 站点包含许多使用 Spring Boot 的“入门”指南。如果您需要解决特定问题，请先检查那里。

您可以通过转到 start.spring.io 并从依赖项搜索器中选择 “Web” 启动器来简化以下步骤。这样做会生成一个新的项目结构，以便您可以立即开始编码。有关更多详细信息，请查看 start.spring.io 用户指南。

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

shell

$ java -version
java version "1.8.0_102"
Java(TM) SE Runtime Environment (build 1.8.0_102-b14)
Java HotSpot(TM) 64-Bit Server VM (build 25.102-b14, mixed mode)

shell

$ mvn -v
Apache Maven 3.5.4 (1edded0938998edf8bf061f1ceb3cfdeccf443fe; 2018-06-17T14:33:14-04:00)
Maven home: /usr/local/Cellar/maven/3.3.9/libexec
Java version: 1.8.0_102, vendor: Oracle Corporation

TIP

此示例需要在其自己的目录中创建。后续说明假定您已创建合适的目录，并且它是您的当前目录。

4.4.1 创建 POM

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

xml

<?xml version="1.0" encoding="UTF-8"?>
<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.0</modelVersion>

    <groupId>com.example</groupId>
    <artifactId>myproject</artifactId>
    <version>0.0.1-SNAPSHOT</version>

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.7.18</version>
    </parent>

    <!-- Additional lines to be added here... -->

</project>

前面的清单应该为您提供一个有效的版本。您可以通过运行mvn package来测试它（现在，您可以忽略 “jar will be empty - no content was marked for inclusion！” 警告）。

TIP

此时，您可以将项目导入到 IDE 中（大多数现代 Java IDE 都包含对 Maven 的内置支持）。为简单起见，我们在此示例中继续使用纯文本编辑器。

4.4.2 添加 Classpath 依赖项

SpringBoot提供了许多“Starters”，允许您将jar添加到类路径中。我们用于冒烟测试的应用程序使用POM的parent部分中spring-boot-starter-parent。spring-boot-starter-parent是一个特殊的启动器，提供有用的dependency-management。它还提供了一个依赖项管理部分，以便您可以省略 “blessed” 依赖项的标签。

其他 “Starters” 提供您在开发特定类型的应用程序时可能需要的依赖项。由于我们正在开发 Web 应用程序，因此我们添加了依赖项spring-boot-starter-web。在此之前，我们可以通过运行以下命令来查看我们当前拥有的内容:

shell

$ mvn dependency:tree

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

mvn dependency:tree命令将打印项目依赖项的树表示形式。你可以看到spring-boot-starter-parent本身不提供任何依赖项。要添加必要的依赖项，请编辑pom.xml并在该部分的正下方添加依赖项spring-boot-starter-web

xml

<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
</dependencies>

再次运行mvn dependency:tree，您会看到现在还有许多其他依赖项，包括 Tomcat Web 服务器和 Spring Boot 本身

4.4.3 编写代码

现在，我们需要编写应用程序代码。在项目根目录中创建一个名为src/main/java/com/example/myproject/MyProjectApplication.java的文件，并添加以下代码：

JavaKotlin

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);
    }

}

kotlin

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

@RestController
@SpringBootApplication
class MyApplication {

    @RequestMapping("/")
    fun home() = "Hello World!"

}

fun main(args: Array<String>) {
    runApplication<MyApplication>(*args)
}

虽然这里没有太多代码，但有很多事情要做。在接下来的几节中，我们将逐步介绍重要部分。

@RestController 和 @RequestMapping 注释

类MyApplication的第一个注解是 @RestController. 这称为 stereotype annotation。它为阅读代码的人和 Spring 提供了提示，表明类起着特定的作用。在这种情况下，我们的类是 Controller ，因此 Spring 在处理传入的 Web 请求时会考虑它。

注解@RequestMapping提供路由信息。它告诉 Spring 任何带有/路径的 HTTP 请求都应该映射到home方法。 @RestController告诉 Spring 将结果字符串直接呈现给调用者。

TIP

@RestController和@RequestMapping是 Spring MVC 注解（它们不是特定于 Spring Boot的）。有关更多详细信息，请参阅 Spring 参考文档中的 MVC 部分。

@SpringBootApplication 注解

第二个类级注解是@SpringBootApplication. 此注释称为元注释，它结合了@SpringBootConfiguration、@EnableAutoConfiguration和 @ComponentScan。

其中，我们在这里最感兴趣的注释是@EnableAutoConfiguration 。 @EnableAutoConfiguration告诉 Spring Boot 根据您添加的 jar 依赖项“猜测”您希望如何配置 Spring。由于spring-boot-starter-web添加了 Tomcat 和 Spring MVC，因此自动配置假定您正在开发 Web 应用程序并相应地设置 Spring。

TIP

启动器和自动配置

自动配置旨在与 “Starters” 很好地配合，但这两个概念并没有直接联系在一起。您可以在 starter 之外自由挑选 jar 依赖项。 Spring Boot 仍然尽最大努力自动配置您的应用程序。

main 方法

应用程序的最后一部分是main 方法。这是遵循应用程序入口点的 Java 约定的标准方法。我们的 main 方法通过调用SpringApplication的run方法 . SpringApplication 引导我们的应用程序，启动 Spring，而 Spring 又启动自动配置的 Tomcat Web 服务器。我们需要将MyApplication.class作为参数传递给run方法，以判断哪个是主要的 Spring 组件。 args数组也被传递以公开任何命令行参数。

4.4.4 运行示例

此时，您的应用程序应该可以正常工作。由于您使用了spring-boot-starter-parentPOM，因此您有一个有用的目标，可用于启动应用程序。键入mvn spring-boot:run以启动应用程序。您应该会看到类似于以下内容的输出：

shell

$ mvn spring-boot:run

  .   ____          _            __ _ _
 /\\ / ___'_ __ _ _(_)_ __  __ _ \ \ \ \
( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \
 \\/  ___)| |_)| | | | | || (_| |  ) ) ) )
  '  |____| .__|_| |_|_| |_\__, | / / / /
 =========|_|==============|___/=/_/_/_/
 :: Spring Boot ::  (v2.7.18)
....... . . .
....... . . . (log output here)
....... . . .
........ Started MyApplication in 2.222 seconds (JVM running for 6.514)

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

txt

Hello World!

要正常退出应用程序，请按ctrl+c。

4.4.5 创建可执行的 JAR

我们通过创建一个完全独立的可执行 jar 文件来完成我们的示例，我们可以在生产环境中运行该文件。可执行 jar（有时称为“胖 jar”）是包含已编译类以及代码运行所需的所有 jar 依赖项的存档。

TIP

可执行 jar 和 Java

Java 没有提供加载嵌套 jar 文件（本身包含在 jar 中的 jar 文件）的标准方法。如果您希望分发一个独立的应用程序，这可能会有问题。

为了解决这个问题，许多开发人员使用 “uber” jar。一个 uber jar 将应用程序的所有依赖项中的所有类打包到一个存档中。这种方法的问题在于，很难看到应用程序中有哪些库。如果在多个 jar 中使用相同的文件名（但内容不同），也可能出现问题。

Spring Boot 采用不同的方法，让您实际上直接嵌套 jar。

要创建可执行 jar，我们需要将spring-boot-maven-plugin添加到我们的pom.xml. 为此，请在dependencies 部分的正下方插入以下行:

xml

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

TIP

spring-boot-starter-parentPOM 包含<executions>用于绑定repackage 目标的配置。如果不使用父 POM，则需要自己声明此配置。有关详细信息，请参阅插件文档。

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

shell

$ 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:2.7.18:repackage (default) @ myproject ---
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------

如果查看target目录，您应该会看到myproject-0.0.1-SNAPSHOT.jar 。文件大小应约为 18 MB。如果要窥视内部，可以使用 jar tvf，如下所示

shell

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

您还应该看到一个名为myproject-0.0.1-SNAPSHOT.jar.original 的 target 中小得多的文件。这是 Maven 在 Spring Boot 重新打包之前创建的原始 jar 文件

要运行该应用程序，请使用以下命令java -jar

shell

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

  .   ____          _            __ _ _
 /\\ / ___'_ __ _ _(_)_ __  __ _ \ \ \ \
( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \
 \\/  ___)| |_)| | | | | || (_| |  ) ) ) )
  '  |____| .__|_| |_|_| |_\__, | / / / /
 =========|_|==============|___/=/_/_/_/
 :: Spring Boot ::  (v2.7.18)
....... . . .
....... . . . (log output here)
....... . . .
........ Started MyApplication in 2.536 seconds (JVM running for 2.864)

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

4.5 下一步要读什么

希望本节提供了一些 Spring Boot 基础知识，并帮助您编写自己的应用程序。如果你是一个面向任务的开发人员类型，你可能想跳到 spring.io 并遵循一些解决特定 “如何使用 Spring 实现该操作 ”问题的入门指南。我们还有特定于 Spring Boot 的 “How-to” 参考文档。

否则，下一个逻辑步骤是阅读 Developing with Spring Boot。如果你真的没有耐心，你也可以跳到前面阅读 Spring Boot 功能。

4.开始使用 ​

4.1 Spring Boot 简介 ​

4.2 系统要求 ​

4.2.1 Servlet 容器 ​

4.3 安装 Spring Boot ​

4.3.1 Java 开发人员的安装说明 ​

Maven 安装 ​

Gradle 安装 ​

Gradle 包装器 ​

4.3.2 安装 Spring Boot CLI ​

手动安装 ​

使用 SDKMAN 安装！ ​

OSX Homebrew 安装 ​

MacPorts 安装 ​

命令行补全 ​

Windows Scoop 安装 ​

快速入门 Spring CLI 示例 ​

4.4 开发您的第一个 Spring Boot 应用程序 ​

4.4.1 创建 POM ​

4.4.2 添加 Classpath 依赖项 ​

4.4.3 编写代码 ​

@RestController 和 @RequestMapping 注释 ​

@SpringBootApplication 注解 ​

启动器和自动配置 ​

main 方法 ​

4.4.4 运行示例 ​

4.4.5 创建可执行的 JAR ​

可执行 jar 和 Java ​

4.5 下一步要读什么 ​

4.开始使用

4.1 Spring Boot 简介

4.2 系统要求

4.2.1 Servlet 容器

4.3 安装 Spring Boot

4.3.1 Java 开发人员的安装说明

Maven 安装

Gradle 安装

Gradle 包装器

4.3.2 安装 Spring Boot CLI

手动安装

使用 SDKMAN 安装！

OSX Homebrew 安装

MacPorts 安装

命令行补全

Windows Scoop 安装

快速入门 Spring CLI 示例

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

4.4.1 创建 POM

4.4.2 添加 Classpath 依赖项

4.4.3 编写代码

@RestController 和 @RequestMapping 注释

@SpringBootApplication 注解

启动器和自动配置

main 方法

4.4.4 运行示例

4.4.5 创建可执行的 JAR

可执行 jar 和 Java

4.5 下一步要读什么