Java Apache CLI:必需的选项与帮助选项相矛盾。

Java Apache CLI:必需的选项与帮助选项相矛盾。,java,apache-commons,apache-commons-cli,Java,Apache Commons,Apache Commons Cli,如果我有两个按要求定义的选项,例如: 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.addOptio

如果我有两个按要求定义的选项,例如:

 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。。解析步骤中出现了一个异常,即缺少必需的选项,而我想打印帮助数据


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

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

添加另一个方法,如前一张海报所述,但请确保在第一个未识别的参数处停止

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

在使用
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);
    }
}

谢谢你的回答。事实上,我以前已经尝试过了,尽管它看起来更像是一种黑客行为,而不是一种正式的方式:(.问题仍然是,如果您只有“帮助”选项对象,其他选项将引发无法识别的选项异常。同时感谢您的编辑,以及我在搜索时无法找到的指针。在回答评论中,他们抱怨问题可能是由两组不同的选项引起的options@MohamedGad-埃尔拉布,是的是的,其他值可能会造成这种情况。但是,请寻找一种可能解决无法识别的参数异常的快速方法。@MohamedGad Elrab,我相信使用“OptionGroup”将避免其他指定选项引发异常的问题。我没有进行过大量测试,但在我的两次测试中,它似乎有效。请查看“Edit2”下的代码,并告诉我这是否适用于您。我仍然认为您需要处理
args[]
两次,但我相信这种方法可以满足要求。它适用于-h,但假设您有一个名为“帮助”的文件输入。这将解决一个问题,确保根据需要捕获角落案例。该库是为自动化流程而设计的。重写解析或添加角落案例不应该是特殊情况,帮助是核心功能应该有一个清晰清晰的方式。但他们似乎没有考虑自动化处理“自动”显示帮助消息的过程。
for (String s : args) {
    if (s.equals("-h") || s.equals("--help")) {  // or use help.getOpt() || help.getLongOpt()
        formatter.printHelp("ApplicationName", arguments);
        System.exit(1);
    }
}