Apache Commons CLI官方文档翻译 —— 快速构建命令行启动模式
昨天通过几个小程序以及Hangout源码学习了CLI的基本使用，今天就来尝试翻译一下CLI的官方使用手册。
下面将会通过几个部分简单的介绍CLI在应用中的使用场景。
昨天已经联系过几个基本的命令行参数使用场景，可以参考这里
通过使用Apache Commons CLI可以帮助开发者快速构建命令行启动模式，并可以快速生成帮助指令，基于用户启动参数提供不同的服务。
入门样例
下面就举个例子，比如我想输入命令:
xxx -t
从而打印出当前的时间。
定义阶段——创建选项
首先要创建Options对象，然后添加Option对象.
// create Options object
Options options = new Options();
// add t option
options.addOption("t", false, "display current time");
其中addOption方法有三个参数：
- 第一个参数是字符串类型，代表命令的参数。
- 第二个参数是Bool型，代表该选项是否需要额外的参数。
- 第三个参数是该选项的描述信息。
上面的例子就代表，t选项不需要参数，它的意思是显示当前时间。
解析阶段——解析命令行参数
CLI通过CommandLineParser的parse方法解析命令行参数。有好几种CommandLineParser的实现类，推荐使用的是DefaultParser。看源码除了这个DefaultParser，其他的都被打上了@Deprecated标记。
除去这个DefaultParser以外，还有一个抽象类实现了CommandLineParser接口——Parser,这个Parser有三个子类：
- BasicParser
- GnuParser
- PosixParser
CommandLineParser parser = new DefaultParser();
CommandLine cmd = parser.parse( options, args);
询问阶段—— 判断命令行中出现了哪个选项
现在就可以检查是否存在这个t选项了，首先需要在CommandLine对象中进行查询。hasOption方法可以通过选项的名字，判断命令行是否出现该命令。出现则返回true,否则返回false。
if(cmd.hasOption("t")) {
// print the date and time
}
else {
// print the date
}
全部代码
public class DateApp {
public static void main(String[] args) {
String[] arg = {"-t"};
// String[] arg = {};
try {
testOption(arg);
} catch (ParseException e) {
e.printStackTrace();
}
}
static void testOption(String[] args) throws ParseException{
Options options = new Options();
options.addOption("t", false, "display current time");
CommandLineParser parser = new DefaultParser();
CommandLine cmd = parser.parse( options, args);
if(cmd.hasOption("t")) {
System.out.println((new SimpleDateFormat("yyyy-MM-dd HH:mm:ss")).format(new Date()));
}else {
System.out.println((new SimpleDateFormat("yyyy-MM-dd")).format(new Date()));
}
}
}
进阶样例
下面这个例子继承自DateApp，并且提供了根据城市显示时间和日期的功能。为了实现这个命令，会增加一个c选项，来添加城市信息。
// add c option
options.addOption("c", true, "country code");
第二个参数这时设置为true，就代表它需要额外的参数。
获得参数值
CommandLine对象的getOptionValue方法可以获取到参数的值。
// get c option value
String countryCode = cmd.getOptionValue("c");
if(countryCode == null) {
// print default date
}else {
// print date for country specified by countryCode
}
此时如果只有c选项，没有参数，就会报错
org.apache.commons.cli.MissingArgumentException: Missing argument for option: c
at org.apache.commons.cli.DefaultParser.checkRequiredArgs(DefaultParser.java:211)
at org.apache.commons.cli.DefaultParser.parse(DefaultParser.java:125)
at org.apache.commons.cli.DefaultParser.parse(DefaultParser.java:76)
at org.apache.commons.cli.DefaultParser.parse(DefaultParser.java:60)
at hangout.study.InternationalDateApp.testOption(InternationalDateApp.java:29)
at hangout.study.InternationalDateApp.main(InternationalDateApp.java:18)
全部代码
public class InternationalDateApp {
public static void main(String[] args) {
String[] arg = {"-t","-c","hello"};
// String[] arg = {"-t","-c"};
// String[] arg = {};
try {
testOption(arg);
} catch (ParseException e) {
e.printStackTrace();
}
}
static void testOption(String[] args) throws ParseException{
Options options = new Options();
options.addOption("t", false, "display current time");
options.addOption("c", true, "country code");
CommandLineParser parser = new DefaultParser();
CommandLine cmd = parser.parse( options, args);
if(cmd.hasOption("t")) {
System.out.println((new SimpleDateFormat("yyyy-MM-dd HH:mm:ss")).format(new Date())+" in "+cmd.getOptionValue("c"));
}else {
System.out.println((new SimpleDateFormat("yyyy-MM-dd")).format(new Date()));
}
}
}
此时运行代码，则会正确输出信息:
2016-06-23 21:18:50 in hello
Ant样例
下面举一个Ant的样例，下面是Ant输出的帮助信息
ant [options] [target [target2 [target3] ...]]
Options:
-help print this message
-projecthelp print project help information
-version print the version information and exit
-quiet be extra quiet
-verbose be extra verbose
-debug print debugging information
-emacs produce logging information without adornments
-logfile <file> use given file for log
-logger <classname> the class which is to perform logging
-listener <classname> add an instance of class as a project listener
-buildfile <file> use given buildfile
-D<property>=<value> use value for given property
-find <file> search for buildfile towards the root of the
filesystem and use it
使用Bool选项创建
Option help = new Option( "help", "print this message" );
Option projecthelp = new Option( "projecthelp", "print project help information" );
Option version = new Option( "version", "print the version information and exit" );
Option quiet = new Option( "quiet", "be extra quiet" );
Option verbose = new Option( "verbose", "be extra verbose" );
Option debug = new Option( "debug", "print debugging information" );
Option emacs = new Option( "emacs","produce logging information without adornments" );
也可以使用OptionBuilder构建选项：
Option logfile = OptionBuilder.withArgName( "file" )
.hasArg()
.withDescription( "use given file for log" )
.create( "logfile" );
Option logger = OptionBuilder.withArgName( "classname" )
.hasArg()
.withDescription( "the class which it to perform "+ "logging" )
.create( "logger" );
Option listener = OptionBuilder.withArgName( "classname" )
.hasArg()
.withDescription( "add an instance of class as "+ "a project listener" )
.create( "listener");
Option buildfile = OptionBuilder.withArgName( "file" )
.hasArg()
.withDescription( "use given buildfile" )
.create( "buildfile");
Option find = OptionBuilder.withArgName( "file" )
.hasArg()
.withDescription( "search for buildfile towards the "+ "root of the filesystem and use it" )
.create( "find" );
最后一个OptionBuilder创建带有参数名称的选项：
Option property = OptionBuilder.withArgName( "property=value" )
.hasArgs(2)
.withValueSeparator()
.withDescription( "use value for given property" )
.create( "D" );
通过上面的方式定义的属性，可以通过CommandLine对象的getOptionProperties("D")方法获得。
定义阶段——创建选项
Options options = new Options();
options.addOption( help );
options.addOption( projecthelp );
options.addOption( version );
options.addOption( quiet );
options.addOption( verbose );
options.addOption( debug );
options.addOption( emacs );
options.addOption( logfile );
options.addOption( logger );
options.addOption( listener );
options.addOption( buildfile );
options.addOption( find );
options.addOption( property );
解析阶段——创建解析器
跟前面类似，创建CommandLineParser解析器，返回CommandLine对象，用于查询选项参数。
public static void main( String[] args ) {
// create the parser
CommandLineParser parser = new DefaultParser();
try {
// parse the command line arguments
CommandLine line = parser.parse( options, args );
}
catch( ParseException exp ) {
// oops, something went wrong
System.err.println( "Parsing failed. Reason: " + exp.getMessage() );
}
}
询问阶段——查询命令行参数
通过hasOption选项判断是否包含某个选项参数:
// has the buildfile argument been passed?
if( line.hasOption( "buildfile" ) ) {
// initialise the member variable
this.buildfile = line.getOptionValue( "buildfile" );
}
创建帮助信息
一般命令行工具都有help帮助提示，即输入-h命令，就会输出所有的命令参数。CLI提供给我们快捷输出帮助信息的工具——HelpFormatter。
// automatically generate the help statement
HelpFormatter formatter = new HelpFormatter();
formatter.printHelp( "ant", options );
当执行到此处时，就会输出相应的帮助信息
usage: ant
-D <property=value> use value for given property
-buildfile <file> use given buildfile
-debug print debugging information
-emacs produce logging information without adornments
-file <file> search for buildfile towards the root of the
filesystem and use it
-help print this message
-listener <classname> add an instance of class as a project listener
-logger <classname> the class which it to perform logging
-projecthelp print project help information
-quiet be extra quiet
-verbose be extra verbose
-version print the version information and exit
全部代码
public class AntExample {
public static void main(String[] args) {
String[] arg = {"-help"};
testOption(arg);
}
@SuppressWarnings({ "deprecation", "static-access" })
static void testOption(String[] args){
Option help = new Option( "help", "print this message" );
Option projecthelp = new Option( "projecthelp", "print project help information" );
Option version = new Option( "version", "print the version information and exit" );
Option quiet = new Option( "quiet", "be extra quiet" );
Option verbose = new Option( "verbose", "be extra verbose" );
Option debug = new Option( "debug", "print debugging information" );
Option emacs = new Option( "emacs","produce logging information without adornments" );
Option logfile = OptionBuilder.withArgName( "file" )
.hasArg()
.withDescription( "use given file for log" )
.create( "logfile" );
Option logger = OptionBuilder.withArgName( "classname" )
.hasArg()
.withDescription( "the class which it to perform "+ "logging" )
.create( "logger" );
Option listener = OptionBuilder.withArgName( "classname" )
.hasArg()
.withDescription( "add an instance of class as "+ "a project listener" )
.create( "listener");
Option buildfile = OptionBuilder.withArgName( "file" )
.hasArg()
.withDescription( "use given buildfile" )
.create( "buildfile");
Option find = OptionBuilder.withArgName( "file" )
.hasArg()
.withDescription( "search for buildfile towards the " + "root of the filesystem and use it" )
.create( "find" );
Option property = OptionBuilder.withArgName( "property=value" )
.hasArgs(2)
.withValueSeparator()
.withDescription( "use value for given property" )
.create( "D" );
Options options = new Options();
options.addOption( help );
options.addOption( projecthelp );
options.addOption( version );
options.addOption( quiet );
options.addOption( verbose );
options.addOption( debug );
options.addOption( emacs );
options.addOption( logfile );
options.addOption( logger );
options.addOption( listener );
options.addOption( buildfile );
options.addOption( find );
options.addOption( property );
CommandLineParser parser = new DefaultParser();
try {
CommandLine line = parser.parse( options, args );
if( line.hasOption( "buildfile" ) ) {
System.out.println(line.getOptionValue( "buildfile" ));
}
if( line.hasOption("help")){
HelpFormatter formatter = new HelpFormatter();
formatter.printHelp( "ant", options );
}
}catch( ParseException exp ) {
System.err.println( "Parsing failed. Reason: " + exp.getMessage() );
}
}
}
运行后得到下面的输出信息：
usage: ant
-buildfile <file> use given buildfile
-D <property=value> use value for given property
-debug print debugging information
-emacs produce logging information without adornments
-find <file> search for buildfile towards the root of the
filesystem and use it
-help print this message
-listener <classname> add an instance of class as a project listener
-logfile <file> use given file for log
-logger <classname> the class which it to perform logging
-projecthelp print project help information
-quiet be extra quiet
-verbose be extra verbose
-version print the version information and exit
如果想在输出信息中加入参数列表，也可以在printHelp加入第三个参数true， formatter.printHelp( "ant", options, true);
usage: ant [-buildfile <file>] [-D <property=value>] [-debug] [-emacs]
[-find <file>] [-help] [-listener <classname>] [-logfile <file>]
[-logger <classname>] [-projecthelp] [-quiet] [-verbose] [-version]
-buildfile <file> use given buildfile
-D <property=value> use value for given property
-debug print debugging information
-emacs produce logging information without adornments
-find <file> search for buildfile towards the root of the
filesystem and use it
-help print this message
-listener <classname> add an instance of class as a project listener
-logfile <file> use given file for log
-logger <classname> the class which it to perform logging
-projecthelp print project help information
-quiet be extra quiet
-verbose be extra verbose
-version print the version information and exit
LS样例
这个例子模拟了Linux下的命令行使用帮助：
全部代码：
public class LSExample {
public static void main(String[] args) {
String[] arg = new String[]{ "--block-size=10" };
testOption(arg);
}
static void testOption(String[] args){
CommandLineParser parser = new DefaultParser();
// create the Options
Options options = new Options();
options.addOption( "a", "all", false, "do not hide entries starting with ." );
options.addOption( "A", "almost-all", false, "do not list implied . and .." );
options.addOption( "b", "escape", false, "print octal escapes for nongraphic "
+ "characters" );
options.addOption( OptionBuilder.withLongOpt( "block-size" )
.withDescription( "use SIZE-byte blocks" )
.hasArg()
.withArgName("SIZE")
.create() );
options.addOption( "B", "ignore-backups", false, "do not list implied entried "
+ "ending with ~");
options.addOption( "c", false, "with -lt: sort by, and show, ctime (time of last "
+ "modification of file status information) with "
+ "-l:show ctime and sort by name otherwise: sort "
+ "by ctime" );
options.addOption( "C", false, "list entries by columns" );
try {
CommandLine line = parser.parse( options, args );
if( line.hasOption( "block-size" ) ) {
System.out.println( line.getOptionValue( "block-size" ) );
}
}
catch( ParseException exp ) {
System.out.println( "Unexpected exception:" + exp.getMessage() );
}
}
}
输出可以得到下面的信息:
10
usage: ls
-a,--all do not hide entries starting with .
-A,--almost-all do not list implied . and ..
-b,--escape print octal escapes for nongraphic characters
-B,--ignore-backups do not list implied entried ending with ~
--block-size <SIZE> use SIZE-byte blocks
-c with -lt: sort by, and show, ctime (time of last
modification of file status information) with
-l:show ctime and sort by name otherwise: sort
by ctime
-C list entries by columns
参考
Apache Commons CLI官方文档翻译 —— 快速构建命令行启动模式的更多相关文章
- Go通过cobra快速构建命令行应用
来自jetbrains Go 语言现状调查报告 显示:在go开发者中使用go开发实用小程序的比例为31%仅次于web,go得益于跨平台.无依赖的特性,用来编写命令行或系统管理这类小程序非常不错. 本文 ...
- Apache Commons CLI 开发命令行工具示例
概念说明Apache Commons CLI 简介 虽然各种人机交互技术飞速发展,但最传统的命令行模式依然被广泛应用于各个领域:从编译代码到系统管理,命令行因其简洁高效而备受宠爱.各种工具和系统都 提 ...
- Apache Commons CLI命令行启动
今天又看了下Hangout的源码,一般来说一个开源项目有好几种启动方式--比如可以从命令行启动,也可以从web端启动.今天就看看如何设计命令行启动... Apache Commons CLI Apac ...
- 使用 Apache Commons CLI 开发命令行工具示例
Apache Commons CLI 简介 Apache Commons CLI 是 Apache 下面的一个解析命令行输入的工具包,该工具包还提供了自动生成输出帮助文档的功能. Apache Com ...
- 使用 Apache Commons CLI 解析命令行参数示例
很好的输入参数解析方法 ,转载记录下 转载在: https://www.cnblogs.com/onmyway20xx/p/7346709.html Apache Commons CLI 简介 Apa ...
- Apache Commons CLI 简介
CLI 命令代码实现 命令行程序处理流程相对比较简单,主要流程为设定命令行参数 -> 解析输入参数 -> 使用输入的数据进行逻辑处理CLI 定义阶段 每一条命令行都必须定义一组参数,它们被 ...
- The type org.apache.commons.cli.Options cannot be resolved. It is indirectly referenced from required .class files
在搭建好Hadoop Eclipse开发环境后,编写map-reduce,遇到如下的问题: 从字面上可以看出,工程缺少org.apache.commons.cli.Options,这个包被间接的被其他 ...
- PHP的CLI命令行运行模式浅析
在做开发的时候,我们不仅仅只是做各种网站或者接口,也经常需要写一些命令行脚本用来处理一些后端的事务.比如对数据进行处理统计等.当然也是为了效率着想,当一个事务有可能会有较长的耗时时,往往会交由服务器的 ...
- Spring Boot通过命令行启动发生FileNotFoundException
Spring Boot + Jersey 通过命令行启动会发生错误FileNotFoundException异常 异常信息如下: ERROR o.a.c.c.C.[Tomcat].[localhost ...
随机推荐
- 一般处理程序如何获取session值
1.要在一般处理程序中获取其他页面的session值,需要引用名空间: using System.Web.SessionState; 2.然后继承一个接口:IRequiresSessionState ...
- 看JVM就推荐这本书
话不多说,喜欢JVM的可以加Q群:397196583
- curl 传递用户session
$cmh = curl_multi_init(); $ch = curl_init(); curl_setopt($ch,CURLOPT_URL, $url); curl_setopt($ch, CU ...
- mysql快速导出数据库ER图和数据字典（附navicat11安装教程及资源）
♣ mysql使用navicat11快速导出数据库ER图 ♣ mysql使用navicat11快速导出数据库数据字典 ♣ navicat11 for mysql (这里是mysql5.7.12)专业版 ...
- ssh 文件权限影响登录
进入/etc/ssh目录 需要保证文件访问控制权限如下: ssh_host_dsa_key 600 ssh_host_ras_key 600
- 论文笔记（1）——《Where's Wally?Precise User Discovery Attacks in Location Proximity Services》
Abstract: 位置相近服务在社交和移动网络的广泛使用是基于可用性和用户隐私的平衡,但引发了三角定位攻击的风险.文章系统化地讨论了此类攻击的防范,包括问题在不同临近模型下的形式化,针对不同模型的有 ...
- 开发者所需要知道的 iOS 10 SDK 新特性
转自:https://onevcat.com/2016/06/ios-10-sdk/ 写的很好啊.哈哈哈 总览 距离 iPhone 横空出世已经过去了 9 个年头,iOS 的版本号也跨入了两位数.在我 ...
- WordPress基础：文章的自定义栏目的使用
写文章只有标题和内容,那么我想加个加个怎么办呢?这时候就可以用到自定义栏目了,这个功能相当于增加了一个键值对 1.启动“自定义栏目” 2.定义键值对 3.调用自定义栏目值 <?php $pric ...
- 解决警告“ld: warning: directory not found for option
因为已经把文件编译到项目中,删除的话会出现找不到文件或文件夹的警告. 1选择工程, 编译的 (targets) 2选择 Build Settings 菜单 3查找 Library Search Pat ...
- angularJs之定时器
$timeout 服务 AngularJS $timeout 服务对应了 JS window.setTimeout 函数. 实例 两秒后显示信息: var app = angular.module(' ...