Apache Common CLI学习笔记

在IDEA的run configuration里面，可以通过Program arguments设置相应参数，向程序中传入信息。程序中对信息的解析，可以使用Apache Commons CLI。

Apache Commons CLI为解析传递给程序的命令行选项（command line options）提供了API，它可以帮助开发者快速构建启动命令。即编写一套命令行接口，然后通过解析命令行，将参数传递给我们的程序去执行相应的任务。官网为http://commons.apache.org/proper/commons-cli/index.html

Apache Commons CLI对命令行的处理分为三个阶段：定义、解析、询问。

定义阶段

命令行需要定义option的集合，用这些option来定义连接应用的接口。定义阶段主要是使用Options类作为存放Option实例的容器。创建Option实例的方法有多种：

1.使用Options的addOption方法

Options options = new Options();

options.addOption("t", false, "display current time");

addOption方法的第一个参数是代表选项（option）；第二个参数是个布尔值，用来指定这个option是否需要参数，如果为true，只能带一个参数，如果有多个参数，需要用分隔符进行分割；第三个参数是用来描述option的。

2.使用Option构造器

Options options = new Options();

Option opt = new Option("h", "help", false, "Print help");

opt.setRequired(false); //该option在命令行中是否必须出现

options.addOption(opt);

构造方法的四个参数分别表示：参数的简单形式；参数的复杂形式；是否需要额外的输入；对参数的描述信息。

3.通过OptionBuilder(1.3以后变成了Option.Builder)进行语义化的定义：

Option ping = OptionBuilder.withArgName("ip").hasArg().//withArgName:参数名称，create:选项名称

withDescription("ping the given ip").create( "ping" );

Option property = OptionBuilder.withArgName( "property=value" )//带属性

.hasArgs()//有多个参数

.withValueSeparator()//分隔符，默认=号

.withDescription( "use value for given property" )

.create( "D" );

解析阶段

在解析阶段，通过命令行把文本传递给应用，文本的处理方式是由解析器来决定的。CommandLineParser使用其解析方法，把Options实例和参数组成的字符串数组，生成一个CommandLine。CommandLineParser有多个实现类，其中比较推荐使用的是DefaultParser。

CommandLineParser parser = new DefaultParser();

CommandLine cmd = parser.parse(options,args);

询问阶段

在询问阶段，应用通过查询CommandLine，依据hasOption方法返回的布尔值决定执行哪个判断分支，并用option的值为应用提供数据。调用getOptionValue()方法可以返回对应的参数值

if(cmd.hasOption("h")){

           //do something

}

-----------------------------------------------------------------------------------------------------------------------------------------------------------------------

最近有遇到使用HelpFormatter输出帮助说明的代码，以下列代码为例，记录HelpFormatter和OptionBuilder的用法：

Options options = new Options();
 options.addOption(OptionBuilder.withLongOpt("file")
                                .withDescription("The file to be processed")
                                .hasArg()
                                .withArgName("FILE")
                                .isRequired()
                                .create('f'));
 options.addOption(OptionBuilder.withLongOpt("version")
                                .withDescription("Print the version of the application")
                                .create('v'));
 options.addOption(OptionBuilder.withLongOpt("help").create('h'));
 
 String header = "Do something useful with an input file\n\n";
 String footer = "\nPlease report issues at http://example.com/issues";
 
 HelpFormatter formatter = new HelpFormatter();
 formatter.printHelp("myapp", header, options, footer, true);
 

打印结果:

 usage: myapp -f <FILE> [-h] [-v]
 Do something useful with an input file
 
  -f,--file <FILE>   The file to be processed
  -h,--help
  -v,--version       Print the version of the application
 
 Please report issues at http://example.com/issues