SpringBoot开发入门

文章来源：开发您的第一个 Spring Boot 应用程序 (Developing Your First Spring Boot Application) _ Spring Boot3.4.0中文文档(官方文档中文翻译)|Spring 教程 —— CADN开发者文档中心

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

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

您可以通过转到 start.spring.io 并从依赖项搜索器中选择 “Web” Starters来简化以下步骤。 这样做会生成一个新的项目结构，以便您可以立即开始编码。 有关更多详细信息，请查看 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) Copied! 此示例需要在其自己的目录中创建。 后续说明假定您已创建合适的目录，并且它是您的当前目录。 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 Copied! 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 Copied! 使用 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:// .w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 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.0</version> </parent> <!-- Additional lines to be added here... --> </project> Copied!

前面的清单应该为您提供一个有效的版本。

您可以通过运行mvn package（现在，您可以忽略 “jar will be empty - no content was marked for inclusion！” 警告）。

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

我们需要从创建一个 Gradle 开始build.gradle文件。 这build.gradle是用于生成项目的生成脚本。 打开您最喜欢的文本编辑器并添加以下内容：

plugins { id 'java' id 'org.springframework.boot' version '3.4.0' } apply plugin: 'io.spring.dependency-management' group = 'com.example' version = '0.0.1-SNAPSHOT' sourceCompatibility = '17' repositories { mavenCentral() } dependencies { } Copied!

前面的清单应该为您提供一个有效的版本。 您可以通过运行gradle classes.

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

Spring Boot 提供了许多Starters，允许您将 jar 添加到 Classpath 中。 Starters 提供在开发特定类型的应用程序时可能需要的依赖项。

Maven 系列

大多数 Spring Boot 应用程序都使用spring-boot-starter-parent在parent部分。 这spring-boot-starter-parent是一个特殊的Starters，它提供有用的 Maven 默认值。 它还提供了一个dependency-management部分，以便您可以省略version标记中。

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

$ mvn dependency:tree [INFO] com.example:myproject:jar:0.0.1-SNAPSHOT Copied!

这mvn dependency:treecommand 打印项目依赖项的树表示形式。 你可以看到spring-boot-starter-parent本身不提供任何依赖项。 要添加必要的依赖项，请编辑pom.xml并添加spring-boot-starter-web依赖项紧邻parent部分：

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

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

Gradle

大多数 Spring Boot 应用程序都使用org.springframework.bootGradle 插件。 此插件提供有用的默认值和 Gradle 任务。 这io.spring.dependency-managementGradle 插件提供依赖项管理，因此您可以省略version标记中。

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

$ gradle dependencies > Task :dependencies ------------------------------------------------------------ Root project 'myproject' ------------------------------------------------------------ Copied!

这gradle dependenciescommand 打印项目依赖项的树表示形式。 目前，该项目没有依赖项。 要添加必要的依赖项，请编辑build.gradle并添加spring-boot-starter-webdependency 在dependencies部分：

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

如果您运行gradle dependencies同样，您会看到现在还有许多额外的依赖项，包括 Tomcat Web 服务器和 Spring Boot 本身。

编写代码

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

Java

Kotlin

@RestController @SpringBootApplication public class MyApplication { @RequestMapping("/") String home() { return "Hello World!"; } public static void main(String[] args) { SpringApplication.run(MyApplication.class, args); } } Copied!

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

@RestController 和 @RequestMapping 注释

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

这@RequestMappingannotation 提供 “routing” 信息。 它告诉 Spring，任何具有该路径的 HTTP 请求都应该映射到/home方法。 这@RestControllerannotation 告诉 Spring 将结果字符串直接渲染回给调用者。

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

第二个类级注解是@SpringBootApplication. 这个注解被称为元注解，它结合了@SpringBootConfiguration,@EnableAutoConfiguration和@ComponentScan.

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

Starters和自动配置

Auto-configuration 旨在与 starter 配合使用，但这两个概念并不直接相关。 您可以在 starter 之外自由挑选 jar 依赖项。 Spring Boot 仍然尽最大努力自动配置您的应用程序。

“main” 方法

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

运行示例 Maven 系列

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

$ mvn spring-boot:run . ____ _ __ _ _ /\\ / ___'_ __ _ _(_)_ __ __ _ \ \ \ \ ( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \ \\/ ___)| |_)| | | | | || (_| | ) ) ) ) ' |____| .__|_| |_|_| |_\__, | / / / / =========|_|==============|___/=/_/_/_/ :: Spring Boot :: (v3.4.0) ....... . . . ....... . . . (log output here) ....... . . . ........ Started MyApplication in 0.906 seconds (process running for 6.514) Copied!

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

Hello World! Copied!

要正常退出应用程序，请按ctrl-c.

Gradle

此时，您的应用程序应该可以正常工作。 由于您使用了org.springframework.bootGradle 插件，您有一个有用的bootRun目标，您可以使用该目标来启动应用程序。 类型gradle bootRun以启动应用程序。 您应该会看到类似于以下内容的输出：

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

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

Hello World! Copied!

要正常退出应用程序，请按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，我们需要添加spring-boot-maven-plugin到我们的pom.xml. 为此，请在dependencies部分：

<build> <plugins> <plugin> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-maven-plugin</artifactId> </plugin> </plugins> </build> Copied! 这spring-boot-starter-parentPOM 包括<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.0:repackage (default) @ myproject --- [INFO] ------------------------------------------------------------------------ [INFO] BUILD SUCCESS [INFO] ------------------------------------------------------------------------ Copied!

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

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

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

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

$ java -jar target/myproject-0.0.1-SNAPSHOT.jar . ____ _ __ _ _ /\\ / ___'_ __ _ _(_)_ __ __ _ \ \ \ \ ( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \ \\/ ___)| |_)| | | | | || (_| | ) ) ) ) ' |____| .__|_| |_|_| |_\__, | / / / / =========|_|==============|___/=/_/_/_/ :: Spring Boot :: (v3.4.0) ....... . . . ....... . . . (log output here) ....... . . . ........ Started MyApplication in 0.999 seconds (process running for 1.253) Copied!

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

Gradle

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

$ gradle bootJar BUILD SUCCESSFUL in 639ms 3 actionable tasks: 3 executed Copied!

如果您查看build/libs目录中，您应该会看到myproject-0.0.1-SNAPSHOT.jar. 文件大小应约为 18 MB。 如果你想窥视内部，你可以使用jar tvf如下：

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

要运行该应用程序，请使用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) Copied!

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