cli命令行界面 demo_Java命令行界面（第24部分）：MarkUtils-CLI

最新推荐文章于 2024-02-02 00:45:23 发布

dnc8371

最新推荐文章于 2024-02-02 00:45:23 发布

阅读量134

点赞数

文章标签： java python android linux 编程语言

原文链接：https://www.javacodegeeks.com/2017/10/java-command-line-interfaces-part-24-markutils-cli.html

版权

cli命令行界面 demo

本系列的第一篇有关使用Java解析命令行参数的文章介绍了Apache Commons CLI库。这是本系列中介绍的基于Java的命令行解析库中最古老的，而且可能是最常用的之一。 Apache Commons CLI确实显示了它的时代，特别是与一些更现代的基于Java的命令行处理库相比时。 Mark A. Ziesemer的“ Apache Commons CLI上的CLI库包装”，称为MarkUtils-CLI，旨在“现代化” Apache Commons CLI，并且是本博客文章的主题。

Ziesemer在博客文章“ MarkUtils-CLI：Apache Commons CLI的注释（及更多） ”中写道：

我觉得Apache Commons CLI项目卖空了。 我发现它是一个非常全面，设计良好的库，可以有效地解析命令行。 我观察到的唯一缺点是该项目是在Java 5和注释可用之前开发的。 因此，该库不支持注释必须提供的任何功能。

引入MarkUtils的最新功能：MarkUtils-CLI是一个库，可在Apache Commons CLI和Java注释之间提供有效的桥梁，而无需替换成熟的Commons CLI库。

这篇文章使用了与本系列以前的文章（“文件”和“详细”命令行选项）相似的示例，以说明MarkUtils-CLI如何包装Apache Commons CLI，并允许通过注释定义选项并提供类型化选项。在本文中，使用MarkUtils-CLI的CliRunner是为了方便。这些示例的完整源代码清单可在GitHub上找到。

MarkUtils-CLI的“定义”阶段是应用@Parameter注释的地方，如下面的代码清单所示。

MarkUtils-CLI的“定义”阶段

@Parameter(name="f", longName="file", description="Path/name of file", required=true)
public String file;

@Parameter(name="v", longName="verbose", description="Verbosity enabled or not", argCount=0)
public boolean verbose;

此代码清单显示了如何将“短”选项名称（单个连字符/单个字符）和“长”选项名称（双连字符/单词）指定为@Parameter批注的不同元素。 MarkUtils-CLI创建的“帮助”中可以使用“ description ”元素，并且“ required ”注释元素允许您指定必需的选项。为“详细”指定argCount为零还向解析器指示“详细”选项不需要任何参数。

可以通过CliRunner和Apache Commons CLI CommandLineParser的实例在MarkUtils-CLI中完成“解析”阶段。在下一个代码清单中对此进行了演示，其中将Apache Commons CLI的DefaultParser实例与该类的实例（其字段使用@Parameter注释进行注释）一起传递给CliRunner的构造函数。

MarkUtils-CLI的“解析”阶段

final DefaultParser cmdLineParser = new DefaultParser();
final CliRunner<Main> cliRunner = new CliRunner(cmdLineParser, Main.class);

当使用MarkUtils-CLI的CliRunner方法时，“询问”阶段是在Callable的call（）方法中完成的，该方法传递给CliRunner的“ run”方法。下一个代码清单中显示了“ call（）”方法的实现，在GitHub的完整源代码清单中提供了将拥有的Callable传递给CliRunner的“ run”方法的代码。

MarkUtils-CLI的“审讯”阶段

@Override
public Integer call() throws Exception
{
   out.println("File path/name is '" + file + "' and verbosity is " + verbose);
   return file != null ? 0 : -1;
}

接下来的两个屏幕快照演示了到目前为止显示的示例。第一张图片显示了当没有提供所需的“文件”选项时生成的帮助信息。第二张图片描绘了针对“文件”和“详细”的短名称和长名称选项的各种组合的示例代码的行为。

选择框架或库来帮助Java进行命令行解析时，需要考虑MarkUtils-CLI的特征。

MarkUtils-CLI是开源的，并根据GNU通用公共许可证版本3 获得许可。
- 一些，尤其是企业看来，是不舒服与GPLv3的许可证。
MarkUtils-CLI可作为单独的JAR获得，但从概念上讲，它是可从https://java.ziesemer.com/获得的更大MarkUtils的一部分。
com.ziesemer.utils.cli-2017.05.28.jar JAR相对较小（大约26 KB），但对外部库Apache Commons CLI具有运行时依赖性（预期是因为MarkUtils-CLI包装了此库）和SLF4J （因为SLF4J为广泛使用的库，对于许多人来说，这种依赖性可能不是什么大问题。
MarkUtils-CLI需要Java SE 6 。
MarkUtils-CLI的作者向我通知了该库的存在，并且似乎正在积极地支持它，这对于本系列中的所有库都无法说明。他已经表示，他“致力于响应和解决遇到的任何问题 ” MarkUtils-CLI GitHub Issues Tracker 。他还指出，有95个正在执行的单元测试，它们验证了MarkUtils-CLI的功能。

MarkUtils-CLI是Apache Commons CLI的小型包装，通过使用批注和命令行选项类型的处理，使Apache Commons CLI体验现代化。 MarkUtils-CLI很可能会吸引那些已经在使用Apache Commons CLI的用户，并希望享受更轻松的带有注释的选项定义和更多类型安全的选项解析的好处。该库的优点包括库的当前支持和全面的单元测试。可能阻止某些人使用该库的问题是其GPL许可证及其对SLF4J的外部依赖关系（假定Apache Commons CLI依赖关系不是问题，因为它被宣传为Apache Commons CLI的包装器）。

其他参考