web-dev-qa-db-ja.com

Apache CLI：必須オプションがヘルプオプションと矛盾します。

次のような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 ..のようにユーザーが入力すると、ヘルプデータを出力したいのに、必要なオプションが不足しているという例外が解析ステップで発生します。

これらのオプションを必要に応じて宣言したまま、ヘルプの呼び出しを許可するにはどうすればよいですか？

javaapache-commonsapache-commons-cli
12
Mohamed Gad-Elrab

DefaultParserのコードは、常にcheckRequiredArgs()メソッドを呼び出すように見えます。これは、一挙に問題を回避できないことを示しているようです。

過去にこの状況に対処した方法は、おそらく次善の方法で、コマンドラインを2回解析することです。解析は高速であるため、オーバーヘッドは最小限に抑えられます。

（String [] args）を受け取るメソッドcheckForHelp(String[] args)を作成しました。オプションにヘルプオプションのみonlyを追加し、コマンドラインを解析して、ヘルプが指定されているかどうかを確認します。その場合、ヘルプが印刷され、プログラムが終了します。それ以外の場合は、オプションのフルセットが処理されます。このアプローチにより、必須フィールドを期待どおりに処理できます。ヘルプオプションもメインリストに追加する必要があることに注意してください。

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

[〜＃〜] edit [〜＃〜]：結局のところ、このアプローチはここで提供される答えに似ています： Commons CLI必須グループ 。私たちのアプローチには、私たちが信じていることを支持する他の人がいるほうがいいと思います。

EDIT2：簡単なテストでは、「OptionGroup」を使用することで、必要なオプションがあるという問題を回避できると思います。これは、すべてのオプションをOptionGroupに追加することで機能する改訂されたcheckForHelpです。私の簡単なテストでは、たとえば（ "--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;
}
11
KevinO

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);
    }
}
_
2
krizajb

前のポスターが言ったように、別の方法を追加しますが、最初の認識されていない引数で停止するようにしてください。

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のような有効な引数をスローします。

1
Florin M