|
此版本仍在开发中,尚未视为稳定版。如需最新稳定版本,请使用 Spring Boot 4.0.4! |
开发您的第一个Spring Boot应用程序
此部分描述了如何开发一个小型“Hello World!”网络应用程序,以突出展示一些Spring Boot的关键功能。 您可以选择Maven或Gradle作为构建系统。
|
你可以通过访问 start.spring.io 并在依赖项搜索器中选择“Web”Starters来跳过以下步骤。 这样会生成一个新的项目结构,让你可以立即开始编码。 更多详细信息,请查看start.spring.io 用户指南。 |
前置条件
在开始之前,请打开终端并运行以下命令以确保您安装了有效的Java版本:
$ java -version
openjdk version "17.0.18" 2026-01-20 LTS
OpenJDK Runtime Environment (build 17.0.18+10-LTS)
OpenJDK 64-Bit Server VM (build 17.0.18+10-LTS, mixed mode, sharing)
| 此示例需要在独立的目录中创建。 后续说明假设您已创建了合适的目录并且当前位于该目录。 |
Maven
如果您想使用 Maven,请确保已经安装了 Maven:
$ mvn -v
Apache Maven 3.9.12 (848fbb4bf2d427b72bdb2471c22fced7ebd9a7a1)
Maven home: /Users/developer/.sdkman/candidates/maven/current
Java version: 17.0.18, vendor: BellSoft, runtime: /Users/developer/.sdkman/candidates/java/17.0.18-librca
Gradle
如果您想使用 Gradle,请确保已经安装了 Gradle:
$ gradle --version
------------------------------------------------------------
Gradle 8.14.4
------------------------------------------------------------
Build time: 2026-01-23 16:30:23 UTC
Revision: ad5ff774b4b0e9a8a0cf1a14ca70d7230003c3ad
Kotlin: 2.0.21
Groovy: 3.0.25
Ant: Apache Ant(TM) version 1.10.15 compiled on August 25 2024
Launcher JVM: 17.0.18 (BellSoft 17.0.18+10-LTS)
Daemon JVM: /Users/developer/.sdkman/candidates/java/17.0.18-librca (no JDK specified, using current Java home)
OS: Mac OS X 26.3 aarch64
使用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>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>4.1.0-M3</version>
</parent>
<groupId>com.example</groupId>
<artifactId>myproject</artifactId>
<version>0.0.1-SNAPSHOT</version>
<!-- Additional lines to be added here... -->
</project>
先前的示例应该可以让你获得一个可运行的构建。
您可以运行mvn package来测试它(暂时可以忽略“jar将为空-未标记任何内容进行包含!”警告)。
| 在此步骤中,您可以将项目导入到IDE(大多数现代Java IDE都内置了对Maven的支持)。 出于简化考虑,我们继续使用纯文本编辑器作为本例中的工具。 |
设置项目(使用Gradle)
我们需要从创建一个 Gradle build.gradle 文件开始。
build.gradle 是用于构建项目的构建脚本。打开你最喜欢的文本编辑器,并添加以下内容:
plugins {
id 'java'
id 'org.springframework.boot' version '4.1.0-M3'
id 'io.spring.dependency-management' version '1.1.7'
}
group = 'com.example'
version = '0.0.1-SNAPSHOT'
java {
toolchain {
languageVersion = JavaLanguageVersion.of(17)
}
}
repositories {
mavenCentral()
}
dependencies {
}
前面的示例应该可以让你完成构建。
你可以通过运行gradle classes进行测试。
| 在此步骤中,您可以将项目导入到IDE中(大多数现代Java IDE都内置了对Gradle的支持)。 为了简化示例,我们继续使用纯文本编辑器。 |
添加类路径依赖
Spring Boot 提供了多个Starters,可以让您将 jar 文件添加到类路径中。 Starters提供了在开发特定类型的应用程序时您可能需要的依赖项。
Maven
大多数Spring Boot应用程序在POM的parent部分使用spring-boot-starter-parent。
spring-boot-starter-parent是一个特殊的Starters,提供了有用的Maven默认设置。
它还提供了一个dependency-management部分,以便您可以省略“受祝福”的依赖项的version标签。
由于我们正在开发一个 Web 应用程序,因此添加了 spring-boot-starter-webmvc 依赖项。
在此之前,我们可以运行以下命令来查看当前已有的内容:
$ mvn dependency:tree
[INFO] com.example:myproject:jar:0.0.1-SNAPSHOT
mvn dependency:tree 命令打印出项目的依赖关系树。
你可以看到 spring-boot-starter-parent 本身并未提供任何依赖项。
要添加必要的依赖项,请编辑你的 pom.xml,并在 spring-boot-starter-webmvc 部分下方立即添加 parent 依赖项:
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-webmvc</artifactId>
</dependency>
</dependencies>
如果再次运行mvn dependency:tree,您会看到现在多了许多额外的依赖项,包括Tomcat Web服务器和Spring Boot本身。
Gradle
大多数 Spring Boot 应用程序使用 org.springframework.boot Gradle 插件。
该插件提供了有用的默认配置和 Gradle 任务。
io.spring.dependency-management Gradle 插件提供了依赖管理功能,因此您可以省略“受支持”依赖项的 version 标签。
由于我们正在开发一个 Web 应用程序,因此添加了 spring-boot-starter-webmvc 依赖项。
在此之前,我们可以运行以下命令来查看当前已有的内容:
$ gradle dependencies
> Task :dependencies
------------------------------------------------------------
Root project 'myproject'
------------------------------------------------------------
gradle dependencies 命令会以树形结构打印出您项目的依赖项。
目前,该项目没有任何依赖。
要添加必要的依赖,请编辑您的 build.gradle 文件,并在 spring-boot-starter-webmvc 部分中添加 dependencies 依赖:
dependencies {
implementation 'org.springframework.boot:spring-boot-starter-webmvc'
}
如果再次运行gradle dependencies,您会看到现在多了许多额外的依赖项,包括Tomcat Web服务器和Spring Boot本身。
编写代码
要完成我们的应用程序,我们需要创建一个单独的 Java 文件。
默认情况下,Maven 和 Gradle 会从 src/main/java 编译源代码,因此您需要创建相应的目录结构,然后添加一个名为 src/main/java/com/example/MyApplication.java 的文件,其中包含以下代码:
-
Java
-
Kotlin
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);
}
}
package com.example
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。
这是一种称为切面的注解。
它为阅读代码的人和Spring提供提示,表明该类扮演特定的角色。
在这种情况下,我们的类是一个web @Controller,因此Spring在处理传入的Web请求时会考虑这个类。
@RequestMapping 注解提供了“路由”信息。它告诉Spring,任何带有/路径的HTTP请求都应该映射到home方法。@RestController注解告诉Spring直接将结果字符串回传给调用者。
The @RestController 和 @RequestMapping 注解是 Spring MVC 注解(它们不特定于 Spring Boot)。
See the MVC 部分 in the Spring 参考文档 for more details. |
@SpringBootApplication 注解
第二个类级别注解是 @SpringBootApplication。
此注解被称为元注解,它结合了 @SpringBootConfiguration、@EnableAutoConfiguration 和 @ComponentScan。
其中,我们最感兴趣的注解是@EnableAutoConfiguration。
@EnableAutoConfiguration告诉Spring Boot根据你添加的jar依赖来“猜测”你希望如何配置Spring。
由于spring-boot-starter-webmvc加入了Tomcat和Spring MVC,自动配置假设你正在开发一个Web应用程序,并相应地设置了Spring。
"main" 方法
我们应用程序的最后一部分是 main 方法。
这是一个遵循 Java 应用程序入口点约定的标准方法。
我们的 main 方法通过调用 run,委托给 Spring Boot 的 SpringApplication 类。
SpringApplication 会引导我们的应用程序,启动 Spring,而 Spring 又会启动自动配置的 Tomcat Web 服务器。
我们需要将 MyApplication.class 作为参数传递给 run 方法,以告知 SpringApplication 哪个是主要的 Spring 组件。
args 数组也会被传递进去,以便暴露任何命令行参数。
运行示例
Maven
至此,您的应用程序应该可以正常运行。
由于您使用了spring-boot-starter-parent POM,因此您可以利用其中有用的 run 目标来启动应用程序。
在项目根目录下输入 mvn spring-boot:run 来启动应用程序。
您应该会看到类似以下的输出:
$ mvn spring-boot:run
. ____ _ __ _ _
/\\ / ___'_ __ _ _(_)_ __ __ _ \ \ \ \
( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \
\\/ ___)| |_)| | | | | || (_| | ) ) ) )
' |____| .__|_| |_|_| |_\__, | / / / /
=========|_|==============|___/=/_/_/_/
:: Spring Boot :: (v4.1.0-M3)
....... . . .
....... . . . (log output here)
....... . . .
........ Started MyApplication in 0.906 seconds (process running for 6.514)
如果您在web浏览器中打开localhost:8080,您应该会看到以下输出:
Hello World!
要优雅地退出应用,请按 ctrl-c。
Gradle
此时,您的应用程序应该可以正常运行。
由于您使用了org.springframework.boot Gradle插件,因此您可以利用有用的bootRun 目标来启动应用程序。
从根项目目录中输入gradle bootRun即可启动应用程序。
您应该会看到类似于以下内容的输出:
$ gradle bootRun
. ____ _ __ _ _
/\\ / ___'_ __ _ _(_)_ __ __ _ \ \ \ \
( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \
\\/ ___)| |_)| | | | | || (_| | ) ) ) )
' |____| .__|_| |_|_| |_\__, | / / / /
=========|_|==============|___/=/_/_/_/
:: Spring Boot :: (v4.1.0-M3)
....... . . .
....... . . . (log output here)
....... . . .
........ Started MyApplication in 0.906 seconds (process running for 6.514)
如果您在web浏览器中打开localhost:8080,您应该会看到以下输出:
Hello World!
要优雅地退出应用,请按 ctrl-c。
创建可执行jar包
我们通过创建一个完全自包含的可执行jar文件来完成我们的示例,这个文件可以在生产环境中运行。 可执行jar文件(有时也称为“uber jar”或“fat jars”)是包含你的编译类以及代码运行所需的所有jar依赖项的档案。
Maven
要创建可执行的jar文件,我们需要在spring-boot-maven-plugin。
为此,请在dependencies部分下方插入以下行:
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
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:4.1.0-M3: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
您还应该在 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 :: (v4.1.0-M3)
....... . . .
....... . . . (log output here)
....... . . .
........ Started MyApplication in 0.497 seconds (process running for 0.651)
如以前一样,要退出该应用程序,请按下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 :: (v{version-spring-boot})
....... . . .
....... . . . (log output here)
....... . . .
........ Started MyApplication in 0.484 seconds (process running for 0.642)
如以前一样,要退出该应用程序,请按下ctrl-c。