1. 准备
在开始之前,打开终端并运行以下命令,以确保安装了有效的Java和Maven版本:
-
Java 8+:
$ 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)
-
Maven 3.3+:
.\conf\settings.xml
:<mirrors> <mirror> <id>nexus-aliyun</id> <mirrorOf>central</mirrorOf> <name>Nexus aliyun</name> <url>http://maven.aliyun.com/nexus/content/groups/public</url> </mirror> </mirrors> <profiles> <profile> <id>jdk-1.8</id> <activation> <activeByDefault>true</activeByDefault> <jdk>1.8</jdk> </activation> <properties> <maven.compiler.source>1.8</maven.compiler.source> <maven.compiler.target>1.8</maven.compiler.target> <maven.compiler.compilerVersion>1.8</maven.compiler.compilerVersion> </properties> </profile> </profiles>
$ 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
-
IDEA 2019.1.2+。
2. Hello World
需求: 浏览发送 /hello
请求,响应 Hello World!
2.1. 创建Maven工程并引入依赖
<?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>boot-01-helloworld</artifactId>
<version>1.0-SNAPSHOT</version>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.4.2</version>
</parent>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
</dependencies>
</project>
spring-boot-starter-parent
本身不提供任何依赖关系,在 <parent>
下方添加 spring-boot-starter-web
依赖可立即导入所需外部依赖:
2.2. 创建主程序
package com.example;
import org.springframework.boot.*;
import org.springframework.boot.autoconfigure.*;
import org.springframework.web.bind.annotation.*;
@RestController
@EnableAutoConfiguration
public class Example {
@RequestMapping("/hello")
String home() {
return "Hello World!";
}
public static void main(String[] args) {
SpringApplication.run(Example.class, args);
}
}
-
@RestController: 被称为构造型注解,它提示该类是一个Web Controller,因此Spring在处理传入的Web请求时会考虑使用它;
-
@RequestMapping: 提供路由信息,它将任何带有
/hello
路径的HTTP请求都映射到home方法,@RestController注解会将home方法return的结果直接返回给调用方;@RestController和@RequestMapping是Spring MVC注解,它们不是专为Spring Boot制定的。
-
@EnableAutoConfiguration: 自动配置注解,该注解会根据添加的jar依赖关系“猜测”您如何配置Spring。
这里由于spring-boot-starter-web添加了Tomcat和Spring MVC,因此自动配置假定您在开发一个Web应用程序并相应地设置了Spring。
自动配置旨在与starter(启动器)配合使用,但是这两个概念并不直接相关。您可以在starter之外自由选择jar依赖,Spring Boot仍会尽最大努力来自动配置应用程序;
-
main方法: main方法通过调用SpringApplication类的run方法以引导应用程序并启动Spring,后者又会启动自动配置的Tomcat Web服务器。
参数Example.class用于告诉SpringApplication哪个是主Spring组件;
参数args数组用于展示各种命令行参数。
2.3. 运行主程序
- 运行main方法:
. ____ _ __ _ _ /\\ / ___'_ __ _ _(_)_ __ __ _ \ \ \ \ ( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \ \\/ ___)| |_)| | | | | || (_| | ) ) ) ) ' |____| .__|_| |_|_| |_\__, | / / / / =========|_|==============|___/=/_/_/_/ :: Spring Boot :: (v2.4.2) 2021-01-28 16:53:12.347 INFO 16176 --- [ main] com.example.Example : Starting Example using Java 1.8.0_251 on ERNEST-CHANG with PID 16176 (E:\develop\study-demo\atguigu\boot-01-helloworld\target\classes started by Administrator in E:\develop\study-demo\atguigu\boot-01-helloworld) 2021-01-28 16:53:12.349 INFO 16176 --- [ main] com.example.Example : No active profile set, falling back to default profiles: default 2021-01-28 16:53:12.781 INFO 16176 --- [ main] o.s.b.w.embedded.tomcat.TomcatWebServer : Tomcat initialized with port(s): 8080 (http) 2021-01-28 16:53:12.785 INFO 16176 --- [ main] o.apache.catalina.core.StandardService : Starting service [Tomcat] 2021-01-28 16:53:12.786 INFO 16176 --- [ main] org.apache.catalina.core.StandardEngine : Starting Servlet engine: [Apache Tomcat/9.0.41] 2021-01-28 16:53:12.825 INFO 16176 --- [ main] o.a.c.c.C.[Tomcat].[localhost].[/] : Initializing Spring embedded WebApplicationContext 2021-01-28 16:53:12.825 INFO 16176 --- [ main] w.s.c.ServletWebServerApplicationContext : Root WebApplicationContext: initialization completed in 449 ms 2021-01-28 16:53:12.916 INFO 16176 --- [ main] o.s.s.concurrent.ThreadPoolTaskExecutor : Initializing ExecutorService 'applicationTaskExecutor' 2021-01-28 16:53:13.017 INFO 16176 --- [ main] o.s.b.w.embedded.tomcat.TomcatWebServer : Tomcat started on port(s): 8080 (http) with context path '' 2021-01-28 16:53:13.024 INFO 16176 --- [ main] com.example.Example : Started Example in 0.888 seconds (JVM running for 1.306)
- 浏览器输入url:
localhost:8080/hello
2.4. 生成可执行jar文件
将项目生成为可执行jar文件(有时称为“胖jar”,因其为包含 已编译类 和 代码运行所需的各依赖jar包 的归档文件)。
Java本身并没有提供加载嵌套jar文件(jar文件中包含其他jar文件)的标准方法。为了解决这个问题,许多开发人员使用
uber-jar
,将应用程序依赖的所有类打包到单个jar包中,这种方法存在两个问题:
1. 很难查看应用程序中包含哪些库;
2. 多个jar文件使用相同文件名可能会产生问题。为此,Spring Boot设计了
spring-boot-loader
模块,允许直接嵌套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>
在命令行中运行 mvn package
,或者在IDEA中点击:
返回信息如下所示:
$ mvn package
[INFO] Scanning for projects...
[INFO]
[INFO] -------------------< com.example:boot-01-helloworld >-------------------
[INFO] Building boot-01-helloworld 1.0-SNAPSHOT
[INFO] --------------------------------[ jar ]---------------------------------
[INFO]
[INFO] --- maven-resources-plugin:3.2.0:resources (default-resources) @ boot-01-helloworld ---
[INFO] Using 'UTF-8' encoding to copy filtered resources.
[INFO] Using 'UTF-8' encoding to copy filtered properties files.
[INFO] Copying 0 resource
[INFO] Copying 0 resource
[INFO]
[INFO] --- maven-compiler-plugin:3.8.1:compile (default-compile) @ boot-01-helloworld ---
[INFO] Changes detected - recompiling the module!
[INFO] Compiling 1 source file to E:\develop\study-demo\atguigu\boot-01-helloworld\target\classes
[INFO]
[INFO] --- maven-resources-plugin:3.2.0:testResources (default-testResources) @ boot-01-helloworld ---
[INFO] Using 'UTF-8' encoding to copy filtered resources.
[INFO] Using 'UTF-8' encoding to copy filtered properties files.
[INFO] skip non existing resourceDirectory E:\develop\study-demo\atguigu\boot-01-helloworld\src\test\resources
[INFO]
[INFO] --- maven-compiler-plugin:3.8.1:testCompile (default-testCompile) @ boot-01-helloworld ---
[INFO] Changes detected - recompiling the module!
[INFO]
[INFO] --- maven-surefire-plugin:2.22.2:test (default-test) @ boot-01-helloworld ---
[INFO]
[INFO] --- maven-jar-plugin:3.2.0:jar (default-jar) @ boot-01-helloworld ---
[INFO] Building jar: E:\develop\study-demo\atguigu\boot-01-helloworld\target\boot-01-helloworld-1.0-SNAPSHOT.jar
[INFO]
[INFO] --- spring-boot-maven-plugin:2.4.2:repackage (repackage) @ boot-01-helloworld ---
[INFO] Replacing main artifact with repackaged archive
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 9.889 s
[INFO] Finished at: 2021-01-28T16:45:38+08:00
[INFO] ------------------------------------------------------------------------
此时,查看 target
目录可看到 boot-01-helloworld-1.0-SNAPSHOT.jar
。
在 target
目录中还有一个名为 boot-01-helloworld-1.0-SNAPSHOT.jar.original
的小得多的文件,这是Maven在Spring Boot重新打包之前创建的原始jar文件。
如果想窥探其内部所有依赖的jar文件,可以在 target
目录下使用 jar tvf
命令。
其中,自己写的代码的class文件和配置文件都在 BOOT-INF
目录下,自己的代码所依赖的jar文件在 BOOT-INF/lib
目录下,如下所示:
$ jar tvf boot-01-helloworld-1.0-SNAPSHOT.jar
0 Thu Jan 28 16:54:40 CST 2021 META-INF/
453 Thu Jan 28 16:54:40 CST 2021 META-INF/MANIFEST.MF
0 Fri Feb 01 00:00:00 CST 1980 org/
0 Fri Feb 01 00:00:00 CST 1980 org/springframework/
0 Fri Feb 01 00:00:00 CST 1980 org/springframework/boot/
0 Fri Feb 01 00:00:00 CST 1980 org/springframework/boot/loader/
5871 Fri Feb 01 00:00:00 CST 1980 org/springframework/boot/loader/ClassPathIndexFile.class
6806 Fri Feb 01 00:00:00 CST 1980 org/springframework/boot/loader/ExecutableArchiveLauncher.class
3966 Fri Feb 01 00:00:00 CST 1980 org/springframework/boot/loader/JarLauncher.class
1483 Fri Feb 01 00:00:00 CST 1980 org/springframework/boot/loader/LaunchedURLClassLoader$DefinePackageCallType.class
1535 Fri Feb 01 00:00:00 CST 1980 org/springframework/boot/loader/LaunchedURLClassLoader$UseFastConnectionExceptionsEnumeration.class
11154 Fri Feb 01 00:00:00 CST 1980 org/springframework/boot/loader/LaunchedURLClassLoader.class
5932 Fri Feb 01 00:00:00 CST 1980 org/springframework/boot/loader/Launcher.class
1536 Fri Feb 01 00:00:00 CST 1980 org/springframework/boot/loader/MainMethodRunner.class
266 Fri Feb 01 00:00:00 CST 1980 org/springframework/boot/loader/PropertiesLauncher$1.class
1484 Fri Feb 01 00:00:00 CST 1980 org/springframework/boot/loader/PropertiesLauncher$ArchiveEntryFilter.class
8128 Fri Feb 01 00:00:00 CST 1980 org/springframework/boot/loader/PropertiesLauncher$ClassPathArchives.class
1953 Fri Feb 01 00:00:00 CST 1980 org/springframework/boot/loader/PropertiesLauncher$PrefixMatchingArchiveFilter.class
18267 Fri Feb 01 00:00:00 CST 1980 org/springframework/boot/loader/PropertiesLauncher.class
1750 Fri Feb 01 00:00:00 CST 1980 org/springframework/boot/loader/WarLauncher.class
0 Fri Feb 01 00:00:00 CST 1980 org/springframework/boot/loader/archive/
302 Fri Feb 01 00:00:00 CST 1980 org/springframework/boot/loader/archive/Archive$Entry.class
511 Fri Feb 01 00:00:00 CST 1980 org/springframework/boot/loader/archive/Archive$EntryFilter.class
4745 Fri Feb 01 00:00:00 CST 1980 org/springframework/boot/loader/archive/Archive.class
6093 Fri Feb 01 00:00:00 CST 1980 org/springframework/boot/loader/archive/ExplodedArchive$AbstractIterator.class
2180 Fri Feb 01 00:00:00 CST 1980 org/springframework/boot/loader/archive/ExplodedArchive$ArchiveIterator.class
1857 Fri Feb 01 00:00:00 CST 1980 org/springframework/boot/loader/archive/ExplodedArchive$EntryIterator.class
1269 Fri Feb 01 00:00:00 CST 1980 org/springframework/boot/loader/archive/ExplodedArchive$FileEntry.class
2527 Fri Feb 01 00:00:00 CST 1980 org/springframework/boot/loader/archive/ExplodedArchive$SimpleJarFileArchive.class
5346 Fri Feb 01 00:00:00 CST 1980 org/springframework/boot/loader/archive/ExplodedArchive.class
2884 Fri Feb 01 00:00:00 CST 1980 org/springframework/boot/loader/archive/JarFileArchive$AbstractIterator.class
1981 Fri Feb 01 00:00:00 CST 1980 org/springframework/boot/loader/archive/JarFileArchive$EntryIterator.class
1081 Fri Feb 01 00:00:00 CST 1980 org/springframework/boot/loader/archive/JarFileArchive$JarFileEntry.class
2528 Fri Feb 01 00:00:00 CST 1980 org/springframework/boot/loader/archive/JarFileArchive$NestedArchiveIterator.class
7569 Fri Feb 01 00:00:00 CST 1980 org/springframework/boot/loader/archive/JarFileArchive.class
0 Fri Feb 01 00:00:00 CST 1980 org/springframework/boot/loader/data/
485 Fri Feb 01 00:00:00 CST 1980 org/springframework/boot/loader/data/RandomAccessData.class
282 Fri Feb 01 00:00:00 CST 1980 org/springframework/boot/loader/data/RandomAccessDataFile$1.class
2680 Fri Feb 01 00:00:00 CST 1980 org/springframework/boot/loader/data/RandomAccessDataFile$DataInputStream.class
3259 Fri Feb 01 00:00:00 CST 1980 org/springframework/boot/loader/data/RandomAccessDataFile$FileAccess.class
4015 Fri Feb 01 00:00:00 CST 1980 org/springframework/boot/loader/data/RandomAccessDataFile.class
0 Fri Feb 01 00:00:00 CST 1980 org/springframework/boot/loader/jar/
1438 Fri Feb 01 00:00:00 CST 1980 org/springframework/boot/loader/jar/AbstractJarFile$JarFileType.class
878 Fri Feb 01 00:00:00 CST 1980 org/springframework/boot/loader/jar/AbstractJarFile.class
4976 Fri Feb 01 00:00:00 CST 1980 org/springframework/boot/loader/jar/AsciiBytes.class
616 Fri Feb 01 00:00:00 CST 1980 org/springframework/boot/loader/jar/Bytes.class
295 Fri Feb 01 00:00:00 CST 1980 org/springframework/boot/loader/jar/CentralDirectoryEndRecord$1.class
3401 Fri Feb 01 00:00:00 CST 1980 org/springframework/boot/loader/jar/CentralDirectoryEndRecord$Zip64End.class
2004 Fri Feb 01 00:00:00 CST 1980 org/springframework/boot/loader/jar/CentralDirectoryEndRecord$Zip64Locator.class
4682 Fri Feb 01 00:00:00 CST 1980 org/springframework/boot/loader/jar/CentralDirectoryEndRecord.class
6223 Fri Feb 01 00:00:00 CST 1980 org/springframework/boot/loader/jar/CentralDirectoryFileHeader.class
4620 Fri Feb 01 00:00:00 CST 1980 org/springframework/boot/loader/jar/CentralDirectoryParser.class
540 Fri Feb 01 00:00:00 CST 1980 org/springframework/boot/loader/jar/CentralDirectoryVisitor.class
345 Fri Feb 01 00:00:00 CST 1980 org/springframework/boot/loader/jar/FileHeader.class
12880 Fri Feb 01 00:00:00 CST 1980 org/springframework/boot/loader/jar/Handler.class
3885 Fri Feb 01 00:00:00 CST 1980 org/springframework/boot/loader/jar/JarEntry.class
1458 Fri Feb 01 00:00:00 CST 1980 org/springframework/boot/loader/jar/JarEntryCertification.class
299 Fri Feb 01 00:00:00 CST 1980 org/springframework/boot/loader/jar/JarEntryFilter.class
2296 Fri Feb 01 00:00:00 CST 1980 org/springframework/boot/loader/jar/JarFile$1.class
1299 Fri Feb 01 00:00:00 CST 1980 org/springframework/boot/loader/jar/JarFile$JarEntryEnumeration.class
16136 Fri Feb 01 00:00:00 CST 1980 org/springframework/boot/loader/jar/JarFile.class
1368 Fri Feb 01 00:00:00 CST 1980 org/springframework/boot/loader/jar/JarFileEntries$1.class
2258 Fri Feb 01 00:00:00 CST 1980 org/springframework/boot/loader/jar/JarFileEntries$EntryIterator.class
16395 Fri Feb 01 00:00:00 CST 1980 org/springframework/boot/loader/jar/JarFileEntries.class
3390 Fri Feb 01 00:00:00 CST 1980 org/springframework/boot/loader/jar/JarFileWrapper.class
702 Fri Feb 01 00:00:00 CST 1980 org/springframework/boot/loader/jar/JarURLConnection$1.class
4302 Fri Feb 01 00:00:00 CST 1980 org/springframework/boot/loader/jar/JarURLConnection$JarEntryName.class
9440 Fri Feb 01 00:00:00 CST 1980 org/springframework/boot/loader/jar/JarURLConnection.class
3559 Fri Feb 01 00:00:00 CST 1980 org/springframework/boot/loader/jar/StringSequence.class
1813 Fri Feb 01 00:00:00 CST 1980 org/springframework/boot/loader/jar/ZipInflaterInputStream.class
0 Fri Feb 01 00:00:00 CST 1980 org/springframework/boot/loader/jarmode/
293 Fri Feb 01 00:00:00 CST 1980 org/springframework/boot/loader/jarmode/JarMode.class
2201 Fri Feb 01 00:00:00 CST 1980 org/springframework/boot/loader/jarmode/JarModeLauncher.class
1292 Fri Feb 01 00:00:00 CST 1980 org/springframework/boot/loader/jarmode/TestJarMode.class
0 Fri Feb 01 00:00:00 CST 1980 org/springframework/boot/loader/util/
5174 Fri Feb 01 00:00:00 CST 1980 org/springframework/boot/loader/util/SystemPropertyUtils.class
0 Thu Jan 28 16:54:40 CST 2021 BOOT-INF/
0 Thu Jan 28 16:54:40 CST 2021 BOOT-INF/classes/
0 Thu Jan 28 16:53:12 CST 2021 BOOT-INF/classes/com/
0 Thu Jan 28 16:53:12 CST 2021 BOOT-INF/classes/com/example/
0 Thu Jan 28 16:54:42 CST 2021 META-INF/maven/
0 Thu Jan 28 16:54:42 CST 2021 META-INF/maven/com.example/
0 Thu Jan 28 16:54:42 CST 2021 META-INF/maven/com.example/boot-01-helloworld/
967 Thu Jan 28 16:53:12 CST 2021 BOOT-INF/classes/com/example/Example.class
1038 Thu Jan 28 16:35:26 CST 2021 META-INF/maven/com.example/boot-01-helloworld/pom.xml
74 Thu Jan 28 16:45:34 CST 2021 META-INF/maven/com.example/boot-01-helloworld/pom.properties
0 Thu Jan 28 16:54:40 CST 2021 BOOT-INF/lib/
1310004 Fri Jan 15 02:56:38 CST 2021 BOOT-INF/lib/spring-boot-2.4.2.jar
1538698 Fri Jan 15 02:56:04 CST 2021 BOOT-INF/lib/spring-boot-autoconfigure-2.4.2.jar
290339 Fri Mar 31 20:20:12 CST 2017 BOOT-INF/lib/logback-classic-1.2.3.jar
471901 Fri Mar 31 20:19:58 CST 2017 BOOT-INF/lib/logback-core-1.2.3.jar
41472 Mon Dec 16 22:03:32 CST 2019 BOOT-INF/lib/slf4j-api-1.7.30.jar
17461 Sun May 10 12:10:04 CST 2020 BOOT-INF/lib/log4j-to-slf4j-2.13.3.jar
292301 Sun May 10 12:07:56 CST 2020 BOOT-INF/lib/log4j-api-2.13.3.jar
4592 Mon Dec 16 22:00:18 CST 2019 BOOT-INF/lib/jul-to-slf4j-1.7.30.jar
25058 Fri Aug 02 11:08:52 CST 2019 BOOT-INF/lib/jakarta.annotation-api-1.3.5.jar
1467336 Fri Feb 01 00:00:00 CST 1980 BOOT-INF/lib/spring-core-5.3.3.jar
23943 Tue Jan 12 06:27:34 CST 2021 BOOT-INF/lib/spring-jcl-5.3.3.jar
310104 Fri Sep 11 14:52:46 CST 2020 BOOT-INF/lib/snakeyaml-1.27.jar
1421841 Sat Dec 12 00:36:08 CST 2020 BOOT-INF/lib/jackson-databind-2.11.4.jar
72086 Sat Dec 12 00:05:54 CST 2020 BOOT-INF/lib/jackson-annotations-2.11.4.jar
351519 Sat Dec 12 00:10:22 CST 2020 BOOT-INF/lib/jackson-core-2.11.4.jar
34334 Sat Dec 12 00:50:44 CST 2020 BOOT-INF/lib/jackson-datatype-jdk8-2.11.4.jar
111009 Sat Dec 12 00:50:32 CST 2020 BOOT-INF/lib/jackson-datatype-jsr310-2.11.4.jar
9269 Sat Dec 12 00:50:38 CST 2020 BOOT-INF/lib/jackson-module-parameter-names-2.11.4.jar
3409747 Thu Dec 03 11:38:48 CST 2020 BOOT-INF/lib/tomcat-embed-core-9.0.41.jar
237826 Mon Aug 26 10:58:30 CST 2019 BOOT-INF/lib/jakarta.el-3.0.3.jar
271820 Thu Dec 03 11:38:48 CST 2020 BOOT-INF/lib/tomcat-embed-websocket-9.0.41.jar
1565794 Tue Jan 12 06:28:40 CST 2021 BOOT-INF/lib/spring-web-5.3.3.jar
695878 Tue Jan 12 06:28:18 CST 2021 BOOT-INF/lib/spring-beans-5.3.3.jar
996262 Tue Jan 12 06:28:52 CST 2021 BOOT-INF/lib/spring-webmvc-5.3.3.jar
374340 Tue Jan 12 06:28:22 CST 2021 BOOT-INF/lib/spring-aop-5.3.3.jar
1243858 Tue Jan 12 06:28:32 CST 2021 BOOT-INF/lib/spring-context-5.3.3.jar
282517 Tue Jan 12 06:28:08 CST 2021 BOOT-INF/lib/spring-expression-5.3.3.jar
32913 Fri Feb 01 00:00:00 CST 1980 BOOT-INF/lib/spring-boot-jarmode-layertools-2.4.2.jar
1230 Thu Jan 28 16:54:40 CST 2021 BOOT-INF/classpath.idx
212 Thu Jan 28 16:54:40 CST 2021 BOOT-INF/layers.idx
使用 java -jar
命令,即可直接运行该应用程序,如下所示:
Windows系统控制台须注意取消“快速编辑模式”。