关于命令行参数解析的库还挺多，调研之后选择了 picocli 这个库

因为其文档很全，所以下面是一个快速使用的教程，抓住主干再揪细节。

        <dependency><groupId>info.picocli</groupId><artifactId>picocli</artifactId><version>4.5.2</version></dependency>

效果

先看看，再实现

$ java -jar cli.jar -h
Usage: java -jar cli.jar [-hV] -p=<secret> -u=<user> [-c=<String=String>]...-s=<servers>[,<servers>...] [-s=<servers>[,<servers>...]]...-c, --config=<String=String>-c k1=v1 -c k2=v2-h, --help                Show this help message and exit.-p, --password=<secret>   login secret or password-s, --server=<servers>[,<servers>...]servers,split by comma: host1:port1,host2:port2-u, --user=<user>         login username-V, --version             Print version information and exit.

定义参数类

使用注解来定义参数类

一般只需要2个注解即可搞定：

@CommandLine.Command: 定义在类上，声明应用执行名字，版本等
@CommandLine.Option: 用在属性上，代表参数

下面是一个示例：

import picocli.CommandLine;import java.util.Map;@CommandLine.Command(name = "java -jar cli.jar")
public class CliParam {@CommandLine.Option(names = {"-h", "--help"}, usageHelp = true, description = " cmd cli help msg")public boolean help = false;@CommandLine.Option(names = {"-s", "--server"}, required = true, split = ",", converter = ServerTypeConverter.class,description = " servers,split by comma: host1:port1,host2:port2 ")public String[] servers;@CommandLine.Option(names = {"-u", "--user"}, required = true, description = "login username")public String user;@CommandLine.Option(names = {"-p", "--password"}, required = true,description = "login secret or password")public String secret;/*** 一些额外的参数*/@CommandLine.Option(names = {"-c", "--config"}, description = " -c k1=v1 -c k2=v2")public Map<String, String> configs;static class ServerTypeConverter implements CommandLine.ITypeConverter<String> {@Overridepublic String convert(String s) {final String[] hp = s.split(":");if (hp.length != 2) {throw new CommandLine.TypeConversionException("Invalid servers, must be: host1:port1,host2:port2," +" but was:'" + s + "'");}String host = hp[0].trim();int port = Integer.parseInt(hp[1].trim());return host + (port == 80 ? "" : ":" + port);}}
}

其中ServerTypeConverter可以自定义解析，这里接收一个逗号分割的字符串，返回一个数组。

声明版本

可以直接写死，也可以动态加载

@CommandLine.Command(name = "java -jar cli.jar",versionProvider = CliParam.MyVersionProvider.class)
public class CliParam {/*** 动态获取版本号,从内部配置里获取*/static class MyVersionProvider implements CommandLine.IVersionProvider {@Overridepublic String[] getVersion() throws Exception {final InputStream in = MyVersionProvider.class.getClassLoader().getResourceAsStream("config.properties");final Properties p = new Properties();p.load(in);return new String[]{"My APP", "Version " + p.getProperty("version", "unknown")};}}
}

进阶

我们知道每个命令行都会有 -h和-v这俩选项，所以人家早就考虑好了。

只需要一个选项即可：

@CommandLine.Command(name = "java -jar cli.jar",mixinStandardHelpOptions = true,versionProvider = CliParam.MyVersionProvider.class)
public class CliParam {}

使用参数解析

定义完了，就需要在main方法里解析了。

    public static void main(String[] args) throws Exception {// 解析参数final CliParam CliParam = new CliParam();final CommandLine commandLine = new CommandLine(CliParam);try {final CommandLine.ParseResult parseResult = commandLine.parseArgs(args);if (parseResult.isUsageHelpRequested()) {commandLine.usage(System.out);System.exit(0);}if (parseResult.isVersionHelpRequested()) {commandLine.printVersionHelp(System.out);System.exit(0);}CliParam.setINSTANCE(CliParam);} catch (CommandLine.ParameterException e) {commandLine.usage(System.out);System.exit(1);}// 使用 cliParam

当遇到未知参数时，会抛出 CommandLine.ParameterException, 捕获了打印help即可。
正常解析完如果是 -V，也需要打印版本号然后退出。

更多强大功能，请参考文档。

命令行参数解析picocli快速使用相关推荐

编程模板-R语言脚本写作：最简单的统计与绘图，包安装、命令行参数解析、文件读取、表格和矢量图输出
写在前面个人认为:是否能熟悉使用Shell(项目流程搭建)+R(数据统计与可视化)+Perl/Python等(胶水语言,数据格式转换,软件间衔接)三门语言是一位合格生物信息工程师的标准. 之前分享过 ...
linux shell中的命令自动补全（compgen complete）与命令行参数解析
linux shell中的命令自动补全(compgen complete)与命令行参数解析标签: shell脚本 2013-12-31 21:56 6661人阅读评论(6) 收藏举报分类: ...
安装rpm包命令_编程模板-R语言脚本写作：最简单的统计与绘图，包安装、命令行参数解析、文件读取、表格和矢量图输出...
不常用R的朋友,可能并不能意识到好的编辑模板带来的长期效率提高和代码重用性,非计算机专业科研人员且需要使用R语言,此文会对您有帮助. 个人认为:是否能熟悉使用Shell(项目流程搭建)+R(数据统计与 ...
【Qt】通过QtCreator源码学习Qt（六）：命令行参数解析实现
参考下大神的命令行参数解析是如何是实现的 //使用const char []代替宏定义字符串,我以前都是用const QString,想想好傻 const char SETTINGS_OPTION[] ...
python命令行参数解析OptionParser类用法实例
python命令行参数解析OptionParser类用法实例本文实例讲述了python命令行参数解析OptionParser类的用法,分享给大家供大家参考. 具体代码如下: from opt ...
3gpp文件头文件解析_居于LLVM 的命令行参数解析
在写命令行程序的时候经常需要解析各种命令行参数.打印help信息等,觉得非常的麻烦.今天介绍一种超级棒的命令参数解析的方法:居于LLVM 的命令行参数解析,有了它妈妈再也不用担心我不会解析命令行参数^ ...
Python命令行参数解析模块------argparse
首先,argparse 是python自带的命令行参数解析包,可以用来方便地读取命令行参数,当你的代码需要频繁地修改参数的时候,使用这个工具可以将参数和代码分离开来,让你的代码更简洁,适用范围更广 ...
Python中最好用的命令行参数解析工具
Python 做为一个脚本语言,可以很方便地写各种工具.当你在服务端要运行一个工具或服务时,输入参数似乎是一种硬需(当然你也可以通过配置文件来实现). 如果要以命令行执行,那你需要解析一个命令行参数解 ...
python 命令行参数-Python 中最好用的命令行参数解析工具
Python 做为一个脚本语言,可以很方便地写各种工具.当你在服务端要运行一个工具或服务时,输入参数似乎是一种硬需(当然你也可以通过配置文件来实现). 如果要以命令行执行,那你需要一个命令行参数解析的 ...

命令行参数解析picocli快速使用

效果

定义参数类

声明版本

进阶

使用参数解析

命令行参数解析picocli快速使用相关推荐

最新文章

热门文章