Java Commons CLI - 在使用帮助参数时覆盖 required() 参数答案

【问题标题】：Java Commons CLI - overriding required() parameters while using help parameterJava Commons CLI - 在使用帮助参数时覆盖 required() 参数
【发布时间】：2018-06-20 16:43:39
【问题描述】：

我正在通过以下方式为解析器添加选项：

options = new Options()
                .addOption(Option.builder(CONFIG_PARAM)
                        .required()
                        .hasArg(true)
                        .argName(CONFIG_PARAM_NAME + "_path")
                        .desc(CONFIG_PARAM_DESC)
                        .longOpt(CONFIG_PARAM_NAME)
                        .build())
                (...)
                .addOption(Option.builder(HELP_PARAM)
                        .hasArg(false)
                        .longOpt(HELP_PARAM_NAME)
                        .desc(HELP_PARAM_DESC)
                        .build());

现在，我想允许用户只使用帮助命令，例如。

mypreciousapp --help

使用上述解决方案，这是不可能的 - 我收到有关缺少必需参数的信息

Missing required options: c

有没有办法标记帮助参数，以便它可以覆盖所需的参数，并允许单独使用它？我可以手动执行此操作，但首先我想知道 CLI 库中是否有这样的选项。

【问题讨论】：

您可以尝试添加一个 OptionGroup 来表示一组独占选项（仅允许该组中的一个选项存在）并将所有需要的选项放入该组中（包括-help）。

标签： java command-line-interface apache-commons apache-commons-cli

【解决方案1】：

commons-cli 目前似乎不支持该功能，因此我将创建一个不需要参数的第二个选项对象，并在进行完整解析之前先对其进行解析/检查，如下所示：

public static void main(String[] args) {
    // define the options with required arguments as needed
    Options opts = new Options()
            .addOption(Option.builder("p")
                    .required()
                    .hasArg(true)
                    .argName("arg")
                    .desc("description  ")
                    .longOpt("param")
                    .build())
            .addOption(Option.builder("h")
                    .hasArg(false)
                    .longOpt("help")
                    .desc("help description")
                    .build());

    // first check if usage-output was requested
    if (handleHelp(args, opts)) {
        return;
    }

    // now handle the full options
    CommandLineParser parser = new DefaultParser();
    final CommandLine cmdLine;
    try {
        cmdLine = parser.parse(opts, args);
    } catch (ParseException ex) {
        System.out.println("Syntax error: " + ex.getMessage());

        printHelp(opts);

        return;
    }

    // now handle options and do your work
}

private boolean handleHelp(String[] args, Options opts) {
    Options helpOpts = new Options()
            .addOption(Option.builder("p")
                    //.required()
                    .hasArg(true)
                    .argName("arg")
                    .desc("description  ")
                    .longOpt("param")
                    .build())
            .addOption(Option.builder("h")
                    .hasArg(false)
                    .longOpt("help")
                    .desc("help description")
                    .build());

    CommandLineParser helpParser = new DefaultParser();
    final CommandLine cmdLine;
    try {
        cmdLine = helpParser.parse(helpOpts, args);
    } catch (ParseException ex) {
        System.out.println("Syntax error: " + ex.getMessage());

        printHelp(opts);

        return true;
    }

    if(cmdLine.hasOption("h")) {
        printHelp(opts);

        return true;
    }

    return false;
}

private void printHelp(Options opts) {
    try (PrintWriter pw = new PrintWriter(System.out)) {
        HelpFormatter formatter = new HelpFormatter();

        formatter.printHelp(pw, 80, "myapp", "test-header", opts,
                formatter.getLeftPadding(), formatter.getDescPadding(), "test-footer", true);
    }
}

【讨论】：

【解决方案2】：

commons-cli 库有一个流利的包装器：https://github.com/bogdanovmn/java-cmdline-app

-h 选项已经内置。您无需在自己的代码中管理它。

【讨论】：