Apache CLI：必需選項與help選項相矛盾。

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()方法。 這似乎表明你不可能一舉避免這個問題。

我們過去解決這種情況的方式，也許是次優的方式，是解析命令行兩次。 解析速度很快，因此開銷很小。

我們創建了一個方法checkForHelp(String[] args) ，它接受（String [] args）。 它僅向選項添加幫助選項，解析命令行，然后確定是否指定了幫助。 如果是，則打印幫助，程序退出。 否則，將處理完整的選項集。 此方法允許按預期處理所需的字段。 請注意，還必須在主列表中添加幫助選項。

  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需要的組 。 我想我感覺更好，我們的方法讓其他人支持我們所相信的。

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

在使用DefaultParser解析之前，解析原始args並檢查--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);
    }
}

Answer 3

添加另一種方法，如上一張海報所說，但請確保停在第一個無法識別的參數。

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