前言
10年專注建站、設(shè)計、互聯(lián)網(wǎng)產(chǎn)品按需求定制網(wǎng)站服務(wù),業(yè)務(wù)涵蓋成都品牌網(wǎng)站建設(shè)、商城網(wǎng)站制作、重慶小程序開發(fā)、軟件系統(tǒng)開發(fā)、App定制開發(fā)等。憑借多年豐富的經(jīng)驗,我們會仔細(xì)了解每個客戶的需求而做出多方面的分析、設(shè)計、整合,為客戶設(shè)計出具風(fēng)格及創(chuàng)意性的商業(yè)解決方案,創(chuàng)新互聯(lián)更提供一系列網(wǎng)站制作和網(wǎng)站推廣的服務(wù),以推動各中小企業(yè)全面信息數(shù)字化,并利用創(chuàng)新技術(shù)幫助各行業(yè)提升企業(yè)形象和運(yùn)營效率。
使用過Spring Boot,我們都知道通過java -jar可以快速啟動Spring Boot項目。同時,也可以通過在執(zhí)行jar -jar時傳遞參數(shù)來進(jìn)行配置。本文帶大家系統(tǒng)的了解一下Spring Boot命令行參數(shù)相關(guān)的功能及相關(guān)源碼分析。
命令行參數(shù)使用
啟動Spring Boot項目時,我們可以通過如下方式傳遞參數(shù):
java -jar xxx.jar --server.port=8081
默認(rèn)情況下Spring Boot使用8080端口,通過上述參數(shù)將其修改為8081端口,而且通過命令行傳遞的參數(shù)具有更高的優(yōu)先級,會覆蓋同名的其他配置參數(shù)。
啟動Spring Boot項目時傳遞參數(shù),有三種參數(shù)形式:
選項參數(shù),上面的示例便是選項參數(shù)的使用方法,通過“–-server.port”來設(shè)置應(yīng)用程序的端口。基本格式為“–name=value”(“–”為連續(xù)兩個減號)。其配置作用等價于在application.properties中配置的server.port=8081。
非選項參數(shù)的使用示例如下:
java -jar xxx.jar abc def
上述示例中,“abc”和“def”便是非選項參數(shù)。
系統(tǒng)參數(shù),該參數(shù)會被設(shè)置到系統(tǒng)變量中,使用示例如下:
java -jar -Dserver.port=8081 xxx.jar
參數(shù)值的獲取
選項參數(shù)和非選項參數(shù)均可以通過ApplicationArguments接口獲取,具體獲取方法直接在使用參數(shù)的類中注入該接口即可。
@RestController public class ArgumentsController { @Resource private ApplicationArguments arguments; }
通過ApplicationArguments接口提供的方法即可獲得對應(yīng)的參數(shù)。關(guān)于該接口后面會詳細(xì)講解。
另外,選項參數(shù),也可以直接通過@Value在類中獲取,如下:
@RestController public class ParamController { @Value("${server.port}") private String serverPort; }
系統(tǒng)參數(shù)可以通過java.lang.System提供的方法獲取:
String systemServerPort = System.getProperty("server.port");
參數(shù)值的區(qū)別
關(guān)于參數(shù)值區(qū)別,重點(diǎn)看選項參數(shù)和系統(tǒng)參數(shù)。通過上面的示例我們已經(jīng)發(fā)現(xiàn)使用選項參數(shù)時,參數(shù)在命令中是位于xxx.jar之后傳遞的,而系統(tǒng)參數(shù)是緊隨java -jar之后。
如果不按照該順序進(jìn)行執(zhí)行,比如使用如下方式使用選項參數(shù):
java -jar --server.port=8081 xxx.jar
則會拋出如下異常:
Unrecognized option: --server.port=8081
Error: Could not create the Java Virtual Machine.
Error: A fatal exception has occurred. Program will exit.
如果將系統(tǒng)參數(shù)放在jar包后面,問題會更嚴(yán)重。會出現(xiàn)可以正常啟動,但參數(shù)無法生效。這也是為什么有時候明明傳遞了參數(shù)但是卻未生效,那很可能是因為把參數(shù)的位置寫錯了。
這個錯誤是最坑的,所以一定謹(jǐn)記:通過-D傳遞系統(tǒng)參數(shù)時,務(wù)必放置在待執(zhí)行的jar包之前。
另外一個重要的不同是:通過@Value形式可以獲得系統(tǒng)參數(shù)和選項參數(shù),但通過System.getProperty方法只能獲得系統(tǒng)參數(shù)。
ApplicationArguments解析
上面提到了可以通過注入ApplicationArguments接口獲得相關(guān)參數(shù),下面看一下具體的使用示例:
@RestController public class ArgumentsController { @Resource private ApplicationArguments arguments; @GetMapping("/args") public String getArgs() { System.out.println("# 非選項參數(shù)數(shù)量: " + arguments.getNonOptionArgs().size()); System.out.println("# 選項參數(shù)數(shù)量: " + arguments.getOptionNames().size()); System.out.println("# 非選項具體參數(shù):"); arguments.getNonOptionArgs().forEach(System.out::println); System.out.println("# 選項參數(shù)具體參數(shù):"); arguments.getOptionNames().forEach(optionName -> { System.out.println("--" + optionName + "=" + arguments.getOptionValues(optionName)); }); return "success"; } }
通過注入ApplicationArguments接口,然后在方法中調(diào)用該接口的方法即可獲得對應(yīng)的參數(shù)信息。
ApplicationArguments接口中封裝了啟動時原始參數(shù)的數(shù)組、選項參數(shù)的列表、非選項參數(shù)的列表以及選項參數(shù)獲得和檢驗。相關(guān)源碼如下:
public interface ApplicationArguments { /** * 原始參數(shù)數(shù)組(未經(jīng)過處理的參數(shù)) */ String[] getSourceArgs(); /** * 選項參數(shù)名稱 */ Set<String> getOptionNames(); /** * 根據(jù)名稱校驗是否包含選項參數(shù) */ boolean containsOption(String name); /** * 根據(jù)名稱獲得選項參數(shù) */ List<String> getOptionValues(String name); /** * 獲取非選項參數(shù)列表 */ List<String> getNonOptionArgs(); }
命令行參數(shù)的解析
上面直接使用了ApplicationArguments的注入和方法,那么它的對象是何時被創(chuàng)建,何時被注入Spring容器的?
在執(zhí)行SpringApplication的run方法的過程中會獲得傳入的參數(shù),并封裝為ApplicationArguments對象。相關(guān)源代碼如下:
public ConfigurableApplicationContext run(String... args) { try { ApplicationArguments applicationArguments = new DefaultApplicationArguments(args); // ... prepareContext(context, environment, listeners, // ... } catch (Throwable ex) { // ... } return context; }
在上述代碼中,通過創(chuàng)建一個它的實現(xiàn)類DefaultApplicationArguments來完成命令行參數(shù)的解析。
DefaultApplicationArguments部分代碼如下:
public class DefaultApplicationArguments implements ApplicationArguments { private final Source source; private final String[] args; public DefaultApplicationArguments(String... args) { Assert.notNull(args, "Args must not be null"); this.source = new Source(args); this.args = args; } // ... @Override public List<String> getOptionValues(String name) { List<String> values = this.source.getOptionValues(name); return (values != null) ? Collections.unmodifiableList(values) : null; } private static class Source extends SimpleCommandLinePropertySource { Source(String[] args) { super(args); } // ... } }
通過構(gòu)造方法,將args賦值給成員變量args,其中接口ApplicationArguments中g(shù)etSourceArgs方法的實現(xiàn)在該類中便是返回args值。
針對成員變量Source(內(nèi)部類)的設(shè)置,在創(chuàng)建Source對象時調(diào)用了其父類SimpleCommandLinePropertySource的構(gòu)造方法:
public SimpleCommandLinePropertySource(String... args) { super(new SimpleCommandLineArgsParser().parse(args)); }
在該方法中創(chuàng)建了真正的解析器SimpleCommandLineArgsParser并調(diào)用其parse方法對參數(shù)進(jìn)行解析。
class SimpleCommandLineArgsParser { public CommandLineArgs parse(String... args) { CommandLineArgs commandLineArgs = new CommandLineArgs(); for (String arg : args) { // --開頭的選參數(shù)解析 if (arg.startsWith("--")) { // 獲得key=value或key值 String optionText = arg.substring(2, arg.length()); String optionName; String optionValue = null; // 如果是key=value格式則進(jìn)行解析 if (optionText.contains("=")) { optionName = optionText.substring(0, optionText.indexOf('=')); optionValue = optionText.substring(optionText.indexOf('=')+1, optionText.length()); } else { // 如果是僅有key(--foo)則獲取其值 optionName = optionText; } // 如果optionName為空或者optionValue不為空但optionName為空則拋出異常 if (optionName.isEmpty() || (optionValue != null && optionValue.isEmpty())) { throw new IllegalArgumentException("Invalid argument syntax: " + arg); } // 封裝入CommandLineArgs commandLineArgs.addOptionArg(optionName, optionValue); } else { commandLineArgs.addNonOptionArg(arg); } } return commandLineArgs; } }
上述解析規(guī)則比較簡單,就是根據(jù)“–”和“=”來區(qū)分和解析不同的參數(shù)類型。
通過上面的方法創(chuàng)建了ApplicationArguments的實現(xiàn)類的對象,但此刻還并未注入Spring容器,注入Spring容器是依舊是通過上述SpringApplication#run方法中調(diào)用的prepareContext方法來完成的。相關(guān)代碼如下:
private void prepareContext(ConfigurableApplicationContext context, ConfigurableEnvironment environment, SpringApplicationRunListeners listeners, ApplicationArguments applicationArguments, Banner printedBanner) { // ... ConfigurableListableBeanFactory beanFactory = context.getBeanFactory(); // 通過beanFactory將ApplicationArguments的對象注入Spring容器 beanFactory.registerSingleton("springApplicationArguments", applicationArguments); // ... }
至此,關(guān)于Spring Boot中ApplicationArguments的相關(guān)源碼解析完成。
總結(jié)
以上就是這篇文章的全部內(nèi)容了,希望本文的內(nèi)容對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值,謝謝大家對創(chuàng)新互聯(lián)的支持。
網(wǎng)頁名稱:SPRINGBOOT啟動命令參數(shù)及源碼詳析
地址分享:http://muchs.cn/article30/jcjiso.html
成都網(wǎng)站建設(shè)公司_創(chuàng)新互聯(lián),為您提供關(guān)鍵詞優(yōu)化、建站公司、品牌網(wǎng)站設(shè)計、云服務(wù)器、網(wǎng)站維護(hù)、網(wǎng)站排名
聲明:本網(wǎng)站發(fā)布的內(nèi)容(圖片、視頻和文字)以用戶投稿、用戶轉(zhuǎn)載內(nèi)容為主,如果涉及侵權(quán)請盡快告知,我們將會在第一時間刪除。文章觀點(diǎn)不代表本網(wǎng)站立場,如需處理請聯(lián)系客服。電話:028-86922220;郵箱:631063699@qq.com。內(nèi)容未經(jīng)允許不得轉(zhuǎn)載,或轉(zhuǎn)載時需注明來源: 創(chuàng)新互聯(lián)