开发你的第一个Spring Boot应用
本节介绍如何开发一个小型“Hello World!”网页应用,突出Spring Boot的一些关键功能。 你可以选择Maven或Gradle作为构建系统。
|
你可以通过进入 start.spring.io,从依赖搜索器中选择“Web”启动程序,从而简化步骤。 这样做会生成新的项目结构,让你能立即开始编码。 详情请查阅 start.spring.io 用户指南。 |
前提条件
在开始之前,打开终端并执行以下命令,确保你安装的Java版本有效:
$ java -version
openjdk version "17.0.16" 2025-07-15 LTS
OpenJDK Runtime Environment (build 17.0.16+12-LTS)
OpenJDK 64-Bit Server VM (build 17.0.16+12-LTS, mixed mode, sharing)
| 这个示例需要在自己的目录中创建。 后续指令假设你已经创建了一个合适的目录,并且它是你当前的目录。 |
梅文
如果你想使用 Maven,确保你安装了 Maven:
$ mvn -v
Apache Maven 3.9.11 (3e54c93a704957b63ee3494413a2b544fd3d825b)
Maven home: /Users/developer/.sdkman/candidates/maven/current
Java version: 17.0.16, vendor: BellSoft, runtime: /Users/developer/.sdkman/candidates/java/17.0.16-librca
格拉德勒
如果你想使用 Gradle,请确保你安装了 Gradle:
$ gradle --version
------------------------------------------------------------
Gradle 8.14.3
------------------------------------------------------------
Build time: 2025-07-04 13:15:44 UTC
Revision: e5ee1df3d88b8ca3a8074787a94f373e3090e1db
Kotlin: 2.0.21
Groovy: 3.0.24
Ant: Apache Ant(TM) version 1.10.15 compiled on August 25 2024
Launcher JVM: 17.0.16 (BellSoft 17.0.16+12-LTS)
Daemon JVM: /Users/developer/.sdkman/candidates/java/17.0.16-librca (no JDK specified, using current Java home)
OS: Mac OS X 15.7.1 aarch64
与Maven一起建立项目
我们需要先创建一个Mavenpom.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>4.0.0</version>
</parent>
<!-- Additional lines to be added here... -->
</project>
前面的列表应该能给你一个可运行的组装方案。
你可以通过运行来测试MVN 封装(暂时你可以忽略“罐子将是空的——没有内容被标记为包含!”的警告)。
| 此时,你可以将项目导入集成开发环境(大多数现代Java IDE内置支持Maven)。 为了简化,我们继续使用纯文本编辑器。 |
与Gradle搭建项目
我们需要先创建一个Gradlebuild.gradle文件。
这build.gradle是用来构建你项目的构建脚本。
打开你喜欢的文本编辑器,添加以下内容:
plugins {
id 'java'
id 'org.springframework.boot' version '4.0.0'
}
apply plugin: 'io.spring.dependency-management'
group = 'com.example'
version = '0.0.1-SNAPSHOT'
java {
sourceCompatibility = '17'
}
repositories {
mavenCentral()
}
dependencies {
}
前面的列表应该能给你一个可运行的组装方案。
你可以通过运行来测试Gradle班级.
| 此时,你可以将项目导入集成环境(大多数现代 Java IDE 内置支持 Gradle)。 为了简化,我们继续使用纯文本编辑器。 |
添加类路径依赖
Spring Boot 提供了多种起始程序,允许你向职业路径添加瓶子。 起始程序提供了你在开发特定应用类型时可能需要的依赖关系。
梅文
大多数 Spring Boot 应用程序使用Spring靴启动父在父母POM的部分。
这Spring靴启动父是一个特殊的起始角色,提供有用的Maven默认值。
它还提供了依赖管理所以你可以省略版本“祝福”依赖标签。
由于我们正在开发一个网页应用,我们会添加一个Spring Boot启动网Dependency。
在此之前,我们可以通过运行以下命令查看当前的状态:
$ mvn dependency:tree
[INFO] com.example:myproject:jar:0.0.1-SNAPSHOT
这MVN 依赖:树命令打印出你项目依赖关系的树状表示。
你可以看到Spring靴启动父单独不提供依赖关系。
要添加必要的依赖关系,请编辑你的pom.xml并加上Spring Boot启动网紧接其下父母部分:
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
</dependencies>
如果你逃跑MVN 依赖:树你会再次看到,现在有许多额外的依赖,包括 Tomcat 的 Web 服务器和 Spring Boot 本身。
格拉德勒
大多数 Spring Boot 应用程序使用org.springframework.bootGradle 插件。
该插件提供了有用的默认值和 Gradle 任务。
这io.spring.dependency-managementGradle 插件提供依赖管理,所以你可以省略版本“祝福”依赖标签。
由于我们正在开发一个网页应用,我们会添加一个Spring Boot启动网Dependency。
在此之前,我们可以通过运行以下命令查看当前的状态:
$ gradle dependencies
> Task :dependencies
------------------------------------------------------------
Root project 'myproject'
------------------------------------------------------------
这Gradle 依赖关系命令打印出你项目依赖关系的树状表示。
目前,这个项目没有依赖。
要添加必要的依赖关系,请编辑你的build.gradle并加上Spring Boot启动网依赖关系依赖部分:
dependencies {
implementation 'org.springframework.boot:spring-boot-starter-web'
}
如果你逃跑Gradle 依赖关系你会再次看到,现在有许多额外的依赖,包括 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注释
我们 的第一个注释我的应用类为@RestController.
这被称为刻板印象注释。
它为阅读代码的人和Spring提供了提示,说明该类扮演着特定角色。
在这种情况下,我们的类是一个网络@Controller因此 Spring 在处理来访的网页请求时会考虑它。
这@RequestMapping注释提供“路由”信息。
它告诉 Spring,任何带有路径的 HTTP 请求都应映射到/家方法。
这@RestController注释会让 Spring 直接将生成的字符串渲染回调用者。
这@RestController和@RequestMapping注释是 Spring MVC 的注释(它们并非专属于 Spring Boot)。
详情请参见春季参考文档中的MVC部分。 |
@SpringBootApplication注释
第二类注释为@SpringBootApplication.
这种注释被称为元注释,它将@SpringBootConfiguration,@EnableAutoConfiguration和@ComponentScan.
其中,我们最感兴趣的注释是@EnableAutoConfiguration.@EnableAutoConfiguration它告诉 Spring Boot 根据你添加的 jar 依赖“猜测”你想如何配置 Spring。
因为Spring Boot启动网添加了Tomcat和Spring MVC,自动配置假设你正在开发一个网页应用,并相应地设置Spring。
“主要”方法
我们申请的最后一部分是主要方法。
这是一种遵循 Java 应用入口点惯例的标准方法。
我们的主要方法会被Spring Boot's委托SpringApplication通过调用来分类执行.SpringApplication启动我们的应用程序,启动 Spring,Spring 又启动自动配置的 Tomcat Web 服务器。
我们得通过MyApplication.class作为对执行判断方法SpringApplication这是主要的Spring成分。
这argsarray 也通过以暴露任何命令行参数。
运行示例
梅文
此时,你的申请应该可以正常工作了。
因为你使用了Spring靴启动父POM,你有个有用的执行你可以用来开始申请的目标。
类型MVN Spring-boot:run从根项目目录启动应用程序。
你应该会看到类似以下的输出:
$ mvn spring-boot:run
. ____ _ __ _ _
/\\ / ___'_ __ _ _(_)_ __ __ _ \ \ \ \
( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \
\\/ ___)| |_)| | | | | || (_| | ) ) ) )
' |____| .__|_| |_|_| |_\__, | / / / /
=========|_|==============|___/=/_/_/_/
:: Spring Boot :: (v4.0.0)
....... . . .
....... . . . (log output here)
....... . . .
........ Started MyApplication in 0.906 seconds (process running for 6.514)
如果你打开网页浏览器本地主持人:8080你应该会看到以下输出:
Hello World!
要优雅地退出应用,请按ctrl-c.
格拉德勒
此时,你的申请应该可以正常工作了。
因为你使用了org.springframework.bootGradle 插件,你有个有用的工具启动运行你可以用来开始申请的目标。
类型gradle bootRun从根项目目录启动应用程序。
你应该会看到类似以下的输出:
$ gradle bootRun
. ____ _ __ _ _
/\\ / ___'_ __ _ _(_)_ __ __ _ \ \ \ \
( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \
\\/ ___)| |_)| | | | | || (_| | ) ) ) )
' |____| .__|_| |_|_| |_\__, | / / / /
=========|_|==============|___/=/_/_/_/
:: Spring Boot :: (v4.0.0)
....... . . .
....... . . . (log output here)
....... . . .
........ Started MyApplication in 0.906 seconds (process running for 6.514)
如果你打开网页浏览器本地主持人:8080你应该会看到以下输出:
Hello World!
要优雅地退出应用,请按ctrl-c.
创建可执行容器
我们最后以创建一个完全自包含的可执行 jar 文件来结束示例,可以在生产环境中运行。 可执行jar(有时称为“uber jars”或“fatjars”)是包含你编译后的类以及所有需要运行的jar依赖的归档。
梅文
要创建可执行jar,我们需要添加Spring-boot-Maven-插件我们pom.xml.
为此,请在依赖部分:
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
这Spring靴启动父POM包括<处决>用于绑定重新包装目标。
如果你不使用父POM,你需要自己声明该配置。
详情请参见插件文档。 |
保存你的pom.xml然后跑MVN 封装从命令行中,具体如下:
$ 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.0.0:repackage (default) @ myproject ---
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
如果你看目标目录,你应该看看myproject-0.0.1-SNAPSHOT.jar.
文件大小大约是18MB。
如果你想偷看里面,可以用JAR TVF如下:
$ jar tvf target/myproject-0.0.1-SNAPSHOT.jar
你还应该看到一个更小的文件,名为myproject-0.0.1-SNAPSHOT.jar。原创在目标目录。
这是Maven在被Spring Boot重新打包之前创建的原始jar文件。
要运行该应用程序,请使用Java -jar命令如下:
$ java -jar target/myproject-0.0.1-SNAPSHOT.jar
. ____ _ __ _ _
/\\ / ___'_ __ _ _(_)_ __ __ _ \ \ \ \
( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \
\\/ ___)| |_)| | | | | || (_| | ) ) ) )
' |____| .__|_| |_|_| |_\__, | / / / /
=========|_|==============|___/=/_/_/_/
:: Spring Boot :: (v4.0.0)
....... . . .
....... . . . (log output here)
....... . . .
........ Started MyApplication in 0.999 seconds (process running for 1.253)
和之前一样,要退出应用,请按ctrl-c.
格拉德勒
要创建可执行jar,我们需要运行gradle bootJar从命令行中,具体如下:
$ gradle bootJar
BUILD SUCCESSFUL in 639ms
3 actionable tasks: 3 executed
如果你看build/libs目录,你应该看看myproject-0.0.1-SNAPSHOT.jar.
文件大小大约是18MB。
如果你想偷看里面,可以用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.999 seconds (process running for 1.253)
和之前一样,要退出应用,请按ctrl-c.