阅读 Flink 源码前必会的知识 - 命令行解析库 Apache Commons Cli

一、介绍一下 Apache Commons Cli，有一个感官的认识

我们在使用一些开源项目时，会敲一些命令，有简单的，比如 hadoop version；有复杂的，比如 flink run ... ，hdfs dfs -ls ，等等。一般这些命令后面有很多的参数，特别是在往 Yarn 上提交 Flink 任务时，后面要设置很多属性。

这些命令实际上最终还是会启动虚拟机来执行的，如果你用 vi 看过这些命令，就可以发现，最终都是调用的 java xxxx，来执行的。那么命令后面的参数会传到 main 方法里，然后 main 方法的代码再去解析这些个参数。

参数比较少，一两个月还好。参数一多，那解析起来简直就是灾难了，会有很多 switch ，if else 。

而 Apache Commons Cli 这个库就是为了解决这个问题的。它封装了命令行的基本元素，帮助程序去解析传递给程序的命令行参数。也可以打印帮助信息来说明这个命令行的有效参数。

二、核心概念

核心概念只有三个，那就是命令行程序的处理流程

• 定义阶段

首先我们要通过 Options 对象，来创建实例，把我们可能要处理的所有参数，都预先定义好。这样一方面，可以打印出命令行参数的使用帮助，另一方面才能处理掉参数的所有情况；

• 解析阶段

解析阶段，就是把用户命令行传到程序里的参数，通过 CommandLineParser 类解析出来，解析出来 CommandLine 对象。

• 询问阶段

询问阶段，就是把程序中需要用的参数从 CommandLine 中解析出来，并根据不同的参数，走到不同的应用代码分支。这个阶段在用户应用逻辑中实现。

三、用一个例子就能理解全部了

上面我们并没有讲太多代码细节，因为把全局的概念弄清楚，搞懂代码其实就没什么难度了。最后用一个例子，把上面的知识点都串起来。

package com.hudsun.flink.commonscli;
import org.apache.commons.cli.*;
 * @Author wangkai
 * @Time 2021/2/2 15:55
public class CommonsCli01 {
    public static void main(String[] args1) throws ParseException {
        String[] arg = { "-h", "-c", "config.xml" };
        testOptions(arg);
    public static void testOptions(String[] args) {
        // Options 准备阶段，准备好所有的选项
        Options options = new Options();
        Option opt = new Option("h", "help", false, "Print help");
        opt.setRequired(false);
        options.addOption(opt);
        opt = new Option("c", "configFile", true, "Name server config properties file");
        opt.setRequired(false);
        options.addOption(opt);
        opt = new Option("p", "printConfigItem", false, "Print all config item");
        opt.setRequired(false);
        options.addOption(opt);
        // 帮助打印
        HelpFormatter hf = new HelpFormatter();
        hf.setWidth(110);
        // 解析从命令行传过来的参数
        CommandLine commandLine = null;
        CommandLineParser parser = new PosixParser();
        try {
            // 得到 CommandLine 对象
            commandLine = parser.parse(options, args);
            // 根据不同的参数处理不同的业务逻辑
            // h 打印帮助信息
            if (commandLine.hasOption('h')) {
                // 打印使用帮助
                hf.printHelp("testApp", options, true);
            // 打印opts的名称和值
            System.out.println("--------------------------------------");
            Option[] opts = commandLine.getOptions();
            if (opts != null) {
                for (Option opt1 : opts) {
                    String name = opt1.getLongOpt();
                    String value = commandLine.getOptionValue(name);
                    System.out.println(name + "=>" + value);