java 命令行解析工具包 jopt-simple

java 解析命令行工具包 jopt-simple

gradle依赖如下

compile 'net.sf.jopt-simple:jopt-simple:5.0.2'

maven依赖如下

<dependency>
    <groupId>net.sf.jopt-simple</groupId>
    <artifactId>jopt-simple</artifactId>
    <version>5.0.2</version>
</dependency>

支持POSIX格式和GNU格式的命令行参数,短的选项参数格式and长的选项参数格式都支持。

短格式选项


短的选项参数,用一个-开头,后面跟一个数字或者字母;或者是一个英文的问号?,英文的点号.,英文的下划线_
短的选项参数支持单个参数值,值可以是必填的也可以是选填的,可以用如下格式:

  • 在参数名后加个空格,如-d /tmp
  • 紧跟在参数名后面,如-d/tmp
  • 在参数名后用等号=连接,如-d=/tmp

为了实现一个参数对应多个参数值,可以多次使用同一参数名,每次对应一个参数值,例如-d /tmp -d /var -d /opt;
当使用了ArgumentAcceptingOptionSpec#withValuesSeparatedBy(char) "separated values"配置了分隔符时,多值可以用流式的方法书写,多个值可以用这里配置好的分隔符分割。例如

parser.accepts( "z" ).withRequiredArg()
       .<strong>withValuesSeparatedBy( ',' )</strong>;
OptionSet options = parser.parse( new String[] { "-z", "foo,bar,baz", "-z",
       "fizz", "-z", "buzz" } );

使用options.valuesOf( "z" ) 得到的值如下[foo, bar, baz, fizz, buzz]

短的参数选项可以被聚合在一块写,例如-abc 可以看成是-a -b -c。如果这些参数是可以配置参数值的,那么后面的字符会被认定为参数值。
这里容易出错
-d是可以配置参数值的,那么-dabc不会被看成-d -a -b -c,而是会把abc看成是-d参数的参数值。

如果参数值只包含两个短横线--,后面的字符不会被认定为参数

如果参数值只包含一个短横线-,那么不会被认为是参数值(虽然理论上-可以是一个参数值)。因为很多unix程序都会把单个-看成是内建的输入输出流。

长格式选项


长的选项参数,用2个--开头,跟着多个英文字符、数字、短线、问号、点号。单个-不能是长选项参数的第一个字符。

长的参数可以用缩写,只要缩写的唯一的。可以在OptionParser的构造函数中配置是否可以使用缩写。

长的选项参数接受单个参数值,值可以是必填也可以是选填。可以用如下格式:

  • 在参数名后加个空格,如--directory /tmp
  • 在参数名后用等号=连接,如--directory=/tmp

多个参数值的处理方式和短的参数格式一致。

参数名-W是保留字,当使用recognizeAlternativeLongOptions(boolean)配置了可识别替换长参数时,-W foo=bar将被看成是--foo=bar
可以将-W当做是短的参数或者长参数的缩写,但是recognizeAlternativeLongOptions(boolean)会覆盖这种行为。

其他


当parser检测到一个参数的参数值是可选的,并且后面跟的一串字符“看上去”像是参数(不是参数值),那么这串字符就会认为是另一个参数,前一个参数没有参数值。
如果,另一方面,一个可选的参数值被识别为数字,那么参数值将被看作是一个负数,即使parser识别出来相应的数字选项参数名。例如:
parser.parse("-a", "-2");
此时,参数a的值是-2, 不会将a, 2都当做是参数名。

有2种方法告诉parser识别哪些参数:

  • 采用“流式”(fluent interface)风格的API设置options。采用accepts(String)或者acceptsAll(List)方法;调用链后面的方法描述了这个选项是否有参数值、参数值是必填还是选填,参数值应该转换成什么类型等。从版本3开始,这些方法调用返回OptionSpec,这将返回类型安全的参数值。

  • 从版本1开始,一种更加简洁的方法用于设置短格式选项OptionParser。这些选项的参数值默认是String类型。以下是设置特定字符串的规则:

  1. 任务字符或者数字被当做是一个选项
  2. 一个选项可以紧跟一个星号,表明这个选项是help选项
  3. 如果一个选项字符紧跟一个冒号:,意味着这个选项需要必填参数值
  4. 如果一个选项字符紧跟两个冒号::,那么这个选项接受可选的参数值
  5. 否则,这个选项不接受参数值
  6. 如果一个选项用一个加号+开始,这个parser和'POSIX-ly correct'方式一致
  7. 如果选项字符串包含W;parser将作为长格式的替换

acceptsAll方法参数列表中的每个选项都被认为是其他选项的同义词,例如:

OptionParser parser = new OptionParser();
parser.acceptsAll( asList( "w", "interactive", "confirmation" ) );
OptionSet options = parser.parse( "-w" );
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 196,540评论 5 462
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 82,640评论 2 374
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 143,643评论 0 326
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 52,672评论 1 267
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 61,525评论 5 358
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 46,387评论 1 275
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,809评论 3 387
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,450评论 0 255
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,743评论 1 294
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,787评论 2 314
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,560评论 1 326
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,406评论 3 315
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 37,824评论 3 300
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,048评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,335评论 1 253
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 41,784评论 2 342
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 40,997评论 2 337