摘要：本文我們重點分析一下Springboot框架中的命令列引數的使用以及框架內部處理的命令列引數的原理。

眾所周知，springboot專案可以有兩種方式啟動，第一種使用jar包；第二種使用war包。在使用jar方式的時候，我們可以在啟動jar包的時候設定一些命令引數。

1.1 命令列引數使用

首先我們看一下如何使用在專案啟動的時候設定命令列引數以及值。我這裡使用的開發工具是Spring Tool Suite 版本是: 3.9.0.RELEASE。我們先建立一個工程檔案，目錄結構如下圖所示：

Application內容如下：

1 @EnableConfigurationProperties

2 public class Application {

3  public static void main(String[] args) {

4  ConfigurableApplicationContext configurableApplicationContext =    SpringApplication.run(Application.class, args);

5  }

6 }

怎麼啟動上述的類呢？操作步驟如下：

第一步：點選 Debug AS-->>Debug Configurations

第二步：

首先，我們需要點選①箭頭處的新增按鈕，然後就會建立一個Spring Boot App、其次我們輸入命令列的引數，然後點選App即可完成設定並啟動專案。上圖中我們設定了三個變數，如下所示：

--foo=bar  -foo=bar1  --foo=bar2

   上述這三個變數我們該如何獲取呢？這也是校驗引數是否設定成功的一個途徑吧相信大家都想知道下一步的操作，下面的例項程式碼還是在上文的兩個步驟為前提下進行。例項程式碼如下：

1 @EnableConfigurationProperties

2 public class Application {

3  public static void main(String[] args) {

4  ConfigurableApplicationContext configurableApplicationContext = SpringApplication.run(Application.class, args);

5  String property = configurableApplicationContext.getEnvironment().getProperty("foo");

6  System.out.println(property);

7  }

8 }

執行上述的程式碼，控制檯的輸出資訊如下：

bar,bar2

   我們通過ConfigurableApplicationContext例項獲取環境ConfigurableEnvironment例項物件，然後通過ConfigurableEnvironment獲取屬性foo。ConfigurableEnvironment大家暫時先有個印象，我們通過這個例項物件獲取到專案中所有的配置屬性資訊。這個我們後續也會詳細的進行講解。看到上面的輸出，發現輸出的是bar,bar2

，然而bar1並沒有輸出？為什麼呢？大家看下這三個命令列引數有何迥異，很顯然bar,bar2的引數屬性都是--開頭的，而bar1是-開頭的。那我們就很好奇springboot是如何獲取這些引數值以及解析的呢？

   上述中的啟動類是Application,該類中的main方法去啟動Springboot專案，既然是main方法，所以我們上文提到的三個命令列引數最終會被設定到args引數中的。這一點大家一定要注意了。SpringApplication.run方法會將args引數繼續傳遞到SpringApplication類中讓框架處理的。接下來，我們看一下SpringApplication.run方法中關於命令列引數的相關處理邏輯吧。

1.2 命令列引數原理

 我們開始跟進SpringApplication類中的run(String... args)方法，相關的程式碼如下所示：

1 public ConfigurableApplicationContext run(String... args) {

2  ...//省略

3  ApplicationArguments applicationArguments = new DefaultApplicationArguments(args);

4  ConfigurableEnvironment environment = prepareEnvironment(listeners,applicationArguments);

5  ...//省略

6  }

1.2.1 DefaultApplicationArguments類

     首先，我們看一下DefaultApplicationArguments類，該類的核心程式碼如下：

1 public class DefaultApplicationArguments implements ApplicationArguments {

2  private final Source source;

3  private final String[] args;

4  public DefaultApplicationArguments(String[] args) {

5      Assert.notNull(args, "Args must not be null");

6      this.source = new Source(args);

7      this.args = args;

8  }

DefaultApplicationArguments類的建構函式中，首先例項化Source類，並將args引數以及值進行傳遞。然後在自身類中使用args屬性進行引數值的報錯，DefaultApplicationArguments類實現了ApplicationArguments介面。ApplicationArguments 介面中定義了各種命令列引數的操作，比如引數值的獲取、引數名稱的獲取等方法。

上面的程式碼感覺沒有什麼神奇的地方，貌似只是對命令列引數的各種封裝而已。其實Source類大有玄機。該類的程式碼如下所示：

1 private static class Source extends SimpleCommandLinePropertySource {

2  Source(String[] args) {

3  super(args);

4  }

5 ...//省略

6  }

     Source類繼承SimpleCommandLinePropertySource類，並在當前類的建構函式呼叫SimpleCommandLinePropertySource 類的建構函式，SimpleCommandLinePropertySource 類的建構函式如下所示：

1 public class SimpleCommandLinePropertySource extends CommandLinePropertySource<CommandLineArgs> {

2  public SimpleCommandLinePropertySource(String... args) {

3  super(new SimpleCommandLineArgsParser().parse(args));

4  }

    雖然SimpleCommandLinePropertySource類的建構函式繼續呼叫CommandLinePropertySource類的建構函式進行處理，但是我們只需要將new SimpleCommandLineArgsParser().parse(args)這行程式碼搞明白，關於命令列引數以及值的處理我們就可以搞明白了。接下來我們快速看一下parse方法的實現邏輯，例項程式碼如下：

1 public CommandLineArgs parse(String... args) {

2  CommandLineArgs commandLineArgs = new CommandLineArgs();

3  for (String arg : args) {

4    if (arg.startsWith("--")) {

5            String optionText = arg.substring(2, arg.length());

6            String optionName;

7            String optionValue = null;

8           if (optionText.contains("=")) {

9                   optionName = optionText.substring(0, optionText.indexOf("="));

10                   optionValue = optionText.substring(optionText.indexOf("=")+1, optionText.length());

11            }

12          else {

13         optionName = optionText;

14       }

15  if (optionName.isEmpty() || (optionValue != null && optionValue.isEmpty())) {

16              throw new IllegalArgumentException("Invalid argument syntax: " + arg);

17  }

18        commandLineArgs.addOptionArg(optionName, optionValue);

19  }

20  else {

21           commandLineArgs.addNonOptionArg(arg);

22  }

23  }

24        return commandLineArgs;

25  }

我們將上述程式碼的邏輯梳理如下：

①　例項化CommandLineArgs類。這個類封裝了命令列解析之後的引數以及值資訊、還有沒有被識別的命令列引數以及值的資訊。

②　迴圈遍歷所有的引數以及值args，比如我們傳遞的是--foo=bar  -foo=bar1  --foo=bar2

③　如果引數以--開頭，則開始如下的操作；否則將其作為不能識別的引數進行處理，上文我們定義的-foo就是不能被識別的引數。

擷取--字串並使用optionText變數進行儲存，比如引數--foo=bar擷取之後，則optionText值為foo=bar。

optionName為foo,optionValue為bar，通過上述程式碼邏輯可以看出，如果=前邊或者後邊出現了空格就慘了。因為這個地方的程式碼並沒有對空格以及特殊字元進行區分。

1.2.1.1. 識別引數新增

commandLineArgs.addOptionArg(optionName, optionValue);進行springboot可識別的命令列引數的新增工作，其內部實現邏輯如下所示：

1 private final Map<String, List<String>> optionArgs = new HashMap<>();

2 public void addOptionArg(String optionName, @Nullable String optionValue) {

3  if (!this.optionArgs.containsKey(optionName)) {

4  this.optionArgs.put(optionName, new ArrayList<>());

5  }

6  if (optionValue != null) {

7  this.optionArgs.get(optionName).add(optionValue);

8  }

9  }

上述程式碼中，首先校驗optionName引數值是否存在於optionArgs集合中。如果不存在，則直接例項化ArrayList並將其新增到optionArgs集合中。

注意：optionArgs的key為引數的名稱，value是一個List集合，儲存的是該引數的所有值。通過這裡的處理我們可以看出，我們上文輸出的foo引數的值是bar,bar2就很容易理解了。

1.2.1.2. 未知引數新增

commandLineArgs.addNonOptionArg(arg)方法進行未知引數的新增邏輯，比如上文中的-foo=bar1引數就在這個方法進行處理的額，因為該引數不是--開頭的。commandLineArgs.addNonOptionArg(arg)方法如下所示：

1 private final List<String> nonOptionArgs = new ArrayList<>();

2 public void addNonOptionArg(String value) {

3  this.nonOptionArgs.add(value);

4  }

未知引數最終被新增到了nonOptionArgs集合。

講解到這裡基本上命令列引數的設定以及解析原理都搞明白了。

歡迎關注我的微信公眾號，第一時間獲得部落格更新提醒，以及更多成體系的Java相關原創技術乾貨。 
掃一掃下方二維碼或者長按識別二維碼，即可關注。