跳到主要内容

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

DeepSeek V3 中英对照 Developing Your First Spring Boot Application

本节将介绍如何开发一个简单的“Hello World!” Web 应用程序，该程序展示了 Spring Boot 的一些关键特性。你可以选择使用 Maven 或 Gradle 作为构建系统。

提示

spring.io 网站包含许多使用 Spring Boot 的“入门”指南。如果你需要解决一个特定的问题，可以先在这里查找。

你可以通过访问 start.spring.io 并从依赖项搜索器中选择“Web”启动器来简化以下步骤。这样做将生成一个新的项目结构，以便你可以立即开始编码。有关更多详细信息，请查看 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)
shell
备注

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

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
shell

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
shell

使用 Maven 设置项目​

我们需要从创建一个 Maven pom.xml 文件开始。pom.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>3.4.2</version>
    </parent>

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

</project>
xml

前面的代码清单应该可以为你提供一个可用的构建。

你可以通过运行 mvn package 来测试它（目前，你可以忽略“jar 将会是空的 - 没有内容被标记为包含！”的警告）。

备注

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

使用 Gradle 设置项目​

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

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

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

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

repositories {
    mavenCentral()
}

dependencies {
}
gradle

前面的清单应该能为您提供一个可用的构建。您可以通过运行 gradle classes 来测试它。

备注

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

添加类路径依赖​

Spring Boot 提供了许多启动器，允许你将 jar 包添加到你的类路径中。这些启动器提供了在开发特定类型应用程序时可能需要的依赖项。

Maven​

大多数 Spring Boot 应用程序在 POM 的 parent 部分使用 spring-boot-starter-parent。spring-boot-starter-parent 是一个特殊的 starter，它提供了有用的 Maven 默认配置。它还提供了一个 依赖管理 部分，因此你可以为“受支持”的依赖项省略 version 标签。

由于我们正在开发一个 Web 应用程序，因此我们添加了 spring-boot-starter-web 依赖项。在此之前，我们可以通过运行以下命令来查看当前已有的内容：

$ mvn dependency:tree

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

mvn dependency:tree 命令会打印出项目依赖的树状结构。你可以看到 spring-boot-starter-parent 本身并不提供任何依赖。要添加必要的依赖，编辑你的 pom.xml 文件，并在 parent 部分下方添加 spring-boot-starter-web 依赖：

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

如果你再次运行 mvn dependency:tree，你会看到现在有许多额外的依赖项，包括 Tomcat 服务器和 Spring Boot 本身。

Gradle​

大多数 Spring Boot 应用程序都会使用 org.springframework.boot Gradle 插件。该插件提供了有用的默认设置和 Gradle 任务。io.spring.dependency-management Gradle 插件提供了 依赖管理 功能，因此你可以省略“受支持”依赖的 version 标签。

由于我们正在开发一个 Web 应用程序，因此我们添加了 spring-boot-starter-web 依赖。在此之前，我们可以通过运行以下命令来查看当前已有的依赖：

$ gradle dependencies

> Task :dependencies

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

gradle dependencies 命令会打印出项目依赖的树状结构。目前，项目还没有任何依赖。要添加必要的依赖，请编辑 build.gradle 文件，并在 dependencies 部分中添加 spring-boot-starter-web 依赖：

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

如果你再次运行 gradle dependencies，你会看到现在有许多额外的依赖项，包括 Tomcat Web 服务器和 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);
    }

}
java

虽然这里的代码不多，但其中发生了很多事情。我们将在接下来的几节中逐步介绍重要的部分。

@RestController 和 @RequestMapping 注解​

在我们的 MyApplication 类上的第一个注解是 @RestController。这被称为一个 stereotype 注解。它为阅读代码的人以及 Spring 提供了提示，表明这个类扮演了特定的角色。在这种情况下，我们的类是一个网络 @Controller，因此 Spring 在处理传入的网络请求时会考虑它。

@RequestMapping 注解提供了“路由”信息。它告诉 Spring 任何带有 / 路径的 HTTP 请求都应该映射到 home 方法。@RestController 注解则告诉 Spring 将生成的字符串直接返回给调用者。

提示

@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。

启动器与自动配置

自动配置的设计初衷是与启动器良好配合，但这两个概念并非直接绑定。你可以自由选择启动器之外的 jar 依赖。Spring Boot 仍会尽力自动配置你的应用程序。

“main” 方法​

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

运行示例​

Maven​

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

$ mvn spring-boot:run

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

如果你在浏览器中打开 [localhost:8080](http://localhost:8080)，你应该会看到如下输出：

Hello World!
none

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

Gradle​

此时，你的应用程序应该可以正常运行了。由于你使用了 org.springframework.boot Gradle 插件，你可以利用一个有用的 bootRun 目标来启动应用程序。在项目的根目录下输入 gradle bootRun 即可启动应用程序。你应该会看到类似于以下内容的输出：

$ gradle bootRun

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

如果你打开一个网页浏览器并访问 [localhost:8080](http://localhost:8080)，你应该会看到以下输出：

Hello World!
none

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

创建可执行的 Jar 文件​

我们通过创建一个完全自包含的可执行 jar 文件来结束我们的示例，该文件可以在生产环境中运行。可执行 jar 文件（有时称为“uber jar”或“fat jar”）是包含您编译的类以及您的代码运行所需的所有 jar 依赖项的归档文件。

可执行的 JAR 文件和 Java

Java 并没有提供一种标准的方式来加载嵌套的 JAR 文件（即包含在另一个 JAR 文件中的 JAR 文件）。如果你想要分发一个自包含的应用程序，这可能会带来问题。

为了解决这个问题，许多开发者使用“uber” JAR。一个 uber JAR 会将所有应用程序依赖的类打包到一个单独的归档文件中。这种方法的缺点是，很难查看应用程序中包含了哪些库。如果在多个 JAR 文件中使用了相同的文件名（但内容不同），这也可能会带来问题。

Spring Boot 采取了一种不同的方法，它允许你直接嵌套 JAR 文件。

Maven​

要创建一个可执行的 jar 文件，我们需要在 pom.xml 中添加 spring-boot-maven-plugin。为此，只需在 dependencies 部分下方插入以下代码：

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

spring-boot-starter-parent POM 包含了 <executions> 配置，用于绑定 repackage 目标。如果你不使用父 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.4.2:repackage (default) @ myproject ---
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
shell

如果你查看 target 目录，你应该会看到 myproject-0.0.1-SNAPSHOT.jar。这个文件的大小应该在 18 MB 左右。如果你想查看其中的内容，可以使用 jar tvf 命令，如下所示：

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

你还应该在 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.4.2)
....... . . .
....... . . . (log output here)
....... . . .
........ Started MyApplication in 0.999 seconds (process running for 1.253)
shell

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

Gradle​

要创建一个可执行的 JAR 文件，我们需要从命令行运行 gradle bootJar，如下所示：

$ gradle bootJar

BUILD SUCCESSFUL in 639ms
3 actionable tasks: 3 executed
shell

如果你查看 build/libs 目录，你应该会看到 myproject-0.0.1-SNAPSHOT.jar 文件。这个文件的大小大约在 18 MB 左右。如果你想查看其中的内容，可以使用 jar tvf 命令，如下所示：

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

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

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

  .   ____          _            __ _ _
 /\\ / ___'_ __ _ _(_)_ __  __ _ \ \ \ \
( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \
 \\/  ___)| |_)| | | | | || (_| |  ) ) ) )
  '  |____| .__|_| |_|_| |_\__, | / / / /
 =========|_|==============|___/=/_/_/_/
 :: Spring Boot ::  (v{version-spring-boot})
....... . . .
....... . . . (log output here)
....... . . .
........ Started MyApplication in 0.999 seconds (process running for 1.253)
shell

如前所述，要退出应用程序，请按 ctrl-c。