Apache CLI：所需选项与帮助选项相矛盾。

Question

如果我根据需要定义了 2 个选项，例如：

 public static void main(String [] args){
      Options options= new Options();
      Option  inputFileOp=Option.builder("i").longOpt("input").hasArg().desc("Input file").argName("file").required().build();
        options.addOption(inputFileOp);

      Option outputFileOp=Option.builder("o").longOpt("output").hasArg().desc("Output file").argName("file").required().build();
        options.addOption(outputFileOp);

和一个帮助选项

    Option helpOp =new Option("h",false,"Show Help");
    helpOp.setLongOpt("help");
    helpOptions.addOption(helpOp);

和解析器

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

if(cmd.hasOption(helpOp.getOpt())){
        HelpFormatter formatter = new HelpFormatter();
        formatter.printHelp( "MyApp.sh", options );
        System.exit(0);
    }

}

当用户输入例如 myApp -h .. 在解析步骤中出现异常，缺少必需的选项，而我想打印帮助数据。

如何在保持这些选项声明为必需的同时允许调用帮助？

Answer 1

DefaultParser 的代码似乎总是调用 checkRequiredArgs() 方法。这似乎表明您无法一下子避免这个问题。

我们过去解决这种情况的方法（可能不是最理想的方式）是解析命令行两次。解析速度很快，因此开销最小。

我们创建了一个接受 (String[] args) 的方法 checkForHelp(String[] args)。它将only help选项添加到一个选项中，解析命令行，然后确定是否指定了help。如果是，则打印帮助，然后程序退出。否则，将处理整套选项。这种方法允许按预期处理必填字段。请注意，帮助选项也必须添加到主列表中。

  public static Option helpOption = Option.builder("h")
          .longOpt("help")
          .required(false)
          .hasArg(false)
          .build();

  public static boolean checkForHelp(String[] args) throws ParseException  { 
    boolean hasHelp = false;

    Options options = new Options();


    try {
      options.addOption(helpOption);

      CommandLineParser parser = new DefaultParser();

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

      if (cmd.hasOption(helpOption.getOpt())) {
          hasHelp = true;
      }

    }
    catch (ParseException e) {
      throw e;
    }

    return hasHelp;
  }

然后在 main 方法中，类似于：

    options.addOption(hostOption);
    options.addOption(portOption);
    options.addOption(serviceNameOption);
    options.addOption(helpOption); // <-- must also be here to avoid exception

    try {
        if (checkForHelp(args)) {
            HelpFormatter fmt = new HelpFormatter();
            fmt.printHelp("Help", options);
            return;
        }

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


        if (cmd.hasOption("host")) {
            host = cmd.getOptionValue("host");
            System.out.println(host); // gets in here but prints null
        }
        if (cmd.hasOption("port")) {
            port = ((Number) cmd.getParsedOptionValue("port")).intValue();
            System.out.println(port); // gets in here but throws a null
                                      // pointer exception

        }
        if (cmd.hasOption("service_name")) {
            serviceName = cmd.getOptionValue("service_name");
            System.out.println(serviceName); // gets in here but prints null
        }
    }
    catch (Exception e) {
        e.printStackTrace();
    }

编辑：事实证明，这种方法类似于此处提供的答案：Commons CLI required groups。我想我感觉好多了，因为我们的方法有其他人支持我们的信念。

EDIT2：在快速测试中，我相信使用 "OptionGroup" 可以避免需要选项的问题。这是修改后的 checkForHelp，它通过将所有选项添加到 OptionGroup 来工作。在我的快速测试中，它避免了出现的问题，例如，("--arg1 --help")。

public static boolean checkForHelp(String[] args) throws ParseException
{
    boolean hasHelp = false;

    Options options = new Options();


    try {
        options.addOption(hostOption);  //has required set
        options.addOption(portOption);
        options.addOption(serviceNameOption);
        options.addOption(helpOption);            

        // create an option group
        OptionGroup og = new OptionGroup();
        og.addOption(hostOption);
        og.addOption(portOption);
        og.addOption(serviceNameOption);
        og.addOption(helpOption);

        CommandLineParser parser = new DefaultParser();

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

        if (cmd.hasOption(helpOption.getOpt()) || cmd.hasOption(helpOption.getLongOpt())) {
            hasHelp = true;
        }

    }
    catch (ParseException e) {
        throw e;
    }

    return hasHelp;
}

Answer 2

添加另一个方法，如之前的发帖者所说，但请确保在第一个无法识别的参数处停止。

private static boolean hasHelp(final Option help, final String[] args) throws ParseException
{
    Options options = new Options();
    options.addOption(help);
    CommandLineParser parser = new DefaultParser();
    CommandLine cmd = parser.parse(options, args, true);
    return cmd.hasOption(help.getOpt());
}

如果 stopAtNonOption 设置为 false，则此函数将抛出有效参数，例如 java -jar app.jar -doStuff

Answer 3

在使用 DefaultParser 解析之前，只解析原始参数并检查 --help/-h 或 help.getOpt()/help.getLongOpt() 关键字会不会更容易？这样可以避免双重解析开销。

for (String s : args) {
    if (s.equals("-h") || s.equals("--help")) {  // or use help.getOpt() || help.getLongOpt()
        formatter.printHelp("ApplicationName", arguments);
        System.exit(1);
    }
}

Apache CLI：所需选项与帮助选项相矛盾。

Apache CLI: Required options contradicts with help option.

java

apache-commons

apache-commons-cli