开始

1. Spring Boot 简介

Spring Boot 可帮助您创建可以运行的独立的、基于生产级的基于 Spring 的应用程序。 我们对 Spring 平台和第三方库持约定优于配置的方式,因此您可以毫不费力地开始使用。 大多数 Spring Boot 应用程序只需要很少的 Spring 配置。spring-doc.cadn.net.cn

您可以使用 Spring Boot 创建可以通过以下方式启动的 Java 应用程序java -jar或更传统的战争部署。 我们还提供了一个运行“spring scripts”的命令行工具。spring-doc.cadn.net.cn

我们的主要目标是:spring-doc.cadn.net.cn

  • 为所有 Spring 开发提供更快且可广泛访问的入门体验。spring-doc.cadn.net.cn

  • 开箱即用固执己见,但当需求开始与默认值背道而驰时,请尽快让开。spring-doc.cadn.net.cn

  • 提供大型项目通用的一系列非功能性功能(例如嵌入式服务器、安全性、指标、运行状况检查和外部化配置)。spring-doc.cadn.net.cn

  • 绝对无需生成代码,也不需要 XML 配置。spring-doc.cadn.net.cn

2. 系统要求

Spring Boot 2.7.18 需要 Java 8,并且与 Java 21 兼容。还需要 Spring Framework 5.3.31 或更高版本。spring-doc.cadn.net.cn

为以下生成工具提供显式生成支持:spring-doc.cadn.net.cn

构建工具 版本

专家spring-doc.cadn.net.cn

3.5+spring-doc.cadn.net.cn

Gradlespring-doc.cadn.net.cn

6.8.x、6.9.x、7.x 和 8.xspring-doc.cadn.net.cn

2.1. Servlet 容器

Spring Boot 支持以下嵌入式 servlet 容器:spring-doc.cadn.net.cn

名称 Servlet 版本

Tomcat 9.0spring-doc.cadn.net.cn

4.0spring-doc.cadn.net.cn

Jetty 9.4spring-doc.cadn.net.cn

3.1spring-doc.cadn.net.cn

Jetty 10.0spring-doc.cadn.net.cn

4.0spring-doc.cadn.net.cn

暗流 2.0spring-doc.cadn.net.cn

4.0spring-doc.cadn.net.cn

您还可以将 Spring Boot 应用程序部署到任何 Servlet 3.1 或 4.0 兼容容器。spring-doc.cadn.net.cn

3. 安装 Spring Boot

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

$ java -version

如果您是 Java 开发新手,或者想要尝试 Spring Boot,则可能需要先尝试 Spring Boot CLI(命令行界面)。 否则,请继续阅读“经典”安装说明。spring-doc.cadn.net.cn

3.1. Java 开发人员的安装说明

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

尽管您可以复制 Spring Boot jar,但我们通常建议您使用支持依赖管理的构建工具(例如 Maven 或 Gradle)。spring-doc.cadn.net.cn

3.1.1. Maven 安装

Spring Boot 与 Apache Maven 3.3 或更高版本兼容。如果您尚未安装 Maven,可以按照 maven.apache.org 中的说明进行作。spring-doc.cadn.net.cn

在许多作系统上,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。spring-doc.cadn.net.cn

有关 Spring Boot 和 Maven 入门的更多详细信息,请参阅 Maven 插件参考指南的入门部分spring-doc.cadn.net.cn

3.1.2. Gradle 安装

Spring Boot 与 Gradle 6.8、6.9、7.x 和 8.x 兼容。 如果您尚未安装 Gradle,可以按照 gradle.org 中的说明进行作。spring-doc.cadn.net.cn

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

Gradle 包装器

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

有关 Spring Boot 和 Gradle 入门的更多详细信息,请参阅 Gradle 插件参考指南的入门部分spring-doc.cadn.net.cn

3.2. 安装 Spring Boot CLI

Spring Boot CLI(命令行界面)是一个命令行工具,您可以使用它来快速构建 Spring 原型。它允许您运行 Groovy 脚本,这意味着您拥有熟悉的类似 Java 的语法,而无需太多样板代码。spring-doc.cadn.net.cn

您不需要使用 CLI 来使用 Spring Boot,但这是在没有 IDE 的情况下启动 Spring 应用程序的快速方法。spring-doc.cadn.net.cn

3.2.1. 手动安装

您可以从以下位置之一下载 Spring CLI 发行版:spring-doc.cadn.net.cn

下载后,按照解压存档中的INSTALL.txt说明进行作。总之,有一个spring脚本 (spring.bat对于 Windows)在bin/目录中的.zip文件。 或者,您可以使用java -jar使用.jar文件(该脚本可帮助您确保类路径设置正确)。spring-doc.cadn.net.cn

3.2.2. 使用 SDK 安装!

SDKMAN!(软件开发工具包管理器)可用于管理各种二进制 SDK 的多个版本,包括 Groovy 和 Spring Boot CLI。 获取 SDKMAN!从 sdkman.io 并使用以下命令安装 Spring Boot:spring-doc.cadn.net.cn

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

如果您为 CLI 开发功能并希望访问您构建的版本,请使用以下命令:spring-doc.cadn.net.cn

$ 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

上述说明安装spring称为dev实例。 它指向您的目标构建位置,因此每次重新构建 Spring Boot 时,spring是最新的。spring-doc.cadn.net.cn

您可以通过运行以下命令来查看它:spring-doc.cadn.net.cn

$ sdk ls springboot

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

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

3.2.3. OSX Homebrew 安装

如果您使用的是 Mac 并使用 Homebrew,则可以使用以下命令安装 Spring Boot CLI:spring-doc.cadn.net.cn

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

自制安装spring/usr/local/bin.spring-doc.cadn.net.cn

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

3.2.4. MacPorts 安装

如果您使用的是 Mac 并使用 MacPorts,则可以使用以下命令安装 Spring Boot CLI:spring-doc.cadn.net.cn

$ sudo port install spring-boot-cli

3.2.5. 命令行补全

Spring Boot CLI 包括为 BASHzsh shell 提供命令完成的脚本。 您可以source脚本(也称为spring) 在任何 shell 中,或者将其放入您的个人或系统范围的 bash 完成初始化中。 在 Debian 系统上,系统范围的脚本位于/shell-completion/bash并且该目录中的所有脚本都会在新 shell 启动时执行。 例如,如果您已使用 SDKMAN! 安装,则要手动运行脚本,请使用以下命令:spring-doc.cadn.net.cn

$ . ~/.sdkman/candidates/springboot/current/shell-completion/bash/spring
$ spring <HIT TAB HERE>
  grab  help  jar  run  test  version
如果使用 Homebrew 或 MacPorts 安装 Spring Boot CLI,则命令行完成脚本会自动注册到 shell 中。

3.2.6. Windows Scoop 安装

如果您使用的是 Windows 并使用 Scoop,则可以使用以下命令安装 Spring Boot CLI:spring-doc.cadn.net.cn

> scoop bucket add extras
> scoop install springboot

独家新闻安装spring~/scoop/apps/springboot/current/bin.spring-doc.cadn.net.cn

如果未看到应用清单,则 scoop 的安装可能已过期。 在这种情况下,请运行scoop update然后重试。

3.2.7. 快速入门 Spring CLI 示例

您可以使用以下 Web 应用程序来测试您的安装。 首先,创建一个名为app.groovy如下:spring-doc.cadn.net.cn

@RestController
class ThisWillActuallyRun {

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

}

然后从 shell 运行它,如下所示:spring-doc.cadn.net.cn

$ spring run app.groovy
应用程序的首次运行速度很慢,因为依赖项是下载的。 后续运行要快得多。

打开localhost:8080在您最喜欢的网络浏览器中。 您应该会看到以下输出:spring-doc.cadn.net.cn

Hello World!

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

本节介绍如何开发一个小型的“Hello World!” Web 应用程序,该应用程序突出显示了 Spring Boot 的一些关键功能。 我们使用 Maven 来构建这个项目,因为大多数 IDE 都支持它。spring-doc.cadn.net.cn

spring.io 网站包含许多使用 Spring Boot 的“入门”指南。 如果您需要解决特定问题,请先检查那里。spring-doc.cadn.net.cn

您可以通过转到 start.spring.io 并从依赖项搜索器中选择“Web”Starters来快捷执行以下步骤。 这样做会生成一个新的项目结构,以便您可以立即开始编码。 有关详细信息,请查看 start.spring.io 用户指南spring-doc.cadn.net.cn

在开始之前,请打开终端并运行以下命令以确保您安装了有效版本的 Java 和 Maven:spring-doc.cadn.net.cn

$ 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)
$ 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
此示例需要在其自己的目录中创建。 后续说明假定您已经创建了一个合适的目录,并且它是您当前的目录。

4.1. 创建 POM

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

<?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 将为空 - 没有内容被标记为包含!spring-doc.cadn.net.cn

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

4.2. 添加类路径依赖项

Spring Boot 提供了许多“Starters”,可让您将 jar 添加到类路径中。 我们的烟雾测试应用程序使用spring-boot-starter-parentparent部分。 这spring-boot-starter-parent是一个特殊的Starters,它提供了有用的 Maven 默认值。 它还提供了一个dependency-management部分,以便您可以省略version标签来表示“祝福”依赖项。spring-doc.cadn.net.cn

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

$ 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紧接在parent部分:spring-doc.cadn.net.cn

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

如果您运行mvn dependency:tree同样,您会看到现在有许多额外的依赖项,包括 Tomcat Web 服务器和 Spring Boot 本身。spring-doc.cadn.net.cn

4.3. 编写代码

要完成我们的应用程序,我们需要创建一个 Java 文件。 默认情况下,Maven 从src/main/java,因此您需要创建该目录结构,然后添加一个名为src/main/java/MyApplication.java以包含以下代码:spring-doc.cadn.net.cn

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

虽然这里没有太多代码,但正在发生很多事情。 我们将在接下来的几节中逐步介绍重要部分。spring-doc.cadn.net.cn

4.3.1. @RestController和@RequestMapping注解

我们的第一个注释MyApplicationclass 是@RestController. 这称为构造型注释。 它为阅读代码的人和 Spring 提供了类扮演特定角色的提示。 在这种情况下,我们的类是一个网络@Controller,因此 Spring 在处理传入的 Web 请求时会考虑它。spring-doc.cadn.net.cn

@RequestMapping注释提供“路由”信息。 它告诉 Spring 任何具有路径的 HTTP 请求都应映射到/home方法。 这@RestController注释告诉 Spring 将生成的字符串直接渲染回调用者。spring-doc.cadn.net.cn

@RestController@RequestMapping注释是 Spring MVC 注释(它们不是特定于 Spring Boot 的)。 有关更多详细信息,请参阅 Spring 参考文档中的 MVC 部分

4.3.2. @SpringBootApplication注解

第二个类级注释是@SpringBootApplication. 此注释称为元注释,它结合了@SpringBootConfiguration,@EnableAutoConfiguration@ComponentScan.spring-doc.cadn.net.cn

其中,我们在这里最感兴趣的注释是@EnableAutoConfiguration.@EnableAutoConfiguration告诉 Spring Boot 根据您添加的 jar 依赖项“猜测”您想要如何配置 Spring。 因为spring-boot-starter-web添加了 Tomcat 和 Spring MVC,自动配置假设您正在开发一个 Web 应用程序并相应地设置 Spring。spring-doc.cadn.net.cn

Starters和自动配置

自动配置旨在与“Starters”很好地配合使用,但这两个概念并没有直接联系在一起。 您可以自由选择Starters之外的 jar 依赖项。 Spring Boot 仍然会尽最大努力自动配置您的应用程序。spring-doc.cadn.net.cn

4.3.3. “main”方法

我们应用程序的最后一部分是main方法。 这是一种遵循应用程序入口点的 Java 约定的标准方法。 我们的主要方法委托给 Spring Boot 的SpringApplication类通过调用run.SpringApplication引导我们的应用程序,启动 Spring,而 Spring 又启动自动配置的 Tomcat Web 服务器。 我们需要通过MyApplication.class作为参数run讲述方法SpringApplication这是主要的 Spring 组件。 这argsarray 也会被传递以公开任何命令行参数。spring-doc.cadn.net.cn

4.4. 运行示例

此时,您的应用程序应该可以工作。 由于您使用了spring-boot-starter-parentPOM,你有一个有用的run可用于启动应用程序的目标。 类型mvn spring-boot:run从根项目目录启动应用程序。 您应该会看到类似于以下内容的输出:spring-doc.cadn.net.cn

$ 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,您应该会看到以下输出:spring-doc.cadn.net.cn

Hello World!

要正常退出应用程序,请按ctrl-c.spring-doc.cadn.net.cn

4.5. 创建可执行的 Jar

我们通过创建一个完全独立的可执行 jar 文件来完成我们的示例,我们可以在生产中运行该文件。 可执行 jar(有时称为“胖 jar”)是包含已编译的类以及代码运行所需的所有 jar 依赖项的存档。spring-doc.cadn.net.cn

可执行 jar 和 Java

Java 没有提供加载嵌套 jar 文件(本身包含在 jar 中的 jar 文件)的标准方法。 如果您希望分发一个独立的应用程序,这可能会有问题。spring-doc.cadn.net.cn

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

Spring Boot 采用了不同的方法,允许您直接嵌套 jar。spring-doc.cadn.net.cn

要创建一个可执行的 jar,我们需要将spring-boot-maven-plugin到我们的pom.xml. 为此,请在dependencies部分:spring-doc.cadn.net.cn

<build>
    <plugins>
        <plugin>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-maven-plugin</artifactId>
        </plugin>
    </plugins>
</build>
spring-boot-starter-parentPOM 包括<executions>配置以绑定repackage目标。 如果您不使用父 POM,则需要自己声明此配置。 有关详细信息,请参阅插件文档

保存您的pom.xml并运行mvn package从命令行中,如下所示:spring-doc.cadn.net.cn

$ 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如下:spring-doc.cadn.net.cn

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

您还应该看到一个名为myproject-0.0.1-SNAPSHOT.jar.originaltarget目录。 这是 Maven 在被 Spring Boot 重新打包之前创建的原始 jar 文件。spring-doc.cadn.net.cn

要运行该应用程序,请使用java -jar命令,如下所示:spring-doc.cadn.net.cn

$ 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.spring-doc.cadn.net.cn

5. 接下来要读什么

希望本节提供了一些 Spring Boot 基础知识,并帮助您编写自己的应用程序。 如果你是一个面向任务的开发人员,你可能想跳转到 spring.io 并遵循一些解决特定“如何使用 Spring 做到这一点”问题的入门指南。 我们还有特定于 Spring Boot 的“作方法”参考文档。spring-doc.cadn.net.cn

否则,下一个合乎逻辑的步骤是读取using.html。 如果您真的不耐烦,也可以跳到前面阅读有关 Spring Boot 功能的信息。spring-doc.cadn.net.cn