Commons CLI不尊重我的命令行设置

时间:2015-05-08 13:43:43

标签: java command-line-interface apache-commons-cli

在此处使用Apache Commons CLI 1.2。我有一个可执行的JAR需要采用2个运行时选项,fizzbuzz;两者都是需要参数/值的字符串。我会喜欢(如果可能的话)我的应用程序就像这样执行:

  

java -jar myapp.jar -fizz" Alrighty,然后!" -buzz"现在保重,再见!"

在这种情况下,fizz选项的值为" Alrighty,然后!"等。

这是我的代码:

public class MyApp {
    private Options cmdLineOpts = new Options();
    private CommandLineParser cmdLineParser = new GnuParser();
    private HelpFormatter helpFormatter = new HelpFormatter();

    public static void main(String[] args) {
        MyApp myapp = new MyApp();
        myapp.processArgs(args);
    }

    private void processArgs(String[] args) {
        Option fizzOpt = OptionBuilder
            .withArgName("fizz")
            .withLongOpt("fizz")
            .hasArg()
            .withDescription("The fizz argument.")
            .create("fizz");

        Option buzzOpt = OptionBuilder
            .withArgName("buzz")
            .withLongOpt("buzz")
            .hasArg()
            .withDescription("The buzz argument.")
            .create("buzz");

        cmdLineOpts.addOption(fizzOpt);
        cmdLineOpts.addOption(buzzOpt);

        CommandLine cmdLine;

        try {
            cmdLine = cmdLineParser.parse(cmdLineOpts, args);

            // Expecting to get a value of "Alright, then!"
            String fizz = cmdLine.getOptionValue("fizz");
            System.out.println("Fizz is: " + fizz);
        } catch(ParseException parseExc) {
            helpFormatter.printHelp("myapp", cmdLineOpts, true);
            throw parseExc;
        }
    }
}

当我运行时,我得到以下输出:

  

Fizz是:null

我需要对代码执行哪些操作才能以我希望的方式调用我的应用程序?或者我最接近它的是什么?

加分:如果有人可以向我解释OptionBuilder' withArgName(...)withLongOpt(...)create(...)之间的区别参数,因为我传给它们的相同值都是这样的:

Option fizzOpt = OptionBuilder
    .withArgName("fizz")
    .withLongOpt("fizz")    }   Why do I have to pass the same value in 3 times to make this work?!?
    .create("fizz");

1 个答案:

答案 0 :(得分:3)

首先,您的OptionBuilder上的.hasArg()告诉它您希望在参数标志之后有一个参数。

我使用此命令行

--fizz "VicFizz is good for you" -b "VicBuzz is also good for you"

使用以下代码 - 我把它放在构造函数

Option fizzOpt = OptionBuilder
        .withArgName("Fizz")
        .withLongOpt("fizz")
        .hasArg()
        .withDescription("The Fizz Option")
        .create("f");

cmdLineOpts.addOption(fizzOpt);
cmdLineOpts.addOption("b", true, "The Buzz Option");

<强>击穿

选项设置是必要的,以便在命令行上提供更多可用性,以及一个很好的使用信息(见下文)

  • .withArgName("Fizz"):在使用中为您的论点提供一个很好的标题 (见下文)
  • .withLongOpt("fizz"):允许--fizz "VicFizz is good for you"
  • .create("f"):是主要参数并允许 命令行-f "VicFizz is good for you"
  • 请注意选项b 模糊化的构造要简单得多,牺牲了可读性 使用

使用信息

就个人而言,我喜欢打印出很好用法的CLI程序。您可以使用HelpFormatter执行此操作。例如:

private void processArgs(String[] args) {
  if (args == null || args.length == ) {
    helpFormatter.printHelp("Don't you know how to call the Fizz", cmdLineOpts);
    ...

这将打印出有用的内容:

usage: Don't you know how to call the Fizz
  -b <arg>          The Buzz Option
  -f,--fizz <Fizz>  The Fizz Option

请注意如何显示短选项-f,长选项--fizz和名称<Fizz>以及说明。

希望这有帮助