Java命令行界面(第2部分):args4j
在上一篇文章中 ,我研究了如何使用Apache Commons CLI在Java应用程序中解析命令行参数。 在本文中,我将使用另一个库args4j进行相同的操作。
args4j采用了一种不同于Commons CLI的方式来指定Java应用程序应期望的命令行参数。 尽管Commons CLI期望代表选项的对象将被单独且显式实例化,但args4j使用自定义注释来促进命令行参数处理的这一“定义”阶段。 命令行选项应该是类上的实例级字段,并带有@ org.kohsuke.args4j.Option批注。 每个命令行参数的特征都包含在此@Option
注释的属性中。
本文中演示的简单应用程序与我上一篇文章中使用的应用程序相似,并着重于用于指定详细程度的可选且无值的-v
选项,以及所需的-f
选项,该选项期望代表文件路径和名称的值。 下一个代码清单演示了如何使用args4j的@Option
注释将这些命令行参数设置为类数据成员上的注释。
args4j通过@Option注释定义命令行参数
@Option(name="-v", aliases="--verbose", usage="Print verbose status.")
private boolean verbose;@Option(name="-f", aliases="--file", usage="Fully qualified path and name of file.", required=true)
private String fileName;
如上面的代码清单所示,很容易指定选项的名称,用法以及是否需要(默认是可选的)。 上面的private
修饰符的存在使它们很明显是在类级别定义的属性。 因为没有static
修饰符,所以我们看到这些是已注释的实例变量。
要解析命令行选项,只需实例化一个CmdLineParser并将命令行参数传递给其parseArguments(String ...)方法:
解析args4j中的命令行参数
final CmdLineParser parser = new CmdLineParser(this);
try
{parser.parseArgument(arguments);
}
catch (CmdLineException clEx)
{out.println("ERROR: Unable to parse command-line options: " + clEx);
}
在刚刚显示的Java代码的第一行中, this
是对类实例的引用,在该类实例中定义了上面显示的成员变量并使用@Option
注释@Option
注释。 在这种情况下,我使用this
是因为定义这些选项的同一类是调用此解析方法的类。 为了在同一个类中执行此操作,我需要在类中定义一个名为doMain
的实例(非static
)方法,并由该类的main
函数调用该方法(这在本文结尾处的完整代码清单中显示)。 从类的main(final String[])
函数接收的命令行参数是传递给parseArguments(String[])
方法的parseArguments(String[])
数组。
接下来的两个屏幕快照演示了基于args4j的上述代码在解析命令行参数中的应用。 第一张图片显示了两个选项的短选项和长选项的组合。 第二个图像显示了自动报告未提供必需的命令行参数的情况。
命令行解析库的一个重要功能是能够显示用法或帮助信息。 下一个代码清单演示了使用args4j的CmdLineParser.printUsage(OutputStream)方法执行此操作的示例。
使用args4j打印使用情况信息
final CmdLineParser parser = new CmdLineParser(this);
if (arguments.length < 1)
{parser.printUsage(out);System.exit(-1);
}
下一个屏幕快照描述了args4j默认打印出的使用情况信息。
这篇文章演示了如何使用arg4j实现与Java应用程序中的命令行解析有关的一些最常见功能,包括选项“定义”,命令行参数“解析”,对所解析的命令行参数的“询问”以及帮助/ us与命令行参数有关的详细信息。 现在显示了上面在代码清单中部分表示的类的完整代码清单。
args4j演示Main.java的完整代码清单
package examples.dustin.commandline.args4j;import static java.lang.System.out;import org.kohsuke.args4j.CmdLineException;
import org.kohsuke.args4j.CmdLineParser;
import org.kohsuke.args4j.Option;import java.io.IOException;/*** Demonstrate args4j.*/
public class Main
{@Option(name="-v", aliases="--verbose", usage="Print verbose status.")private boolean verbose;@Option(name="-f", aliases="--file", usage="Fully qualified path and name of file.", required=true)private String fileName;private void doMain(final String[] arguments) throws IOException{final CmdLineParser parser = new CmdLineParser(this);if (arguments.length < 1){parser.printUsage(out);System.exit(-1);}try{parser.parseArgument(arguments);}catch (CmdLineException clEx){out.println("ERROR: Unable to parse command-line options: " + clEx);}out.println("The file '" + fileName + "' was provided and verbosity is set to '" + verbose + "'.");}/*** Executable function demonstrating Args4j command-line processing.** @param arguments Command-line arguments to be processed with Args4j.*/public static void main(final String[] arguments){final Main instance = new Main();try{instance.doMain(arguments);}catch (IOException ioEx){out.println("ERROR: I/O Exception encountered: " + ioEx);}}
}
这是在选择框架或库来帮助Java进行命令行解析时要考虑的args4j的一些其他特征。
- args4j是开放源代码,并已获得MIT许可证 。
- 当前版本的args4j( 2.33 ) 需要 J2SE 5 。
- args4j不需要单独下载或引用任何第三方库。
- args4j 2.33主JAR(
args4j-2.33.jar
)的大小约为152 KB。 - Maven存储库显示了376个对args4j的依赖关系 ,包括OpenJDK的JMH Core和Jenkins (考虑到川口晃介的参与,这不足为奇)。
- args4j已经存在了一段时间; 其2.0.3版本于2006年1月发布 ,至少从2003年开始就以某种形式出现。
- args4j允许通过
@Option
注释上的“ hidden ”将命令行参数从使用情况输出中排除。 - args4j允许指定和强制执行命令行参数之间的关系。 这包括指定何时不能同时提供两个参数的能力(“ 禁止 ”),以及仅当还提供了另一个参数时(“ depends ”)才有意义的情况。
- args4j支持在有限的一组值适用于该选项的情况下使用枚举类型的类属性。 @Option文档在“枚举开关”部分下说明了如何执行此操作。
- args4j通过其OptionHandler类提供了命令行参数解析的可扩展性和可定制性。
args4j库易于使用,并允许高度可读的代码。 决定是否使用args4j时,最大的考虑因素可能是确定使用批注指定命令行参数定义的舒适程度。
其他参考
- args4j
- args4j下载
- args4j源代码 (GitHub)
- args4j API文档
- args4j样本主
翻译自: https://www.javacodegeeks.com/2017/06/java-command-line-interfaces-part-2-args4j.html
Java命令行界面(第2部分):args4j相关推荐
- Java命令行界面(第7部分):JCommander
这是我系列的第七篇文章,简要介绍了用于处理Java命令行参数的各种库. 这篇文章回到了基于注释的库的覆盖范围,该库似乎是在Java中可用于处理命令行参数的众多可用库中知名度最高和最受欢迎的库之一: J ...
- Java命令行界面(第30部分):观察
这个有关Java命令行参数解析的系列文章由四个月来发表的29篇文章组成,涵盖了28个不同的开放源代码库,可用于解析Java命令行参数. 这篇文章收集了可以从本系列的前29篇文章中得出的一些观点,并提供 ...
- Java命令行界面(第3部分):jbock
在本系列中有关使用Java进行命令行分析的前两篇文章中,我介绍了Apache Commons CLI和args4j库. 在本系列的第三篇文章中,我将介绍jbock ,它是自我描述的"非常简单 ...
- Java命令行界面(第10部分):picocli
picocli主页面将picocli描述为"强大的微小命令行界面"," picocli"是一个文件Java框架,用于解析命令行参数并生成精美,易于定制的用法帮助 ...
- Java命令行界面(第5部分):JewelCli
细算在Java命令行处理与Apache的百科全书CLI , args4j , jbock和命令行中先前的文章,我把注意力转向在这个岗位使用JewelCli完成的命令行参数相似的处理Java中. 几个J ...
- Java命令行界面(第21部分):航空公司2
本系列文章的第21篇关于Java中解析命令行参数的文章的重点是Airline 2库. Airline 2的GitHub项目页面描述了该库," Airline是一个Java库,提供了基于注释的 ...
- Java命令行界面(第1部分):Apache Commons CLI
尽管我通常使用Groovy编写要从命令行运行的JVM托管脚本,但是有时候我需要解析Java应用程序中的命令行参数,并且有很多库可供Java开发人员用来解析命令行参数. 在本文中,我将介绍这些Java命 ...
- Java命令行界面(第18部分):JCLAP
Giles Winstanley的JCLAP ( Java命令行参数解析器 )是基于Java的命令行处理库的系列文章中介绍的第18个库. 这篇文章的示例基于需要Java 8的 JCLAP 1.4 . ...
- Java命令行界面(第4部分):命令行
我在Java中进行命令行解析的系列的第四部分介绍了Commandline ,它被描述为 "用于解析命令行参数的Java库",它"基于使用注释从命令行参数到对象的映射&qu ...
最新文章
- will_paginate 用作查询分页的注意事项
- vb.net 功能f8键事件_笔记本电脑功能键介绍
- 成功解决ValueError: Data is not binary and pos_label is not specified
- Android项目创建欢迎页
- 前端开发掌握nginx常用功能之serverlocation匹配规则
- hashmap另一种初始化
- 【转】js日期时间函数
- oppo5.0以上系统怎么样不Root激活Xposed框架的经验
- 2015-2016-1学期 《信息安全系统设计基础》课程总结
- Java零基础系列003——变量
- 内存映射过程之paging_init
- WordPress漏洞扫描器wpscan
- python数据分析有哪些模型-python数据挖掘的基本流程有哪些?
- 推荐算法架构1:召回
- java beetl输出demo_Beetl 快速入门
- Error:Cannot read packageName from AndroidManifest.xml
- 本地化部署方案 VS 云托管方案
- 七夕界的浪漫之光,向你安利程序员的表白方式
- JGG | EVenn: 3分钟在线轻松绘制5种Venn图和Venn网络
- cobaltstrike如何安装使用(包含CS联动MSF详细用法!)? (゚益゚メ) 渗透测试
热门文章
- jQuery 基础教程 (一)之jQuery的由来及简介
- Java Map集合面试题汇总
- 从 Linux 源码看 Socket 的阻塞和非阻塞
- Nginx中如何配置中文域名?
- el表达式与jstl的用法
- SpringIOC的创建对象的单例多例模式和自动注入
- 将Springboot项目放在服务器上一直运行
- 外部访问docker容器(docker run -p/-P 指令) docker run -d -p 5000:5000 {hostPort:containerPort(映射所有接口地}
- vba mysql update多字段_vba操作Mysql使用UPDATE一次更新多组数据
- linux-basic(12)正则表达式与文件格式化处理