目录
入门
Spring Boot 介绍
Spring Boot 可帮助您创建可以运行的独立的、生产级的基于 Spring 的应用程序。我们对 Spring 平台和第三方库自动配置,以便您可以轻松上手。大多数 Spring Boot 应用程序只需要很少的 Spring 配置。
您可以使用 Spring Boot 创建可以通过使用java -jar
或更传统的war部署方式。我们还提供了一个运行“spring 脚本”的命令行工具。
我们的主要目标是:
- 为所有 Spring 开发提供更快入门体验。
- 开箱即用,即自动配置、起步依赖。
- 提供一系列大型项目通用的非功能特性(例如嵌入式服务器、安全性、指标、健康检查和外部化配置)。
- 绝对没有代码生成,也不需要 XML 配置。
系统要求
Spring Boot 2.6.2 需要Java 8,并且兼容 Java 17
Spring Boot 支持以下嵌入式 servlet 容器:
Tomcat 9.0 | 4.0 |
---|---|
Jetty 9.4 | 3.1 |
Jetty 10.0 | 4.0 |
Undertow 2.0 | 4.0 |
安装Spring Boot
Java 开发人员安装说明
虽然您可以复制 Spring Boot jar,但我们通常建议您使用支持依赖管理的构建工具(例如 Maven 或 Gradle)。
Maven 安装
Spring Boot 兼容 Apache Maven 3.3 或更高版本。
Spring Boot 依赖项使用org.springframework.boot
groupId
. 通常,您的 Maven POM 文件继承自spring-boot-starter-parent
项目并声明对一个或多个“Starters”的依赖关系。
Gradle 安装
Spring Boot 与 Gradle 6.8、6.9 和 7.x 兼容。
第一个 Spring Boot 应用程序
创建 POM
我们需要从创建一个 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>2.6.2</version>
</parent>
<!-- Additional lines to be added here... -->
</project>
前面的清单应该给你一个工作构建。您可以通过运行对其进行测试mvn package
(现在,您可以忽略“jar 将为空 - 没有内容被标记为包含!”警告)。
添加类路径依赖项
Spring Boot 提供了许多“启动器”,可让您将 jars 添加到类路径中。我们的应用程序使用POM 部分中的spring-boot-starter-parent
。spring-boot-starter-parent
是一个特殊的启动器,提供有用的 Maven 默认值。它还提供了一个dependency-management
部分,以便您可以省略version
依赖项的标签。
其他“Starters”提供了您在开发特定类型的应用程序时可能需要的依赖项。由于我们正在开发 Web 应用程序,因此我们添加了一个spring-boot-starter-web
依赖项。
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
</dependencies>
编写代码
为了完成我们的应用程序,我们需要创建一个 Java 文件。默认情况下,Maven 从 编译源代码src/main/java
,因此您需要创建该目录结构,然后添加一个名为src/main/java/MyApplication.java
包含以下代码的文件:
@RestController
@EnableAutoConfiguration
public class MyApplication {
@RequestMapping("/")
String home() {
return "Hello World!";
}
public static void main(String[] args) {
SpringApplication.run(MyApplication.class, args);
}
}
虽然这里没有太多代码,但有很多事情正在发生。我们将在接下来的几节中逐步介绍重要部分。
@RestController 和 @RequestMapping 注解
MyApplication
我们类的第一个注释是@RestController
. 这称为构造型注释。它为阅读代码的人和 Spring 提供了类扮演特定角色的提示。在这种情况下,我们的类是一个 web @Controller
,因此 Spring 在处理传入的 Web 请求时会考虑它。
该@RequestMapping
注释提供“路由”的信息。它告诉 Spring 任何带有该/
路径的HTTP 请求都应该映射到该home
方法。该@RestController
注解告诉Spring使得到的字符串直接返回给调用者。
@EnableAutoConfiguration 注解
第二个类级别的注释是@EnableAutoConfiguration
. 这个注解告诉 Spring Boot 根据你添加的 jar 依赖来“猜测”你想如何配置 Spring。由于spring-boot-starter-web
添加了 Tomcat 和 Spring MVC,自动配置假定您正在开发 Web 应用程序并相应地设置 Spring。
“main”方法
我们应用程序的最后一部分是main
方法。这是一种遵循应用程序入口点的 Java 约定的标准方法。我们的 main 方法通过调用委托给 Spring Boot 的SpringApplication
类run
。 SpringApplication
引导我们的应用程序,启动 Spring,然后启动自动配置的 Tomcat Web 服务器。我们需要将MyApplication.class
作为参数传递给该run
方法,以判断SpringApplication
哪个是主要的 Spring 组件。该args
数组也被传递以公开任何命令行参数。
运行示例
此时,您的应用程序应该可以工作了。由于您使用了spring-boot-starter-parent
POM,因此您有一个有用的run
目标,可用于启动应用程序。mvn spring-boot:run
从根项目目录键入以启动应用程序。您应该会看到类似于以下内容的输出:
$ mvn spring-boot:run
. ____ _ __ _ _
/\\ / ___'_ __ _ _(_)_ __ __ _ \ \ \ \
( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \
\\/ ___)| |_)| | | | | || (_| | ) ) ) )
' |____| .__|_| |_|_| |_\__, | / / / /
=========|_|==============|___/=/_/_/_/
:: Spring Boot :: (v2.6.2)
....... . . .
....... . . . (log output here)
....... . . .
........ Started MyApplication in 2.222 seconds (JVM running for 6.514)
如果您打开 Web 浏览器localhost:8080
,您应该会看到以下输出:
你好世界!
要优雅地退出应用程序,请按ctrl-c
。
创建可执行 Jar
我们通过创建一个可以在生产中运行的完全独立的可执行 jar 文件来完成我们的示例。可执行 jars(有时称为“fat jars”)是包含已编译类以及代码需要运行的所有 jar 依赖项的存档。
spring-boot-maven-plugin
要创建一个可执行的 jar,我们需要将pom.xml
. 为此,请在该dependencies
部分下方插入以下行:
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
保存pom.xml
并从命令行运行mvn package
,如下:
$ mvn package
如果您查看target
目录,您应该会看到myproject-0.0.1-SNAPSHOT.jar
. 该文件的大小应约为 10 MB。
要运行该应用程序,请使用以下java -jar
命令:
$ java -jar target/myproject-0.0.1-SNAPSHOT.jar