入门
如果您开始使用 Spring Boot 或一般的“Spring”,请从阅读本节开始。它回答了基本的“什么?”,“如何?” “为什么?” 问题。它包括对 Spring Boot 的介绍以及安装说明。然后,我们将引导您构建您的第一个 Spring Boot 应用程序,同时讨论一些核心原则。
一、Spring Boot 介绍
1.1 Spring Boot 介绍
Spring Boot 可帮助您创建可以运行的独立的、生产级的基于 Spring 的应用程序。我们对 Spring 平台和第三方库持固执己见的看法,以便您可以轻松上手。大多数 Spring Boot 应用程序只需要很少的 Spring 配置。
您可以使用 Spring Boot 创建可以通过使用java -jar或更传统的战争部署启动的 Java 应用程序。我们还提供了一个运行“spring 脚本”的命令行工具。
我们的主要目标是:
● 为所有 Spring 开发提供从根本上更快且可广泛访问的入门体验。
● 开箱即用,但随着需求开始偏离默认值,请迅速摆脱困境。
● 提供一系列大型项目通用的非功能特性(例如嵌入式服务器、安全性、指标、健康检查和外部化配置)。
● 绝对没有代码生成,也不需要 XML 配置。
二、系统要求
Spring Boot 2.6.3 需要Java 8,并且兼容 Java 17(包括 Java 17 )。还需要Spring Framework 5.3.15或更高版本。
为以下构建工具提供了显式构建支持:
Build | Version |
---|---|
Maven | 3.5+ |
Gradle | 6.8.x, 6.9.x, and 7.x |
2.1 Servlet 容器
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 应用程序部署到任何 servlet 3.1+ 兼容容器。
三、安装Spring Boot
Spring Boot 可以与“经典”Java 开发工具一起使用,也可以作为命令行工具安装。无论哪种方式,您都需要Java SDK v1.8或更高版本。在开始之前,您应该使用以下命令检查当前的 Java 安装:
$ java -version
如果您是 Java 开发的新手,或者您想尝试使用 Spring Boot,您可能想先尝试一下Spring Boot CLI(命令行界面)。否则,请继续阅读“经典”安装说明。
3.1 Java 开发人员安装说明
您可以像使用任何标准 Java 库一样使用 Spring Boot。为此,请spring-boot-*.jar在类路径中包含适当的文件。Spring Boot 不需要任何特殊工具集成,因此您可以使用任何 IDE 或文本编辑器。此外,Spring Boot 应用程序没有什么特别之处,因此您可以像运行任何其他 Java 程序一样运行和调试 Spring Boot 应用程序。
虽然您可以复制 Spring Boot jar,但我们通常建议您使用支持依赖管理的构建工具(例如 Maven 或 Gradle)。
3.1.1 Maven 安装
Spring Boot 兼容 Apache Maven 3.3 或更高版本。如果您还没有安装 Maven,您可以按照maven.apache.org上的说明进行操作。
在许多操作系统上,可以使用包管理器安装Maven。如果您使用OSX Homebrew,请尝试brew install maven,Ubuntu用户可以运行Sudo apt -get install maen,使用Chocolatey的Windows用户可以choco install maven从提升的(管理员)提示符下运行。
Spring Boot 依赖项使用org.springframework.boot groupId. 通常,您的 Maven POM 文件继承自spring-boot-starter-parent项目并声明对一个或多个“Starters”的依赖关系。Spring Boot 还提供了一个可选的Maven 插件来创建可执行的 jar。
四、开发第一个Spring Boot 应用程序
本节介绍如何开发一个小的“Hello World!” 突出 Spring Boot 的一些关键特性的 web 应用程序。我们使用 Maven 来构建这个项目,因为大多数 IDE 都支持它。
在我们开始之前,打开一个终端并运行一下命令以确保您安装了有效版本的Java和Maven:
$ java -version
java version "1.8.0_102"
Java(TM) SE Runtime Environment (build 1.8.0_102-b14)
Java HotSpot(TM) 64-Bit Server VM (build 25.102-b14, mixed mode)
$ mvn -v
Apache Maven 3.5.4 (1edded0938998edf8bf061f1ceb3cfdeccf443fe; 2018-06-17T14:33:14-04:00)
Maven home: /usr/local/Cellar/maven/3.3.9/libexec
Java version: 1.8.0_102, vendor: Oracle Corporation
4.1 创建POM
我们需要从创建一个Maven的文件开始。此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.3</version>
</parent>
<!-- Additional lines to be added here... -->
</project>
4.2 添加类路径依赖项
Spring Boot提供了许多的“启动器”,可以将你的jars添加到类路径中。我们的测试应用程序使用POM部分中的spring-boot-starter-parent.parent这spring-boot-startter-parent是一个特殊的启动器,提供有用的Maven默认值。它还提供了一个dependency-management部分,以便你可以省略version依赖项的标签。
其他“Starters"提供了您在开发特定类型的应用程序时,可能需要的依赖项。由于我们正在开发web应用程序,因此我们添加一个spring-boot-starter-web依赖项。在此之前,我们可以通过运行一下命令查看我们当前拥有的内容:
$mvn dependency:tree
该mvn dependency:tree 命令打印项目依赖项的树表示。您可以看到它spring-boot-starter-parent本身不提供任何依赖项。要添加必要的依赖项,请编辑你的pomxml并spring-boot-starter-web在该parent部分正下方添加依赖项:
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
</dependencies>
如果mvn dependency:tree再次运行,您会看到现在有许多附加依赖项,包括 Tomcat Web 服务器和 Spring Boot 本身。
4.3 编写代码
为了完成我们的应用程序,我们需要创建一个Java文件。默认情况下,Maven从编译源代码src/main/java,因此您需要创建该目录结构,然后添加一个名为src/main/java/MyApplication.java包含一下代码的文件:
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
@EnableAutoConfiguration
public class MyApplication {
@RequestMapping("/")
String home() {
return "Hello World!";
}
public static void main(String[] args) {
SpringApplication.run(MyApplication.class, args);
}
}
虽然这里没有太多的代码,但有很多的事情正在发生。我们将在接下来的几节中逐步介绍重要部分。
4.3.1 @RestController和@RequestMapping注解
MyApplication我们类的第一个注解是@RestController。这称为构造型注释。它为阅读代码的人和Spring提供了类扮演特定角色的提示。在这种情况下,我们的类是一个web @Controller,因此Spring在处理传入的web请求时会 考虑它。
该@RequestMapping注释提供”路由“的信息。他告诉Spring任何带有/路径的HTTP请求都应该映射到该home方法。该@RestController注解告诉Spring使得到的字符串直接返回给调用者。
4.3.2 @EnableAutoConfiguration注解
第二个类级别的注释是@EnableAutoConfiguration这个注解告诉Spring Boot 根据你添加的jar 依赖来猜测你想如何配置Spring.由于spring-boot-start-web添加了Tomcat和Spring MVC ,自动配置假定你正在开发web应用程序并相应的设置Spring.
启动器和自动配置
自动配置旨在与”启动器“很好的配合使用,但这来两个概念并没有直接联系。您可以自由选择启动器之外的jar依赖项。Spring Boot 仍然尽力自动配置你的应用程序。
4.3.3 “main” 方法
我们应用程序的最后一部分是main方法。这是一种遵循应用程序入口的点的Java约定的标准方法。我们的main方法SpringApplication通过调用委托给Spring Boot的类run方法.
SpringApplication引导我们的应用程序,启动Spring,然后启动自动配置的Tomcat Web服务器。我们需要将MyApplication.class作为参数传递给该run方法,以判断SpringApplication那个是主要的Spring组件。该args数组也被传递以公开任何命令行参数。
4.4 运行示例
此时,您的应用程序应该可以工作了。由于您使用了spring-boot-starter-parentPOM,因此您有一个有用的run目标,可用于启动应用程序。mvn spring-boot:run从根项目目录键入以启动应用程序。您应该会看到类似于以下内容的输出:
$ mvn spring-boot:run
. ____ _ __ _ _
/\\ / ___'_ __ _ _(_)_ __ __ _ \ \ \ \
( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \
\\/ ___)| |_)| | | | | || (_| | ) ) ) )
' |____| .__|_| |_|_| |_\__, | / / / /
=========|_|==============|___/=/_/_/_/
:: Spring Boot :: (v2.6.3)
....... . . .
....... . . . (log output here)
....... . . .
........ Started MyApplication in 2.222 seconds (JVM running for 6.514)
如果您打开 Web 浏览器localhost:8080,您应该会看到以下输出:
hello world!
要优雅地退出应用程序,请按ctrl-c。
4.5 创建可执行Jar
我们通过一个可以在生产中运行的完全独立的可执行jar文件来完成我们的实例。可执行jars(有时称为“fat jars’)是包含已编译类以及代码需要运行的所有jar依赖项的存档。
可执行jar和Java
Java 不提供加载嵌套 jar 文件(本身包含在 jar 中的 jar 文件)的标准方法。如果您希望分发一个独立的应用程序,这可能会出现问题。
为了解决这个问题,许多开发人员使用“uber”jars。一个 uber jar 将所有应用程序依赖项中的所有类打包到一个存档中。这种方法的问题是很难看到应用程序中有哪些库。如果在多个 jar 中使用相同的文件名(但内容不同),也可能会出现问题。
Spring Boot 采用了不同的方法,让您实际上可以直接嵌套 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>
spring-boot-starter-parentPOM 包含绑定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:2.6.3:repackage (default) @ myproject ---
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
如果您查看target目录,您应该会看到myproject-0.0.1-SNAPSHOT.jar. 该文件的大小应约为 10 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 :: (v2.6.3)
....... . . .
....... . . . (log output here)
....... . . .
........ Started MyApplication in 2.536 seconds (JVM running for 2.864)
和以前一样,要退出应用程序,请按ctrl-c。
和以前一样,要退出应用程序,请按ctrl-c。
💥推荐阅读💥