一些准备工作:
本节介绍如何开发一个简单的“ Hello World!” Web应用程序,该应用程序重点介绍Spring Boot的一些关键功能。我们使用Maven来构建该项目,因为大多数IDE都支持它。
小贴士:spring.io网站包含许多使用Spring Boot的“入门”指南。如果您需要解决特定的问题,请首先检查。通过转到start.spring.io并从依赖项搜索器中选择“ Web”启动器,可以简化以下步骤。这样做会生成一个新的项目结构,以便您可以立即开始编码。查看Spring Initializr文档以获取更多详细信息。
在开始之前,请打开终端并运行以下命令,以确保安装了有效的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
小贴士:该示例需要在其自己的文件夹中创建。随后的说明假定您已经创建了一个合适的文件夹,并且它是当前目录。
1. 创建POM
我们需要先创建一个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.0modelVersion> <groupId>com.examplegroupId> <artifactId>myprojectartifactId> <version>0.0.1-SNAPSHOTversion> <parent> <groupId>org.springframework.bootgroupId> <artifactId>spring-boot-starter-parentartifactId> <version>2.1.8.RELEASEversion> parent> project>
上面的清单应该为您提供了有效的构建。您可以通过运行mvn package
命令对其进行测试(目前,您可以将“ jar将为空-没有内容标记为包含!”的警告忽略)。
此时,您可以将项目导入IDE(大多数现代Java IDE包含了对Maven的内置支持)。为简单起见,我们在此示例中继续使用纯文本编辑器。
2. 添加类路径依赖
Spring Boot提供了许多“启动器”,使您可以将jar添加到类路径中。我们的示例应用程序已经在POM的parent
部分中使用spring-boot-starter-parent
。spring-boot-starter-parent
是一个特殊的启动器,提供有用的Maven默认值。它还提供了一个dependency-management
部分,以便您可以忽略“blessed”依赖项的version
标签。
其他“启动器”提供了在开发特定类型的应用程序时可能需要的依赖项。由于我们正在开发Web应用程序,因此我们添加了spring-boot-starter-web
依赖项。在此之前,我们可以通过运行以下命令来查看当前的状态:
$ mvn dependency:tree [INFO] com.example:myproject:jar:0.0.1-SNAPSHOT
mvn dependency:tree
命令会将项目依赖关系的树形表示打印出来。您可以看到spring-boot-starter-parent
本身不提供任何依赖关系。要添加必要的依赖关系,请编辑pom.xml
并在 parent
部分的正下方添加spring-boot-starter-web
依赖关系:
<dependencies> <dependency> <groupId>org.springframework.bootgroupId> <artifactId>spring-boot-starter-webartifactId> dependency> dependencies>
如果再次运行mvn dependency:tree
,则会看到现在还有许多其他依赖项,包括Tomcat Web服务器和Spring Boot本身。
3. 编写代码
要完成我们的应用程序,我们需要创建一个Java文件。默认情况下,Maven通过src/main/java
路径编译源代码,因此您需要创建该文件夹结构,然后在src/main/java
路径下添加一个名为Example.java的文件,包含以下代码:
import org.springframework.boot.*; import org.springframework.boot.autoconfigure.*; import org.springframework.web.bind.annotation.*; @RestController @EnableAutoConfiguration public class Example { @RequestMapping("/") String home() { return "Hello World!"; } public static void main(String[] args) { SpringApplication.run(Example.class, args); } }
尽管这里没有太多代码,但是正在发生很多事情。我们将在接下来的几节中逐步介绍重要部分。
3.1 @RestController 和@RequestMapping 注解
Example
类的第一个注解是 @RestController
。这被称为构造型注解。它为人们阅读代码提供了提示,对于Spring来说,@RestController注解扮演了特定角色。在这个示例中,我们的类是一个Web请求控制器( @Controller
),因此Spring在处理传入的Web请求时会考虑使用它。
@RequestMapping注解提供“路由”信息。它告诉Spring,任何带有 /
的HTTP请求都将被映射到 home
方法。@RestController注解告诉Spring将结果字符串直接呈现给调用方。
小贴士: @RestController
和@RequestMapping
注解是Spring MVC注解(它们不是特定于Spring Boot的)。有关更多详细信息,请参见Spring参考文档中的MVC部分。
3.2 @EnableAutoConfiguration注解
第二个类级别的注解是 @EnableAutoConfiguration
。这个注解告诉Spring Boot根据您所添加的jar依赖去“猜测”您如何配置Spring。由于spring-boot-starter-web
添加了Tomcat和Spring MVC,因此auto-configuration假定您正在开发Web应用程序并相应地设置Spring。
启动器和自动配置(Starters and Auto-configuration)
自动配置旨在与“启动器”配合使用,但是这两个概念并没有直接联系在一起。您可以在启动程序之外自由选择jar依赖项。Spring Boot仍会尽其所能自动配置您的应用程序。
3.3 main方法
我们应用程序的最后一部分是main
方法。这只是遵循Java约定的应用程序入口的标准方法。我们的主要方法通过调用 run
委托给Spring Boot的SpringApplication
类。SpringApplication
会引导我们的应用程序,并启动Spring,后者反过来又会启动自动配置的Tomcat Web服务器。我们需要将 Example.class
作为参数传递给 run
方法,以告诉 SpringApplication
哪个是主要的Spring组件。 args
参数数组也被传递给命令行参数。
4. 运行示例
此时,您的应用程序应该可以工作了。由于您使用了 spring-boot-starter-parent
t的POM,因此您具有一个有用的运行目标,可以用来启动该应用程序。打开cmd窗口并进入项目根目录,键入 mvn spring-boot:run
以启动应用程序。您应该看到类似于以下的输出:
$ mvn spring-boot:run . ____ _ __ _ _ /\\ / ___'_ __ _ _(_)_ __ __ _ \ \ \ \ ( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \ \\/ ___)| |_)| | | | | || (_| | ) ) ) ) ' |____| .__|_| |_|_| |_\__, | / / / / =========|_|==============|___/=/_/_/_/ :: Spring Boot :: (v2.1.8.RELEASE) ....... . . . ....... . . . (log output here) ....... . . . ........ Started Example in 2.222 seconds (JVM running for 6.514)
在Web浏览器中访问 localhost:8080
,则应该看到以下输出:
Hello World!
要正常退出该应用程序,请按 ctrl-c
5. 创建一个可执行的Jar
通过创建可以在生产环境中运行的完全独立的可执行jar文件来结束示例。可执行jar(有时称为“fat jars”)是包含您的已编译类以及代码需要运行的所有jar依赖项的归档文件。
可执行jar和Java(Executable jars and Java)
Java没有提供加载嵌套jar文件(jar中本身包含的jar文件)的标准方法。如果您要分发独立的应用程序,则可能会出现问题。
为了解决这个问题,许多开发人员使用“uber” jars。uber jar将来自应用程序所有依赖项的所有类打包到一个存档中。这种方法的问题在于,很难查看应用程序中包含哪些库。
如果在多个jar中使用相同的文件名(但具有不同的内容),也可能会产生问题。
Spring Boot采用了different approach,实际上允许您直接嵌套jar。
要创建可执行jar,我们需要将 spring-boot-maven-plugin
添加到我们的 pom.xml
.中。为此,请在 dependencies
部分的下面插入以下行:
<build> <plugins> <plugin> <groupId>org.springframework.bootgroupId> <artifactId>spring-boot-maven-pluginartifactId> plugin> plugins> build>
spring-boot-starter-par
的POM包含
配置以绑定重新打包( 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.1.8.RELEASE: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
您还将在target
目录中看到一个名为 myproject-0.0.1-SNAPSHOT.jar.original
的小得多的文件。这是Maven在Spring Boot重新打包之前创建的原始jar文件。
要运行该应用程序,请使用java -jar
命令,如下所示:
$ java -jar target/myproject-0.0.1-SNAPSHOT.jar . ____ _ __ _ _ /\\ / ___'_ __ _ _(_)_ __ __ _ \ \ \ \ ( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \ \\/ ___)| |_)| | | | | || (_| | ) ) ) ) ' |____| .__|_| |_|_| |_\__, | / / / / =========|_|==============|___/=/_/_/_/ :: Spring Boot :: (v2.1.8.RELEASE) ....... . . . ....... . . . (log output here) ....... . . . ........ Started Example in 2.536 seconds (JVM running for 2.864)
和以前一样,要退出该应用程序,请按 ctrl-c
.
如果查看目标目录,则应该看到myproject-0.0.1-SNAPSHOT.jar。该文件的大小应为10 MB左右。如果想窥视内部,可以使用jar tvf,如下所示: