SpringBoot2.x基础篇:应用程序在启动时访问启动项参数

SpringBoot应用程序在启动时,我们可以传递自定义的参数来进行动态控制逻辑,比如我们使用--debug启动参数时就会使用debug启动应用程序,在控制台打印一些调试日志信息。

推荐阅读

什么是启动项参数?

启动项参数的格式一般是--开头的,如:java -jar service.jar --debug --skip,启动时我们就可以获取[debug,skip]两个启动项参数。

SpringBoot 内部提供了一个接口org.springframework.boot.ApplicationArguments来接收应用程序在启动时所传递的选项参数(Option Args),源码如下所示:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
public interface ApplicationArguments {

/**
* 返回未处理的原始参数列表
* @return the arguments
*/
String[] getSourceArgs();

/**
* 返回所有选项参数的名称
* For example, if the arguments were
* "--foo=bar --debug" would return the values {@code ["foo", "debug"]}.
* @return the option names or an empty set
*/
Set<String> getOptionNames();

/**
* 根据选项参数名称判断是否在启动时传递
* option with the given name.
* @param name the name to check
* @return {@code true} if the arguments contain an option with the given name
*/
boolean containsOption(String name);

/**
* 返回与具有给定名称的arguments选项关联的值的集合。
* <ul>
* <li>if the option is present and has no argument (e.g.: "--foo"), return an empty
* collection ({@code []})</li>
* <li>if the option is present and has a single value (e.g. "--foo=bar"), return a
* collection having one element ({@code ["bar"]})</li>
* <li>if the option is present and has multiple values (e.g. "--foo=bar --foo=baz"),
* return a collection having elements for each value ({@code ["bar", "baz"]})</li>
* <li>if the option is not present, return {@code null}</li>
* </ul>
* @param name the name of the option
* @return a list of option values for the given name
*/
List<String> getOptionValues(String name);

/**
* 返回分析的非选项参数的集合。
* @return the non-option arguments or an empty list
*/
List<String> getNonOptionArgs();
}

该接口有一个默认的实现DefaultApplicationArguments,它实现了ApplicationArguments接口的全部定义方法。

DefaultApplicationArguments类在org.springframework.boot.SpringApplication#run(java.lang.String...)方法内通过new进行实例化,该对象实例主要用于启动时的相关配置。

而在启动过程中的org.springframework.boot.SpringApplication#prepareContext方法内通过ConfigurableListableBeanFactory进行注册到IOC容器,并且把springApplicationArguments作为唯一名称。

获取启动项参数

上面我们说道,在应用启动时会将ApplicationArguments接口的实现类实例注册到IOC容器,所以我们可以使用注入ApplicationArguments接口的形式来获取启动项参数,如下所示:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
/**
* 加载启动项参数
*
* @author 恒宇少年
*/
@Component
public class LoadArguments {
/**
* 构造函数注入{@link ApplicationArguments}
*
* @param applicationArguments
*/
@Autowired
public LoadArguments(ApplicationArguments applicationArguments) {
// 判断是否存在名为skip的启动项参数
boolean isHaveSkip = applicationArguments.containsOption("skip");
System.out.println("skip:" + isHaveSkip);
// 遍历输出全部的非启动项参数
List<String> arguments = applicationArguments.getNonOptionArgs();
for (int i = 0; i < arguments.size(); i++) {
System.out.println("非启动项参数:" + arguments.get(i));
}
}
}

我们把项目通过mvn package命令进行打包后,使用如下命令启动:

1
java -jar spring-boot-basic-accessing-application-arguments-0.0.1-SNAPSHOT.jar --skip noway

当我们启动后控制台会输出如下内容:

1
2
3
4
...
skip:true
非启动项参数:noway
...

其中--skip为启动项参数,而后面携带的noway其实是不属于skip启动参数,如果我们使用--skip=noway作为启动参数时,调用ApplicationArguments#getOptionValues("skip")方法获取到的值则是noway

ApplicationRunner

除了通过注入ApplicationArguments的方式获取启动参数外,通过实现ApplicationRunner接口也可以获取ApplicationArguments对象实例,使用方法如下所示:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
/**
* {@link ApplicationRunner} 实现类
*
* @author 恒宇少年
*/
@Component
public class ApplicationRunnerSupport implements ApplicationRunner {
@Override
public void run(ApplicationArguments args) throws Exception {
boolean isHaveSkip = args.containsOption("skip");
System.out.println("skip:" + isHaveSkip);
System.out.println(args.getOptionValues("skip"));
}
}

注意事项:实现ApplicationRunner接口的类需要通过@Component标注,通过注解方式注册到IOC容器。

敲黑板,划重点

我们可以通过注入ApplicationRunner这两种方法来获取ApplicationArguments对象,那你知道这两种方法的执行先后顺序吗?带着这个疑问可以动手实验下。

代码示例

如果您喜欢本篇文章请为源码仓库点个Star,谢谢!!!
本篇文章示例源码可以通过以下途径获取,目录为spring-boot-basic-accessing-application-arguments

SpringBoot2.x基础篇:应用程序在启动时发布ApplicationEvents要怎么注册监听?

SpringFramework编写过程中使用了大量的Event/Listener来做一些解耦的任务工作,当然在SpringBoot内同样也沿用了这一点,如果你看过我写的 业务解耦利器Event/Listener ,你应该了解事件的发布都是由ApplicationContext进行控制,但是在SpringBoot启动过程中有一些Event是在ApplicationContext实例化之前发布的,那我们要怎么去监听这些Events呢?

SpringBoot2.x基础篇:带你了解扫描Package自动注册Bean

我们一直在使用SpringBoot来开发应用程序,但是为什么在项目启动时就会自动注册使用注解@Component@Service@RestController…标注的Bean呢?

SpringBoot2.x基础篇:Linux后台运行Jar以及Jvm参数调优

我们将编写的应用程序打包为Jar可执行文件后,如果在Linux服务器环境下,可直接使用java -jar xxx.jar命令运行应用程序,不过当我们关闭命令窗口后启动中的应用程序也会停止,那我们需要通过什么方式才可以成为后台服务方式运行呢?

推荐阅读

SpringBoot2.x基础篇:将应用程序打包为可执行Jar

应用程序在编写完成后,有一个重要的阶段就是发布,当我们发布时需要将应用程序进行打包,那通过SpringBoot编写的应用程序该如何打包呢?

推荐阅读

打包方式

应用程序的发布一般有两种形式。

比较传统的方式是外置Tomcat,将应用程序打包成一个xx.war文件,该文件内只有应用程序源码编译后的.class以及配置文件

SpringBoot还提供了另外一种高效率的打包方式,在pom.xml内通过配置maven plugin,执行mvn package打包命令时会将src/main/javasrc/main/resources目录下的全部文件进行打包,最终生成一个xx.jar的文件,由于SpringBoot打包时默认会将Tomcat的相关依赖一并放入到xx.jar内,所以通过java -jar xx.jar命令行的方式可以直接运行。

打包插件

我们通过IDEA创建SpringBoot项目时,一般在pom.xml文件内默认已经添加了打包maven plugin,如下所示:

1
2
3
4
5
6
7
8
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>

注意事项:如果你不是通过spring-boot-starter-parenter方式构建的SpringBoot应用程序,需要手动配置<executions>,有关插件的使用文档,详见 Spring Boot Maven Plugin

执行打包

使用Maven构建的SpringBoot应用程序打包方式很简单,我们只需要通过命令在应用程序的根目录下执行mvn package即可,如下所示:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
➜  developing-first-application git:(2.x) mvn package           
[INFO] Scanning for projects...
[INFO]
[INFO] ----------< org.minbox.chapter:developing-first-application >-----------
[INFO] Building developing-first-application 0.0.1-SNAPSHOT
[INFO] --------------------------------[ jar ]---------------------------------
省略部分编译日志......
[INFO] --- maven-jar-plugin:3.1.2:jar (default-jar) @ developing-first-application ---
[INFO] Building jar: /Users/yuqiyu/study/article-source-code/spring-boot-chapter/developing-first-application/target/developing-first-application-0.0.1-SNAPSHOT.jar
[INFO]
[INFO] --- spring-boot-maven-plugin:2.2.4.RELEASE:repackage (repackage) @ developing-first-application ---
[INFO] Replacing main artifact with repackaged archive
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 4.711 s
[INFO] Finished at: 2020-02-20T15:02:24+08:00
[INFO] ------------------------------------------------------------------------

当控制台出现BUILD SUCCESS时,证明我们本次package已经成功了,当前应用程序的可执行Jar也已经生成,位于target目录下。

打包文件命名

spring-boot-maven-plugin插件打包完成后生成的文件名默认的格式为:<artifactId> + <version>.jar,如:developing-first-application-0.0.1-SNAPSHOT.jar,如果这并不是你想要的格式化,可以通过如下方式进行自定义:

1
2
3
<build>
<finalName>service-application-${version}</finalName>
</build>

注意事项:<finalName><plugins>是同级的配置,可以使用占位符属性${属性名}的方式来进行格式化命名内容,这只是文件的名称,在打包完成后后缀名.jar会自动追加。

跳过测试

项目在打包过程中会自动运行测试,来检查项目是否可以通过运行测试以及测试脚本的执行是否有效,一般这个过程是需要一定时间的,项目内容越多需要的时间就会越久,如果你想跳过这个测试过程,只需要添加一个很简单的<properties>属性配置即可,如下所示:

1
2
3
<properties>
<maven.test.skip>true</maven.test.skip>
</properties>

这样我们再运行mvn package时,就会跳过测试步骤。

运行Jar

要运行该应用程序,可以使用java -jar命令,如下所示:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
➜  developing-first-application git:(2.x) ✗ java -jar target/service-application-0.0.1-SNAPSHOT.jar 

. ____ _ __ _ _
/\\ / ___'_ __ _ _(_)_ __ __ _ \ \ \ \
( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \
\\/ ___)| |_)| | | | | || (_| | ) ) ) )
' |____| .__|_| |_|_| |_\__, | / / / /
=========|_|==============|___/=/_/_/_/
:: Spring Boot :: (v2.2.4.RELEASE)

2020-02-20 15:29:39.615 INFO 3208 --- [ main] o.s.b.w.embedded.tomcat.TomcatWebServer : Tomcat initialized with port(s): 8080 (http)
2020-02-20 15:29:39.626 INFO 3208 --- [ main] o.apache.catalina.core.StandardService : Starting service [Tomcat]
2020-02-20 15:29:39.626 INFO 3208 --- [ main] org.apache.catalina.core.StandardEngine : Starting Servlet engine: [Apache Tomcat/9.0.30]
2020-02-20 15:29:39.953 INFO 3208 --- [ main] o.s.b.w.embedded.tomcat.TomcatWebServer : Tomcat started on port(s): 8080 (http) with context path ''
2020-02-20 15:29:39.955 INFO 3208 --- [ main] o.m.c.d.f.a.DevelopingFirstApplication : Started DevelopingFirstApplication in 1.539 seconds (JVM running for 1.868)

如果想要退出该应用程序,请按Ctrl + C

SpringBoot2.x基础篇:开发你的第一个SpringBoot应用程序

本篇文章是2020年的开篇之作,希望能带给你不一样的阅读体验,能带给给你清晰的阅读思路。

推荐阅读

SpringBoot2.x版本专题文章汇总

被访问0


专题愿景

旨在打造全网免费精而全SpringBoot系列技术文章学习专题,从简单了解核心技术再到源码分析都涵盖在其中,作者在在简书开通的SpringBoot核心技术专题,原创的文章总阅读量已达到数百万,这跟大家的关注与支持息息相关!!!

SpringBoot1.x版本专题文章汇总

被访问0


专题愿景

旨在打造全网免费精而全SpringBoot系列技术文章学习专题,从简单了解核心技术再到源码分析都涵盖在其中,作者在在简书开通的SpringBoot核心技术专题,原创的文章总阅读量已达到数百万,这跟大家的关注与支持息息相关!!!

SpringBoot基础教程专题

被访问0


关于专题

这篇文章涵盖了本博客SpringBoot相关的技术文章,由于文章编写的先后时间不同,所以采用的SpringBoot版本也有一些差异,不过各个版本的变化不会太大,近期的文章都是采用最新的SpringBoot2.x版本进行编写。

SpringBoot使用@ConstructorBinding注解进行配置属性绑定

SpringBoot2.2版本发行后一些新的功能也渐渐的浮出了水面,在之前版本SpringBoot的配置文件与类之间的属性绑定(@ConfigurationProperties)是通过Setter方法来进行绑定对应的配置值,而从2.2版本开始支持了构造函数的方式进行绑定。

Your browser is out-of-date!

Update your browser to view this website correctly. Update my browser now

×