Java命令行参数

一、引入依赖

二、方法实战

三、方法讲解

本文我们介绍一个命令行工具，Apache Commons CLI。

在我们执行java的jar包时，常用的命令是

java -jar hellowork.jar
# 或者
nohup java -jar hellowork.jar >>/data/log.txt2>&1 &

我们还可以在执行该命令时添加执行参数，不管是在dos还是Linux上执行该命令，抑或是在IDE工具中配置，都是一样的。

Java的命令行参数有很多，本文不做介绍，感兴趣的小伙伴可以自行百度：Java命令行参数。

一、引入依赖

本文的重点在于介绍，自定义Java命令行参数以及如何使用。

首先引入依赖：

    <dependency>
      <groupId>commons-cli</groupId>
      <artifactId>commons-cli</artifactId>
      <version>1.5.0</version>
    </dependency>

目前最新版是1.5.0，至于其他版本可以在maven仓库检索：

https://mvnrepository.com/artifact/commons-cli/commons-cli

引入依赖下载好之后便可以操作了。

二、方法实战

但是在操作之前，我们需要介绍一下这个 commons-cli。

commons-cli其实就是Apache Commons CLI，是Apache下的解析命令行的工具包。具体的可以自行百度。

有4个重载方法，我们使用第二个和第三个，也就是有2个参数和3个参数的方法。

最终的代码如下：

package com.dake.main;

import org.apache.commons.cli.*;

public class CommandLineMain {

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

        Options options = new Options();
        options.addOption("v", true, "version");
        options.addOption("e", true, "env");
        options.addOption("h", "help");

        CommandLineParser commandLineParser = new DefaultParser();
        CommandLine commandLine = commandLineParser.parse(options, args);

        if (commandLine.hasOption("h")) {
            System.out.println("这是帮助参数");
        } else if (commandLine.hasOption("v")) {
            String version = commandLine.getOptionValue("v");
            System.out.println("版本号为" + version);
        } else if (commandLine.hasOption("e")) {
            String env = commandLine.getOptionValue("e");
            System.out.println("环境为" + env);
        }
    }
}

我们使用idea自带的工具进行测试。

我们在启动的命令行CLI中添加-h参数。

保存并运行main方法。

修改h参数改为-e参数。

-v参数我们就不进行演示了。

三、方法讲解

下面我们看看这个addOption方法。

首先看最长的参数的方法，因为其他方法都是基于这个方法的。

    /**
     * Add an option that contains a short-name and a long-name.
     *
     * <p>
     * It may be specified as requiring an argument.
     * </p>
     *
     * @param opt Short single-character name of the option.
     * @param longOpt Long multi-character name of the option.
     * @param hasArg flag signalling if an argument is required after this option
     * @param description Self-documenting description
     * @return the resulting Options instance
     */
    public Options addOption(final String opt, final String longOpt, final boolean hasArg, final String description) {
        addOption(new Option(opt, longOpt, hasArg, description));
        return this;
    }

首先我们看注释，翻译过来就是：