org.apache.common.cli 命令行参数解析

最新推荐文章于 2024-08-07 09:16:12 发布

hattoo

最新推荐文章于 2024-08-07 09:16:12 发布

阅读量1k

点赞数

CC 4.0 BY-SA版权

分类专栏： java学习

本文链接：https://blog.youkuaiyun.com/hattoo/article/details/80776191

java学习专栏收录该内容

2 篇文章

订阅专栏

本文介绍如何使用commons-cli库在Java应用中解析命令行参数。包括Maven依赖配置、定义Option对象、解析命令行参数及获取参数值的方法，并提供帮助信息的打印方式。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

Java命令行解析参数
1. Maven引入依赖
<dependency>
<groupId>commons-cli</groupId>
<artifactId>commons-cli</artifactId>
<version>1.4</version>
</dependency>

2. 定义各种option

Options options = new Options();

1) 通过Option对象

Option opt = new Option("h", "help", false, "Print help");
opt.setRequired(false); //是否必须含有该参数
options.addOption(opt);

其中Option的参数：

第一个参数：参数的简单形式
第二个参数：参数的复杂形式
第三个参数：是否需要额外的输入

第四个参数：对参数的描述信息

2）直接使用Options的重载函数

options.addOption("h", "help", false, "Print help");

3）~~使用OptionBuilder得到Option对象~~ 1.3废弃OptionBuilder

使用Option.Builder得到Option对象

Option c = Option.builder("c")                                    //c就是opt
.required(false)                          //是否必须含有该参数
.hasArg()                        //带一个参数
.argName("filename")                          //参数的名字
.desc("return sum of characters")           //描述

.build();

public Option.Builder argName(String argName) #我也不知道这个有啥用
public Option.Builder longOpt(String longOpt) #参数的长名称
public Option.Builder hasArg() #默认包含一个参数
public Option.Builder hasArg(boolean hasArg) #是否包含参数
public Option.Builder hasArgs() #代码中将参数长度设为-2，不知道啥意思
public Option.Builder desc(String description) #描述
public Option.Builder required() #默认必须包含该参数
public Option.Builder required(boolean required) #是否必须包含该参数
public Option.Builder type(Class<?> type)
public Option build() 当opt和longOpt都为null 会产生异常

Option.Builder只有私有的构造函数，所以只能通过Option类的成员函数

public static Option.Builder builder()

public static Option.Builder builder(String opt)

创建得到Option.Builder对象

3. 解析命令行

1）
CommandLineParser paraer = new BasicParser(); 1.3Deprecated.
CommandLineParser parser = new PosixParser(); 1.3Deprecated
CommandLineParser parser = new GnuParser(); 1.3Deprecated
CommandLineParser parser = new DefaultParser(); ok

2） CommandLine cmd= paraer.parse(options, args);

4. 获取参数
1）判断是否含有指定的参数
if(cmd.hasOption("help")){
}

2）获得某个命令对应的参数
String arg = cmd.getOptionValue('c')

5. 打印帮助
HelpFormatter hf = new HelpFormatter();
hf.printHelp("Options", options);