在开始之前,请打开终端并运行以下命令以确保您已安装了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.3.9 (bb52d8502b132ec0a5a3f4c09453c07478323dc5; 2015-11-10T16:41:47+00: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 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.0.0.RELEASE</version>
</parent>
<!-- Additional lines to be added here... -->
</project>
前面的列表应该给你一个工作版本。您可以通过运行来测试它mvn package(现在,您可以忽略“jar将为空 - 没有内容被标记为包含!”警告)。
2.添加依赖关系
Spring Boot提供了许多“启动器(Starters)”,可让您将jar添加到类路径中。启动器(Starters)这spring-boot-starter-parent是一个提供有用的Maven默认值的特殊启动器。它还提供了一个 dependency-management 部分,以便您可以省略子模块依赖关系的版本标签。
其他“Starter”提供了在开发特定类型的应用程序时可能需要的依赖关系。由于我们正在开发一个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在该parent部分正下方添加 依赖项:
<dependency>
<dependency>
<groupId> org.springframework.boot </ groupId>
<artifactId> spring-boot-starter-web </ artifactId>
</ 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) throws Exception {
SpringApplication.run(Example.class, args);
}
}
尽管这里没有太多的代码,但还是有很多重要的部分。如:
3.1 @RestController和@RequestMapping注解
我们Example类的第一个注释是@RestController。这被称为 stereotype annotation。它为阅读代码的人提供了线索,对于Spring来说,这个类扮演着特定的角色。在这种情况下,我们的类是一个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之后,自动配置假定您正在开发一个Web应用程序并据此设置Spring。
启动器和自动配置
自动配置旨在与“Starter”配合使用,但这两个概念并不直接相关。您可以自由选择启动器之外的jar依赖项。Spring Boot仍然尽力自动配置您的应用程序。
3.3“main”方法
我们应用程序的最后一部分是该main方法。这只是一个遵循Java约定的应用程序入口点的标准方法。我们的主要方法SpringApplication通过调用委托给Spring Boot的类run。 SpringApplication引导我们的应用程序,启动整个springboot应用程序,从Spring开始,然后启动自动配置的Tomcat Web服务器。我们需要Example.class将该run方法的参数作为参数传递,以确定SpringApplication哪些是主要的Spring组件。还传递了args数组以传递命令行参数。
4.运行示例
在这一点上,你的应用程序应该工作。由于您使用了 spring-boot-starter-parentPOM,run因此您可以使用一个有用的目标来启动应用程序。mvn spring-boot:run从根项目目录中键入以启动应用程序。您应该看到类似于以下内容的输出:
e following:
$ mvn spring-boot:run
. ____ _ __ _ _
/\ / ___'_ __ _ _(_)_ __ __ _ \ \ \ \
( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \
\/ ___)| |_)| | | | | || (_| | ) ) ) )
' |____| .__|_| |_|_| |_\__, | / / / /
=========|_|==============|___/=/_/_/_/
:: Spring Boot :: (v2.0.0.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包依赖的归档(archives)。
可执行jar和Java
Java不提供任何标准的方法来加载嵌套的jar文件(即本身包含在jar中的jar文件)。 如果您正在寻找可以发布自包含的应用程序,这可能是有问题的。
为了解决这个问题,许多开发人员使用“uber” jars。 一个uber jar简单地将所有类、jar包进行档案。 这种方法的问题是,很难看到您在应用程序中实际使用哪些库。 如果在多个jar中使用相同的文件名(但具有不同的内容),也可能会出现问题。
Spring Boot采用一个不同的方法这样可以直接对jar进行嵌套。
要创建可执行的jar,我们需要将spring-boot-maven-plugin添加到我们的pom.xml中。 在 dependencies标签 下方插入以下行:
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
spring-boot-starter-parent POM 包括重新打包目标的 executions标签 配置。 如果您不使用该父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.0.0.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.0.0.RELEASE)
....... . . .
....... . . . (log output here)
....... . . .
........ Started Example in 2.536 seconds (JVM running for 2.864)
像之前一样,ctrl+c正常退出应用程序。