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

java apache-commons apache-commons-cli

2022-09-02 10:05:37

如果我有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 ..在解析步骤中引发异常，指出缺少必需的选项，而我想打印帮助数据。

如何允许调用帮助，同时根据需要声明这些选项？

答案 1

的代码似乎始终调用该方法。这似乎表明，您不能一举避免这个问题。DefaultParsercheckRequiredArgs()

我们过去处理这种情况的方法（也许是以次优的方式）是解析命令行两次。解析速度很快，因此开销最小。

我们创建了一个采用（String[] args）的方法。它仅将帮助选项添加到选项中，分析命令行，然后确定是否指定了帮助。如果是这样，将打印帮助，并且程序将退出。否则，将处理整套选项。此方法允许按预期处理必填字段。请注意，还必须在主列表中添加帮助选项。checkForHelp(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所需的组。我想我感觉更好，我们的方法有其他人支持我们的信念。

编辑2：在快速测试中，我相信通过使用“选项组”可以避免具有所需选项的问题。下面是一个修订版，它的工作原理是将所有选项添加到选项组。在我的快速测试中，它避免了如果这样做，例如（“--arg1 --help”）时出现的问题。checkForHelp

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;
}

答案 2

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

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