Apache Commons CLI - 快速指南

Apache Commons CLI - 概述

Apache Commons CLI 是 Apache Commons 的组件，派生自 Java API，并提供 API 来解析传递给程序的命令行参数/选项。此 API 还可以打印与可用选项相关的帮助。

命令行处理包括三个阶段。这些阶段解释如下 -

定义阶段
解析阶段
审讯阶段

定义阶段

在定义阶段，我们定义应用程序可以采取的选项并采取相应的行动。Commons CLI 提供了Options 类，它是Option 对象的容器。

// create Options object
Options options = new Options();

// add a option
options.addOption("a", false, "add two numbers");

这里我们添加了一个选项标志a，第二个参数为false，表示该选项不是强制性的，第三个参数表示选项的描述。

解析阶段

在解析阶段，我们在创建解析器实例后解析使用命令行参数传递的选项。

//Create a parser
CommandLineParser parser = new DefaultParser();

//parse the options passed as command line arguments
CommandLine cmd = parser.parse( options, args);

审讯阶段

在询问阶段，我们检查特定选项是否存在，然后相应地处理命令。

//hasOptions checks if option is present or not
if(cmd.hasOption("a")) {
   // add the two numbers
} else if(cmd.hasOption("m")) {
   // multiply the two numbers
}

Apache Commons CLI - 环境设置

在本章中，我们将了解Apache Commons CLI的本地环境设置以及如何为Windows 2000/XP、Windows 95/98/ME等设置Commons CLI的路径。我们还将了解一些流行的java编辑器和如何下载 Commons CLI 存档。

本地环境设置

如果您仍然愿意为 Java 编程语言设置环境，那么本章将指导您如何在计算机上下载和设置 Java。请按照以下步骤设置环境。

Java SE 可从链接https://www.oracle.com/java/technologies/oracle-java-archive-downloads.html免费获取。因此，您可以根据您的操作系统下载版本。

按照说明下载 Java 并运行 .exe 以在您的计算机上安装 Java。在计算机上安装 Java 后，您需要设置环境变量以指向正确的安装目录。

Windows 2000/XP 的路径

我们假设您已将 Java 安装在c:\Program Files\java\jdk目录中。

右键单击“我的电脑”并选择“属性”。
单击“高级”选项卡下的“环境变量”按钮。
现在，更改“Path”变量，以便它也包含 Java 可执行文件的路径。例如，如果路径当前设置为'C:\WINDOWS\SYSTEM32'，则将路径更改为'C:\WINDOWS\SYSTEM32;c:\Program Files\java\jdk\bin'。

Windows 95/98/ME 的路径

我们假设您已将 Java 安装在c:\Program Files\java\jdk目录中。

编辑'C:\autoexec.bat'文件并在末尾添加以下行 - 'SET PATH =% PATH %; C:\Program Files\java\jdk\bin'。

Linux、UNIX、Solaris、FreeBSD 的路径

环境变量 PATH 应设置为已安装 Java 二进制文件的位置。如果您在执行此操作时遇到问题，请参阅您的 shell 文档。

例如，如果您使用 bash 作为 shell，那么您可以将以下行添加到“.bashrc:export PATH=/path/to/java:$PATH”的末尾

流行的 Java 编辑器

要编写 Java 程序，您需要一个文本编辑器。市场上有许多复杂的 IDE。但现在，您可以考虑以下其中一项 -

记事本- 在 Windows 计算机上，您可以使用任何简单的文本编辑器，例如记事本（本教程推荐）、TextPad。
Netbeans - 它是一个开源且免费的 Java IDE，可以从www.netbeans.org/index.html下载。
Eclipse - 它也是由 eclipse 开源社区开发的 Java IDE，可以从www.eclipse.org下载。

下载通用 CLI 存档

从commons-cli-1.4-bin.zip下载最新版本的 Apache Common CLI jar 文件。在编写本教程时，我们已经下载了 commons-cli-1.4-bin.zip 并将其复制到 C:\>Apache 文件夹中。

操作系统	档案名称
Windows	commons-cli-1.4-bin.zip
Linux	commons-cli-1.4-bin.tar.gz
苹果	commons-cli-1.4-bin.tar.gz

Apache 通用 CLI 环境

将APACHE_HOME环境变量设置为指向计算机上存储 Apache jar 的基本目录位置。假设我们已经在各种操作系统上的 Apache 文件夹中提取了 commonscollections4-4.1-bin.zip，如下所示 -

操作系统	输出
Windows	将环境变量 APACHE_HOME 设置为 C:\Apache
Linux	导出 APACHE_HOME = /usr/local/Apache
苹果	导出 APACHE_HOME = /Library/Apache

类路径变量

将CLASSPATH环境变量设置为指向 Common CLI jar 位置。假设您已将 commons-cli-1.4.jar 存储在各种操作系统上的 Apache 文件夹中，如下所示 -

操作系统	输出
Windows	存储AIML机器人</将环境变量CLASSPATH设置为%CLASSPATH%;%APACHE_HOME%\commons-cli-1.4.jar;.;
Linux	导出 CLASSPATH = $CLASSPATH:$APACHE_HOME/commons-cli-1.4.jar:.
苹果	导出 CLASSPATH = $CLASSPATH:$APACHE_HOME/commons-cli-1.4.jar:.

Apache Commons CLI - 第一个应用程序

让我们创建一个基于控制台的示例应用程序，其目的是根据使用的选项获取传递的数字的总和或传递的数字的乘法。

创建一个名为 CLITester 的 java 类。

例子

CLITester.java

import org.apache.commons.cli.CommandLine;
import org.apache.commons.cli.CommandLineParser;
import org.apache.commons.cli.DefaultParser;
import org.apache.commons.cli.Options;
import org.apache.commons.cli.ParseException;
public class CLITester {
   public static void main(String[] args) throws ParseException {
      //***Definition Stage***
      // create Options object
      Options options = new Options();
      
      // add option "-a"
      options.addOption("a", false, "add numbers");
      
      // add option "-m"
      options.addOption("m", false, "multiply numbers");

      //***Parsing Stage***
      //Create a parser
      CommandLineParser parser = new DefaultParser();

      //parse the options passed as command line arguments
      CommandLine cmd = parser.parse( options, args);

      //***Interrogation Stage***
      //hasOptions checks if option is present or not
      if(cmd.hasOption("a")) {
         System.out.println("Sum of the numbers: " + getSum(args));
      } else if(cmd.hasOption("m")) {
         System.out.println("Multiplication of the numbers: " + getMultiplication(args));
      }
   }
   public static int getSum(String[] args) {
      int sum = 0;
      for(int i = 1; i < args.length ; i++) {
         sum += Integer.parseInt(args[i]);
      }
      return sum;
   }
   public static int getMultiplication(String[] args) {
      int multiplication = 1;
      for(int i = 1; i < args.length ; i++) {
         multiplication *= Integer.parseInt(args[i]);
      }
      return multiplication;
   }
}

输出

运行该文件，同时传递 -a 作为选项和数字以获取数字总和作为结果。

java CLITester -a 1 2 3 4 5
Sum of the numbers: 15

运行该文件，同时传递 -m 作为选项和数字以获得数字的乘法结果。

java CLITester -m 1 2 3 4 5
Multiplication of the numbers: 120

Apache Commons CLI - 选项属性

Option对象用于表示传递给命令行程序的Option。以下是 Option 对象拥有的各种属性。

先生编号	名称（类型）&s; 描述
1	选择（字符串）选项的标识字符串。
2	长选项（字符串）别名和更具描述性的标识字符串。
3	描述（字符串）选项功能的描述。
4	必需（布尔值）用于检查该选项是否必须出现在命令行上的标志。
5	arg（布尔值）用于检查选项是否带有参数的标志。
6	参数（布尔值）用于检查该选项是否采用多个参数的标志。
7	可选参数（布尔值）用于检查选项的参数是否可选的标志。
8	argName（字符串）使用语句的参数值的名称。
9	值分隔符（字符）用于分割参数字符串的字符值。
10	类型（对象）参数类型。
11	值（字符串）期权价值。
12	值（字符串[]）选项的值。

Apache Commons CLI - 布尔选项

布尔选项在命令行上通过其存在来表示。例如，如果 option 存在，则其值为 true，否则视为 false。考虑以下示例，其中我们正在打印当前日期并且如果存在 -t 标志。然后，我们也会打印时间。

例子

CLITester.java

import java.util.Calendar;
import java.util.Date;

import org.apache.commons.cli.CommandLine;
import org.apache.commons.cli.CommandLineParser;
import org.apache.commons.cli.DefaultParser;
import org.apache.commons.cli.Options;
import org.apache.commons.cli.ParseException;

public class CLITester {
   public static void main(String[] args) throws ParseException {
      Options options = new Options();
      options.addOption("t", false, "display time");
      
      CommandLineParser parser = new DefaultParser();
      CommandLine cmd = parser.parse( options, args);

      Calendar date = Calendar.getInstance();
      int day = date.get(Calendar.DAY_OF_MONTH);
      int month = date.get(Calendar.MONTH);
      int year = date.get(Calendar.YEAR);

      int hour = date.get(Calendar.HOUR);
      int min = date.get(Calendar.MINUTE);
      int sec = date.get(Calendar.SECOND);

      System.out.print(day + "/" + month + "/" + year);
      if(cmd.hasOption("t")) {
         System.out.print(" " + hour + ":" + min + ":" + sec);
      }
   }
}

输出

运行该文件而不传递任何选项并查看结果。

java CLITester
12/11/2017

运行该文件，同时传递 -t 作为选项并查看结果。

java CLITester
12/11/2017 4:13:10

Apache Commons CLI - 参数选项

参数选项在命令行上由其名称及其相应的值表示。例如，如果存在选项，则用户必须传递其值。考虑以下示例，如果我们将日志打印到某个文件，我们希望用户使用参数选项 logFile 输入日志文件的名称。

例子

CLITester.java

import org.apache.commons.cli.CommandLine;
import org.apache.commons.cli.CommandLineParser;
import org.apache.commons.cli.DefaultParser;
import org.apache.commons.cli.Option;
import org.apache.commons.cli.Options;
import org.apache.commons.cli.ParseException;

public class CLITester {
   public static void main(String[] args) throws ParseException {
      Options options = new Options();
      Option logfile = Option.builder()
         .longOpt("logFile")
         .argName("file" )
         .hasArg()
         .desc("use given file for log" )
         .build();

      options.addOption(logfile);
      CommandLineParser parser = new DefaultParser();
      CommandLine cmd = parser.parse( options, args);
      
      // has the logFile argument been passed?
      if(cmd.hasOption("logFile")) {
         //get the logFile argument passed
         System.out.println( cmd.getOptionValue( "logFile" ) );
      }
   }
}

输出

运行文件，同时传递 --logFile 作为选项，文件名作为选项的值，并查看结果。

java CLITester --logFile test.log
test.log

Apache Commons CLI - 属性选项

属性选项在命令行上由其名称及其相应的属性（如语法）表示，这类似于 java 属性文件。考虑下面的示例，如果我们传递像 -DrollNo = 1 -Dclass = VI -Dname = Mahesh 这样的选项，我们应该将每个值作为属性处理。让我们看看实际的实现逻辑。

例子

CLITester.java

import java.util.Properties;

import org.apache.commons.cli.CommandLine;
import org.apache.commons.cli.CommandLineParser;
import org.apache.commons.cli.DefaultParser;
import org.apache.commons.cli.Option;
import org.apache.commons.cli.Options;
import org.apache.commons.cli.ParseException;

public class CLITester {
   public static void main(String[] args) throws ParseException {
      Options options = new Options();
      Option propertyOption = Option.builder()
         .longOpt("D")
         .argName("property=value" )
         .hasArgs()
         .valueSeparator()
         .numberOfArgs(2)
         .desc("use value for given properties" )
         .build();
      
      options.addOption(propertyOption);
      CommandLineParser parser = new DefaultParser();
      CommandLine cmd = parser.parse( options, args);
      
      if(cmd.hasOption("D")) {
         Properties properties = cmd.getOptionProperties("D");
         System.out.println("Class: " + properties.getProperty("class"));
         System.out.println("Roll No: " + properties.getProperty("rollNo"));
         System.out.println("Name: " + properties.getProperty("name"));
      }
   }
}

输出

运行该文件，同时将选项作为键值对传递并查看结果。

java CLITester -DrollNo = 1 -Dclass = VI -Dname = Mahesh
Class: VI
Roll No: 1
Name: Mahesh

Apache Commons CLI - Posix 解析器

Posix 解析器用于解析传递的参数等 Posix。它现已被弃用并被 DefaultParser 取代。

例子

CLITester.java

import org.apache.commons.cli.CommandLine;
import org.apache.commons.cli.CommandLineParser;
import org.apache.commons.cli.Options;
import org.apache.commons.cli.ParseException;
import org.apache.commons.cli.PosixParser;

public class CLITester {
   public static void main(String[] args) throws ParseException {
      
      //Create posix like options
      Options posixOptions = new Options();
      posixOptions.addOption("D", false, "Display");
      posixOptions.addOption("A", false, "Act");
      
      CommandLineParser posixParser = new PosixParser();
      
      CommandLine cmd = posixParser.parse(posixOptions, args);
      
      if( cmd.hasOption("D") ) {
         System.out.println("D option was used.");
      }
      if( cmd.hasOption("A") ) {
         System.out.println("A option was used.");
      }
   }
}

输出

运行文件，同时传递 -D -A 作为选项并查看结果。

java CLITester -D -A
D option was used.
A option was used.

运行文件，同时传递 --D 作为选项并查看结果。

java CLITester --D
D option was used.

Apache Commons CLI - GNU 解析器

GNU 解析器用于解析传递的 GNU 参数。它现已被弃用并被 DefaultParser 取代。

例子

CLITester.java

import org.apache.commons.cli.CommandLine;
import org.apache.commons.cli.CommandLineParser;
import org.apache.commons.cli.GnuParser;
import org.apache.commons.cli.Options;
import org.apache.commons.cli.ParseException;

public class CLITester {
   public static void main(String[] args) throws ParseException {
      
      //Create GNU like options
      Options gnuOptions = new Options();
      gnuOptions.addOption("p", "print", false, "Print")
         .addOption("g", "gui", false, "GUI")
         .addOption("n", true, "Scale");

      CommandLineParser gnuParser = new GnuParser();
      CommandLine cmd = gnuParser.parse(gnuOptions, args);
      
      if( cmd.hasOption("p") ) {
         System.out.println("p option was used.");
      }
      if( cmd.hasOption("g") ) {
         System.out.println("g option was used.");
      }
      if( cmd.hasOption("n") ) {
         System.out.println("Value passed: " + cmd.getOptionValue("n"));
      }
   }
}

输出

运行文件，同时传递 -p -g -n 10 作为选项并查看结果。

java CLITester -p -g -n 10
p option was used.
g option was used.
Value passed: 10

Apache Commons CLI - 使用示例

Apache Commons CLI 提供了 HelpFormatter 类来打印命令行参数的使用指南。请参阅下面给出的示例 -

例子

CLITester.java

import org.apache.commons.cli.HelpFormatter;
import org.apache.commons.cli.Options;
import org.apache.commons.cli.ParseException;

public class CLITester {
   public static void main(String[] args) throws ParseException {
	
      Options options = new Options();
      options.addOption("p", "print", false, "Send print request to printer.")
         .addOption("g", "gui", false, "Show GUI Application")
         .addOption("n", true, "No. of copies to print");
			
      HelpFormatter formatter = new HelpFormatter();
      formatter.printHelp("CLITester", options);
   }
}

输出

运行该文件并查看结果。

java CLITester
usage: CLITester
-g,--gui Show GUI Application
-n <arg> No. of copies to print
-p,--print Send print request to printer.

Apache Commons CLI - 帮助示例

Apache Commons CLI 提供 HelpFormatter 类来打印与命令行参数相关的帮助。请参阅示例。

例子

CLITester.java

import java.io.PrintWriter;

import org.apache.commons.cli.HelpFormatter;
import org.apache.commons.cli.Options;
import org.apache.commons.cli.ParseException;

public class CLITester {
   public static void main(String[] args) throws ParseException {
      
      Options options = new Options();
      options.addOption("p", "print", false, "Send print request to printer.")
         .addOption("g", "gui", false, "Show GUI Application")
         .addOption("n", true, "No. of copies to print");
      
      HelpFormatter formatter = new HelpFormatter();

      final PrintWriter writer = new PrintWriter(System.out);
      formatter.printUsage(writer,80,"CLITester", options);
      writer.flush();
   }
}

输出

运行该文件并查看结果。

java CLITester
usage: CLITester [-g] [-n <arg>] [-p]