Spring Boot啓動命令參數詳解及源碼分析

使用過Spring Boot，咱們都知道經過java -jar能夠快速啓動Spring Boot項目。同時，也能夠經過在執行jar -jar時傳遞參數來進行配置。本文帶你們系統的瞭解一下Spring Boot命令行參數相關的功能及相關源碼分析。

命令行參數使用

啓動Spring Boot項目時，咱們能夠經過以下方式傳遞參數：

java -jar xxx.jar --server.port=8081

默認狀況下Spring Boot使用8080端口，經過上述參數將其修改成8081端口，並且經過命令行傳遞的參數具備更高的優先級，會覆蓋同名的其餘配置參數。

啓動Spring Boot項目時傳遞參數，有三種參數形式：

• 選項參數
• 非選項參數
• 系統參數

選項參數，上面的示例即是選項參數的使用方法，經過「–-server.port」來設置應用程序的端口。基本格式爲「--name=value」（「--」爲連續兩個減號）。其配置做用等價於在application.properties中配置的server.port=8081。

非選項參數的使用示例以下：

java -jar xxx.jar abc def

上述示例中，「abc」和「def」即是非選項參數。

系統參數，該參數會被設置到系統變量中，使用示例以下：

java -jar -Dserver.port=8081 xxx.jar

參數值的獲取

選項參數和非選項參數都可以經過ApplicationArguments接口獲取，具體獲取方法直接在使用參數的類中注入該接口便可。

@RestController
public class ArgumentsController {
    @Resource
    private ApplicationArguments arguments;
}

經過ApplicationArguments接口提供的方法便可得到對應的參數。關於該接口後面會詳細講解。

另外，選項參數，也能夠直接經過@Value在類中獲取，以下：

@RestController
public class ParamController {
    @Value("${server.port}")
    private String serverPort;
}

系統參數能夠經過java.lang.System提供的方法獲取：

String systemServerPort = System.getProperty("server.port");

參數值的區別

關於參數值區別，重點看選項參數和系統參數。經過上面的示例咱們已經發現使用選項參數時，參數在命令中是位於xxx.jar以後傳遞的，而系統參數是緊隨java -jar以後。

若是不按照該順序進行執行，好比使用以下方式使用選項參數：

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.

若是將系統參數放在jar包後面，問題會更嚴重。會出現能夠正常啓動，但參數沒法生效。這也是爲何有時候明明傳遞了參數可是卻未生效，那極可能是由於把參數的位置寫錯了。

這個錯誤是最坑的，因此必定謹記：經過-D傳遞系統參數時，務必放置在待執行的jar包以前。

另一個重要的不一樣是：經過@Value形式能夠得到系統參數和選項參數，但經過System.getProperty方法只能得到系統參數。

ApplicationArguments解析

上面提到了能夠經過注入ApplicationArguments接口得到相關參數，下面看一下具體的使用示例：

@RestController
public class ArgumentsController {

    @Resource
    private ApplicationArguments arguments;

    @GetMapping("/args")
    public String getArgs() {

        System.out.println("# 非選項參數數量: " + arguments.getNonOptionArgs().size());
        System.out.println("# 選項參數數量: " + arguments.getOptionNames().size());
        System.out.println("# 非選項具體參數:");
        arguments.getNonOptionArgs().forEach(System.out::println);

        System.out.println("# 選項參數具體參數:");
        arguments.getOptionNames().forEach(optionName -> {
            System.out.println("--" + optionName + "=" + arguments.getOptionValues(optionName));
        });

        return "success";
    }
}

經過注入ApplicationArguments接口，而後在方法中調用該接口的方法便可得到對應的參數信息。

ApplicationArguments接口中封裝了啓動時原始參數的數組、選項參數的列表、非選項參數的列表以及選項參數得到和檢驗。相關源碼以下：

public interface ApplicationArguments {

    /**
     * 原始參數數組（未通過處理的參數）
     */
    String[] getSourceArgs();

    /**
     * 選項參數名稱
     */
    Set<String> getOptionNames();

    /**
     * 根據名稱校驗是否包含選項參數
     */
    boolean containsOption(String name);

    /**
     * 根據名稱得到選項參數
     */
    List<String> getOptionValues(String name);

    /**
     * 獲取非選項參數列表
     */
    List<String> getNonOptionArgs();
}

命令行參數的解析

上面直接使用了ApplicationArguments的注入和方法，那麼它的對象是什麼時候被建立，什麼時候被注入Spring容器的？

在執行SpringApplication的run方法的過程當中會得到傳入的參數，並封裝爲ApplicationArguments對象。相關源代碼以下：

public ConfigurableApplicationContext run(String... args) {
        
    try {
        ApplicationArguments applicationArguments = new DefaultApplicationArguments(args);
        // ...
        prepareContext(context, environment, listeners, // ...
    } catch (Throwable ex) {
        // ...
    }
    return context;
}

在上述代碼中，經過建立一個它的實現類DefaultApplicationArguments來完成命令行參數的解析。

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);
        }
        // ...
    }
}

經過構造方法，將args賦值給成員變量args，其中接口ApplicationArguments中getSourceArgs方法的實如今該類中即是返回args值。

針對成員變量Source（內部類）的設置，在建立Source對象時調用了其父類SimpleCommandLinePropertySource的構造方法：

public SimpleCommandLinePropertySource(String... args) {
    super(new SimpleCommandLineArgsParser().parse(args));
}

在該方法中建立了真正的解析器SimpleCommandLineArgsParser並調用其parse方法對參數進行解析。

class SimpleCommandLineArgsParser {

    public CommandLineArgs parse(String... args) {
        CommandLineArgs commandLineArgs = new CommandLineArgs();
        for (String arg : args) {
            // --開頭的選參數解析
            if (arg.startsWith("--")) {
                // 得到key=value或key值
                String optionText = arg.substring(2, arg.length());
                String optionName;
                String optionValue = null;
                // 若是是key=value格式則進行解析
                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;
    }
}

上述解析規則比較簡單，就是根據「--」和「=」來區分和解析不一樣的參數類型。

經過上面的方法建立了ApplicationArguments的實現類的對象，但此刻還並未注入Spring容器，注入Spring容器是依舊是經過上述SpringApplication#run方法中調用的prepareContext方法來完成的。相關代碼以下：

private void prepareContext(ConfigurableApplicationContext context, ConfigurableEnvironment environment,
        SpringApplicationRunListeners listeners, ApplicationArguments applicationArguments, Banner printedBanner) {
    // ...
    ConfigurableListableBeanFactory beanFactory = context.getBeanFactory();
    // 經過beanFactory將ApplicationArguments的對象注入Spring容器
    beanFactory.registerSingleton("springApplicationArguments", applicationArguments);
    // ...
}

至此關於Spring Boot中ApplicationArguments的相關源碼解析完成。

原文連接：《Spring Boot啓動命令參數詳解及源碼分析》

Spring技術視頻

CSDN學院：《Spring Boot 視頻教程全家桶》

程序新視界：精彩和成長都不容錯過