如何在 Java 中解析命令行参数？

Question

在 Java 中解析命令行参数的好方法是什么？

Answer 1

看看这些：

• http://commons.apache.org/cli/
• http://www.martiansoftware.com/jsap/

或者自己动手：

• http://docs.oracle.com/javase/7/docs/api/java/util/Scanner.html

---

例如，这是您使用commons-cli 解析 2 个字符串参数的方式：

import org.apache.commons.cli.*;

public class Main {


    public static void main(String[] args) throws Exception {

        Options options = new Options();

        Option input = new Option("i", "input", true, "input file path");
        input.setRequired(true);
        options.addOption(input);

        Option output = new Option("o", "output", true, "output file");
        output.setRequired(true);
        options.addOption(output);

        CommandLineParser parser = new DefaultParser();
        HelpFormatter formatter = new HelpFormatter();
        CommandLine cmd = null;//not a good practice, it serves it purpose 

        try {
            cmd = parser.parse(options, args);
        } catch (ParseException e) {
            System.out.println(e.getMessage());
            formatter.printHelp("utility-name", options);

            System.exit(1);
        }

        String inputFilePath = cmd.getOptionValue("input");
        String outputFilePath = cmd.getOptionValue("output");

        System.out.println(inputFilePath);
        System.out.println(outputFilePath);

    }

}

命令行使用：

$> java -jar target/my-utility.jar -i asd                                                                                       
Missing required option: o

usage: utility-name
 -i,--input <arg>    input file path
 -o,--output <arg>   output file

Answer 2

看看Commons CLI 项目，里面有很多好东西。

Answer 3

也许这些

• JArgs command line option parsing suite for Java - 这个小型项目为 Java 程序员提供了一个方便、紧凑、预打包和全面记录的命令行选项解析器套件。最初，提供了与 GNU 风格的“getopt”兼容的解析。

• ritopt, The Ultimate Options Parser for Java - 虽然已经预设了几个命令行选项标准，但 ritopt 遵循 opt 包中规定的约定。

Answer 4

我使用过 JOpt，发现它非常方便：http://jopt-simple.sourceforge.net/

首页还提供了大约 8 个替代库的列表，请查看它们并选择最适合您需求的库。

Answer 5

是的。

我认为您正在寻找这样的东西： http://commons.apache.org/cli

Apache Commons CLI 库提供了一个用于处理命令行界面的 API。

Answer 6

如果您熟悉 gnu getopt，有一个 Java 端口位于：http://www.urbanophile.com/arenn/hacking/download.htm。

似乎有一些类可以这样做：

• http://docs.sun.com/source/816-5618-10/netscape/ldap/util/GetOpt.html
• http://xml.apache.org/xalan-j/apidocs/org/apache/xalan/xsltc/cmdline/getopt/GetOpt.html

Answer 7

最近有人将我指向args4j，它是基于注释的。我真的很喜欢！

Answer 8

看看最近的JCommander。

我创造了它。我很高兴收到问题或功能请求。

Answer 9

我一直在努力维护list of Java CLI parsers。

• Airline
  • 活动分叉：https://github.com/rvesse/airline
• argparse4j
• argparser
• args4j
• clajr
• cli-parser
• CmdLn
• Commandline
• DocOpt.java
• dolphin getopt
• DPML CLI (Jakarta Commons CLI2 fork)
• Dr. Matthias Laux
• Jakarta Commons CLI
• jargo
• jargp
• jargs
• java-getopt
• jbock
• JCLAP
• jcmdline
• jcommander
• jcommando
• jewelcli (written by me)
• JOpt simple
• jsap
• naturalcli
• Object Mentor CLI article (more about refactoring and TDD)
• parse-cmd
• ritopt
• Rop
• TE-Code Command
• picocli 具有 ANSI 彩色使用帮助和自动完成功能

Answer 10

我又写了一篇：http://argparse4j.sourceforge.net/

Argparse4j 是一个用于 Java 的命令行参数解析器库，基于 Python 的 argparse。

Answer 11

airline @ Github 看起来不错。它基于注解，并试图模拟 Git 命令行结构。

Answer 12

这是作为 Bazel 项目的一部分开源的 Google 命令行解析库。我个人认为它是目前最好的，而且比 Apache CLI 容易得多。

https://github.com/pcj/google-options

安装

巴泽尔

maven_jar(
    name = "com_github_pcj_google_options",
    artifact = "com.github.pcj:google-options:jar:1.0.0",
    sha1 = "85d54fe6771e5ff0d54827b0a3315c3e12fdd0c7",
)

分级

dependencies {
  compile 'com.github.pcj:google-options:1.0.0'
}

Maven

<dependency>
  <groupId>com.github.pcj</groupId>
  <artifactId>google-options</artifactId>
  <version>1.0.0</version>
</dependency>

用法

创建一个扩展 OptionsBase 并定义您的 @Option(s) 的类。

package example;

import com.google.devtools.common.options.Option;
import com.google.devtools.common.options.OptionsBase;

import java.util.List;

/**
 * Command-line options definition for example server.
 */
public class ServerOptions extends OptionsBase {

  @Option(
      name = "help",
      abbrev = 'h',
      help = "Prints usage info.",
      defaultValue = "true"
    )
  public boolean help;

  @Option(
      name = "host",
      abbrev = 'o',
      help = "The server host.",
      category = "startup",
      defaultValue = ""
  )
  public String host;

  @Option(
    name = "port",
    abbrev = 'p',
    help = "The server port.",
    category = "startup",
    defaultValue = "8080"
    )
    public int port;

  @Option(
    name = "dir",
    abbrev = 'd',
    help = "Name of directory to serve static files.",
    category = "startup",
    allowMultiple = true,
    defaultValue = ""
    )
    public List<String> dirs;

}

解析参数并使用它们。

package example;

import com.google.devtools.common.options.OptionsParser;
import java.util.Collections;

public class Server {

  public static void main(String[] args) {
    OptionsParser parser = OptionsParser.newOptionsParser(ServerOptions.class);
    parser.parseAndExitUponError(args);
    ServerOptions options = parser.getOptions(ServerOptions.class);
    if (options.host.isEmpty() || options.port < 0 || options.dirs.isEmpty()) {
      printUsage(parser);
      return;
    }

    System.out.format("Starting server at %s:%d...\n", options.host, options.port);
    for (String dirname : options.dirs) {
      System.out.format("\\--> Serving static files at <%s>\n", dirname);
    }
  }

  private static void printUsage(OptionsParser parser) {
    System.out.println("Usage: java -jar server.jar OPTIONS");
    System.out.println(parser.describeOptions(Collections.<String, String>emptyMap(),
                                              OptionsParser.HelpVerbosity.LONG));
  }

}

https://github.com/pcj/google-options

Answer 13

现在是 2021 年，是时候比 Commons CLI 做得更好... :-)

您应该构建自己的 Java 命令行解析器，还是使用库？

许多类似实用程序的小型应用程序可能会使用自己的命令行解析来避免额外的外部依赖。 picocli 可能是一个有趣的选择。

Picocli 是一个现代库和框架，用于轻松构建功能强大、用户友好、支持 GraalVM 的命令行应用程序。它存在于 1 个源文件中，因此应用程序可以将其作为源包含以避免添加依赖项。

它支持颜色、自动完成、子命令等。用 Java 编写，可用于 Groovy、Kotlin、Scala 等。

特点：

• 基于注释：声明性、避免重复和表达程序员意图
• 方便：解析用户输入并使用一行代码运行您的业务逻辑
• 强输入一切 - 命令行选项以及位置参数
• POSIX 集群空头期权（<command> -xvfInputFile 和 <command> -x -v -f InputFile）
• 细粒度控制：允许最小、最大和可变参数数量的 arity 模型，例如，"1..*"、"3..5"
• 子命令（可以嵌套到任意深度）
• 功能丰富：可组合的 arg 组、拆分引用的 arg、可重复的子命令等等
• 用户友好：使用帮助消息使用颜色将选项名称等重要元素与其他使用帮助进行对比，以减少认知负担用户
• 以 GraalVM native image 的身份分发您的应用
• 适用于 Java 5 及更高版本
• 广泛细致documentation

使用帮助消息很容易通过注释自定义（无需编程）。例如：

(source)

我忍不住再添加一张屏幕截图来显示可能的使用帮助消息。使用帮助是您的应用程序的面孔，所以要有创意，玩得开心！

免责声明：我创建了 picocli。非常欢迎提供反馈或问题。

Answer 14

如果你想要一些轻量级（jar 大小 ~ 20 kb）且易于使用的东西，你可以试试argument-parser。它可以在大多数用例中使用，支持在参数中指定数组，并且不依赖于任何其他库。它适用于 Java 1.5 或更高版本。以下摘录显示了如何使用它的示例：

public static void main(String[] args) {
    String usage = "--day|-d day --mon|-m month [--year|-y year][--dir|-ds directoriesToSearch]";
    ArgumentParser argParser = new ArgumentParser(usage, InputData.class);
    InputData inputData = (InputData) argParser.parse(args);
    showData(inputData);

    new StatsGenerator().generateStats(inputData);
}

更多例子可以找到here

Answer 15

Argparse4j 是我发现的最好的。它模仿 Python 的 argparse 库，非常方便和强大。

Answer 16

我知道这里的大多数人会找到 1000 万个他们不喜欢我的方式的原因，但没关系。我喜欢保持简单，所以我只是使用“=”将键与值分开，并将它们存储在 HashMap 中，如下所示：

Map<String, String> argsMap = new HashMap<>();
for (String arg: args) {
    String[] parts = arg.split("=");
    argsMap.put(parts[0], parts[1]);
} 

您始终可以维护一个包含您期望的参数的列表，以帮助用户以防他忘记了参数或使用了错误的参数......但是，如果您想要太多功能，那么这个解决方案无论如何都不适合您。

Answer 17

作为前面提到的 cmets 之一 (https://github.com/pcj/google-options) 将是一个不错的选择。

我想添加的一件事是：

1) 如果遇到解析器反射错误，请尝试使用更新版本的番石榴。就我而言：

maven_jar(
    name = "com_google_guava_guava",
    artifact = "com.google.guava:guava:19.0",
    server = "maven2_server",
)

maven_jar(
    name = "com_github_pcj_google_options",
    artifact = "com.github.pcj:google-options:jar:1.0.0",
    server = "maven2_server",
)

maven_server(
    name = "maven2_server",
    url = "http://central.maven.org/maven2/",
)

2) 运行命令行时：

bazel run path/to/your:project -- --var1 something --var2 something -v something

3) 当您需要使用帮助时，只需输入：

bazel run path/to/your:project -- --help

Answer 18

对于 Spring 用户，我们还应该提到 https://docs.spring.io/spring/docs/current/javadoc-api/org/springframework/core/env/SimpleCommandLinePropertySource.html 和他的孪生兄弟 https://docs.spring.io/spring/docs/current/javadoc-api/org/springframework/core/env/JOptCommandLinePropertySource.html（相同功能的 JOpt 实现）。 Spring的优点是可以直接将命令行参数绑定到属性上，这里有一个例子https://docs.spring.io/spring/docs/current/javadoc-api/org/springframework/core/env/CommandLinePropertySource.html

Answer 19

如果您已经在使用 Spring Boot，参数解析是开箱即用的。

如果你想在启动后运行一些东西，实现ApplicationRunner接口：

@SpringBootApplication
public class Application implements ApplicationRunner {

  public static void main(String[] args) {
    SpringApplication.run(Application.class, args);
  }

  @Override
  public void run(ApplicationArguments args) {
    args.containsOption("my-flag-option"); // test if --my-flag-option was set
    args.getOptionValues("my-option");     // returns values of --my-option=value1 --my-option=value2 
    args.getOptionNames();                 // returns a list of all available options
    // do something with your args
  }
}

您的run 方法将在上下文成功启动后被调用。

如果您需要在启动应用程序上下文之前访问参数，您只需手动解析应用程序参数即可：

@SpringBootApplication
public class Application implements ApplicationRunner {

  public static void main(String[] args) {
    ApplicationArguments arguments = new DefaultApplicationArguments(args);
    // do whatever you like with your arguments
    // see above ...
    SpringApplication.run(Application.class, args);
  }

}

最后，如果您需要访问 bean 中的参数，只需注入 ApplicationArguments：

@Component
public class MyBean {

   @Autowired
   private ApplicationArguments arguments;

   // ...
}

Answer 20

我想向你展示我的实现：ReadyCLI

优点：

• 适合懒惰的程序员：需要学习的课程数量非常少，只需查看存储库中 README 中的两个小示例，您就已经完成了 90% 的学习；在没有任何其他知识的情况下开始编写 CLI/解析器； ReadyCLI 允许以最自然的方式编写 CLI；
• 它的设计考虑了开发者体验；它主要使用 Lambda 表达式的 Builder 设计模式和功能接口，以实现非常快速的编码；
• 支持Options、Flags和Sub-Commands；
• 它允许从命令行解析参数并构建更复杂和交互式的 CLI；
• 可以像在任何其他 I/O 接口（例如套接字）上一样轻松地在标准 I/O 上启动 CLI；
• 它为命令文档提供了强大的支持。

我开发这个项目是因为我需要新功能（选项、标志、子命令）并且可以在我的项目中以最简单的方式使用。