1.开发您的第一个Spring Boot应用程序
本节介绍如何开发一个简单的“Hello World!”Web应用程序,该应用程序突出了Spring Boot的一些主要功能。我们使用Maven来构建这个项目,因为大多数IDE都支持它。
(可以使用https://start.spring.io/ 快速创建springboot工程)
在开始之前,打开终端并运行以下命令以确保安装了有效的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
我们需要从创建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 http://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.1.3.RELEASE</version> </parent> <!-- Additional lines to be added here... --> </project>
上面的清单应该为您提供有效的构建。您可以通过运行来测试它,命令: mvn package
Spring Boot提供了许多“Starters”,可以将jar添加到类路径中。我们的示例应用程序已经spring-boot-starter-parent
在parent
POM部分中使用过。这spring-boot-starter-parent
是一个特殊的启动器,提供有用的Maven默认值。它还提供了一个 dependency-management
部分,以便您可以省略version
“设置。
其他“Starters”提供了在开发特定类型的应用程序时可能需要的依赖项。由于我们正在开发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
并将spring-boot-starter-web添加进来
:
<dependencies> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </dependency> </dependencies>
如果mvn dependency:tree
再次运行,您会发现现在有许多其他依赖项,包括Tomcat Web服务器和Spring Boot本身。
要完成我们的应用程序,我们需要创建一个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); } }
我们Example
类上的第一个注释是@RestController
。这被称为 构造型注释。它为阅读代码的人提供了提示,而为Spring提供了特定角色的提示。
在这种情况下,我们的类是一个Web @Controller
,因此Spring在处理传入的Web请求时会考虑使用它。
@RequestMapping
注释提供“路由”的信息。它告诉Spring,任何带/
路径的HTTP请求都应该映射到该home
方法。该 @RestController
注解告诉Spring使得到的字符串直接返回给调用者。
@RestController
与@RequestMapping
注解是Spring MVC的注解。(它们不是Spring Boot特有的。)
第二个类级注释是@EnableAutoConfiguration
。这个注释告诉Spring Boot根据你添加的jar依赖关系“猜测”你想要如何配置Spring。
自从spring-boot-starter-web
添加了Tomcat和Spring MVC 以来,自动配置假定您正在开发Web应用程序并相应地设置Spring。
此时,您的应用程序应该工作。由于您使用了 spring-boot-starter-parent
POM,run
因此您可以使用一个有用的目标来启动应用程序。mvn spring-boot:run
从根项目目录中键入以启动应用程序。您应该看到类似于以下内容的输出:
$ mvn spring-boot:run . ____ _ __ _ _ /\ / ___'_ __ _ _(_)_ __ __ _ ( ( )\___ | '_ | '_| | '_ / _` | \/ ___)| |_)| | | | | || (_| | ) ) ) ) ' |____| .__|_| |_|_| |_\__, | / / / / =========|_|==============|___/=/_/_/_/ :: Spring Boot :: (v2.1.3.RELEASE) ....... . . . ....... . . . (log output here) ....... . . . ........ Started Example in 2.222 seconds (JVM running for 6.514)
如果您打开Web浏览器localhost:8080
,您应该看到以下输出:
Hello World!
要正常退出应用程序,请按ctrl-c
。
我们通过创建一个完全自包含的可执行jar文件来完成我们的示例,我们可以在生产中运行它。可执行jar(有时称为“fat jar”)是包含已编译类以及代码需要运行的所有jar依赖项的归档。
<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:2.1.3.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
您还应该看到目录中命名myproject-0.0.1-SNAPSHOT.jar.original
的文件(只包含源码不包含依赖的jar)。这是Maven在Spring Boot重新打包之前创建的原始jar文件。
要运行该应用程序,请使用以下java -jar
命令:
$ java -jar target/myproject-0.0.1-SNAPSHOT.jar
. ____ _ __ _ _
/\ / ___'_ __ _ _(_)_ __ __ _
( ( )\___ | '_ | '_| | '_ / _` |
\/ ___)| |_)| | | | | || (_| | ) ) ) )
' |____| .__|_| |_|_| |_\__, | / / / /
=========|_|==============|___/=/_/_/_/
:: Spring Boot :: (v2.1.3.RELEASE)
....... . . .
....... . . . (log output here)
....... . . .
........ Started Example in 2.536 seconds (JVM running for 2.864)
和以前一样,要退出应用程序,请按ctrl-c
。
1.5. 结论
一个简单的springboot工程创建完毕