摘要：入門中把解釋參數(shù)分為三種狀態(tài)，分別是定義解釋和詢問交互。如果入?yún)⒚钆c實(shí)例對(duì)應(yīng)不上就會(huì)拋出解析異常。查詢交互可以對(duì)入?yún)⒚钸M(jìn)行判斷解析，例如可以查詢是否存在某個(gè)選項(xiàng)，以及獲取這個(gè)選項(xiàng)的值。

以前寫過一些命令行程序，在需要帶參數(shù)的時(shí)候都是自己來判斷args，導(dǎo)致程序光解析args都占了好大一堆，而且解析代碼也不美觀。
偶然間發(fā)現(xiàn)了apache公共庫(kù)中的cli庫(kù)，在這里分享給大家。

commons-cli中把解釋參數(shù)分為三種狀態(tài)，分別是定義、解釋和詢問交互。

接下來，我以一個(gè)例子做一下說明：

maven庫(kù)：

        commons-cli
        commons-cli
        1.3.1

import org.apache.commons.cli.*;

public class CLI {
    public static void main(String[] args) throws ParseException {
        //定義
        Options options = new Options();
        options.addOption("h",false,"list help");//false代表不強(qiáng)制有
        options.addOption("t",true,"set time on system");

        //解析
        //1.3.1中已經(jīng)棄用針對(duì)不同格式入?yún)?duì)應(yīng)的解析器
        //CommandLineParser parser = new PosixParser();
        CommandLineParser parser = new DefaultParser();
        CommandLine cmd = parser.parse(options,args);

        //查詢交互
        //你的程序應(yīng)當(dāng)寫在這里，從這里啟動(dòng)
        if (cmd.hasOption("h")){
            String formatstr = "CLI  cli  test";
            HelpFormatter hf = new HelpFormatter();
            hf.printHelp(formatstr, "", options, "");
            return;
        }

        if (cmd.hasOption("t")){
            System.out.printf("system time has setted  %s 
",cmd.getOptionValue("t"));
            return;
        }

        System.out.println("error");
    }
}

在另一個(gè)類中做一下測(cè)試

String argss[]={"-t  1000"};
CLI.main(argss);

結(jié)果是：

system time has setted 1000

String argss[]={"-h"};
CLI.main(argss);

結(jié)果是：

usage: CLI cli test
-h list help
-t set time on system

好啦，入門就到這里了。

包組織結(jié)構(gòu)：

commons-cli-1.3.1.jar
org.apache.commons.cli

在cli包中，包含了所有的類，包括定義，解析，查詢交互和Exception

類的關(guān)系結(jié)構(gòu)圖如下

在定義這一部分，最重要的類是Option，Option類中定義了一個(gè)基本的選項(xiàng)，例如-t xxx ，是否為必選項(xiàng)，該命令的解釋等等。

Option重寫了很多構(gòu)造函數(shù)，但是最終都調(diào)用下面這個(gè)構(gòu)造函數(shù)：

public Option(String opt, String longOpt, boolean hasArg, String description)
           throws IllegalArgumentException
    {
        //寫這個(gè)代碼的人以前應(yīng)該是寫C++的。。。
        // 判斷短選項(xiàng)是否包含非法字符，如果包含拋出異常
        OptionValidator.validateOption(opt);
        //短選項(xiàng)
        this.opt = opt;
        //長(zhǎng)選項(xiàng)
        this.longOpt = longOpt;

        // 是否是必要選項(xiàng)
        if (hasArg)
        {
            this.numberOfArgs = 1;
        }
        //選項(xiàng)描述
        this.description = description;
    }

OptionsGroup類中包含了許多個(gè)Option，并可以對(duì)多個(gè)Option進(jìn)行一些處理。其實(shí)現(xiàn)是采用一個(gè)HashMap來存儲(chǔ)Option的，key是Option中的長(zhǎng)選項(xiàng)或者短選項(xiàng)的第一個(gè)字符，如果短選項(xiàng)存在，則優(yōu)先選擇短選項(xiàng)。

OptionGroup類還包含了一個(gè)組描述和組是否必須存在，相當(dāng)于對(duì)一群Option的群組操作。

Options類是被解析的對(duì)象，使用者可以在Options實(shí)例中直接添加命令，也可以添加Option實(shí)例，也可以添加OptionGroup實(shí)例。

其addOption方法最終調(diào)用了其重寫的一個(gè)方法：

public Options addOption(Option opt)
    {
        String key = opt.getKey();

        // add it to the long option list
        if (opt.hasLongOpt())
        {
            longOpts.put(opt.getLongOpt(), opt);
        }

        // if the option is required add it to the required list
        if (opt.isRequired())
        {
            if (requiredOpts.contains(key))
            {
                requiredOpts.remove(requiredOpts.indexOf(key));
            }
            requiredOpts.add(key);
        }

        shortOpts.put(key, opt);

        return this;
    }

添加GroupOption方法如下：

public Options addOptionGroup(OptionGroup group)
    {
        if (group.isRequired())
        {
            requiredOpts.add(group);
        }

        for (Option option : group.getOptions())
        {
            // an Option cannot be required if it is in an
            // OptionGroup, either the group is required or
            // nothing is required
            option.setRequired(false);
            addOption(option);

            optionGroups.put(option.getKey(), group);
        }

        return this;
    }

接下來就是CommandLineParser接口，在1.3.1版本中取消了Parser抽象類，GnuParser、BasicParser、PosixParser類，取而代之的是DefaultParser類。DefaultParser類提供了對(duì)Options實(shí)例的解析，即對(duì)入?yún)⒚詈蚈ptions實(shí)例之間對(duì)應(yīng)關(guān)系的解析，返回的類是CommandLine。如果入?yún)⒚钆cOptions實(shí)例對(duì)應(yīng)不上就會(huì)拋出解析異常。

DefaultParser類解析方法最基本的方法是handleToken(String token)，token是每一個(gè)入?yún)⒆址?。這個(gè)方法會(huì)在解析錯(cuò)誤的時(shí)候拋出解析異常。

CommandLine可以對(duì)入?yún)⒚钸M(jìn)行判斷解析，例如可以查詢是否存在某個(gè)選項(xiàng)，以及獲取這個(gè)選項(xiàng)的值。

cli包還是相當(dāng)簡(jiǎn)單的，大家也可以自己看一看commons庫(kù)的源碼。

更多文章：http://blog.gavinzh.com