如果我根据需要定义了2个选项,例如:
public static void main(String [] args){
Options options= new Options();
Option inputFileOp=Option.builder("i").longOpt("input").hasArg().desc("Input file").argName("file").required().build();
options.addOption(inputFileOp);
Option outputFileOp=Option.builder("o").longOpt("output").hasArg().desc("Output file").argName("file").required().build();
options.addOption(outputFileOp);
和帮助选项
Option helpOp =new Option("h",false,"Show Help");
helpOp.setLongOpt("help");
helpOptions.addOption(helpOp);
和解析器
DefaultParser parser = new DefaultParser();
CommandLine cmd=parser.parse(options,args);
if(cmd.hasOption(helpOp.getOpt())){
HelpFormatter formatter = new HelpFormatter();
formatter.printHelp( "MyApp.sh", options );
System.exit(0);
}
}
当用户输入例如myApp -h ..在解析步骤中引发了一个异常,即缺少必需的选项,而我想打印帮助数据。
如何在保持按要求声明这些选项的同时调用帮助?
答案 0 :(得分:9)
DefaultParser
的代码似乎总是调用checkRequiredArgs()
方法。这似乎表明你不能一举避免这个问题。
我们过去解决这种情况的方式,也许是次优的方式,是两次解析命令行。解析速度很快,因此开销很小。
我们创建了一个方法checkForHelp(String[] args)
,它接受(String [] args)。它将仅帮助选项添加到选项,解析命令行,然后确定是否指定了帮助。如果是,则打印帮助,程序退出。否则,将处理完整的选项集。此方法允许按预期处理所需的字段。请注意,还必须在主列表中添加帮助选项。
public static Option helpOption = Option.builder("h")
.longOpt("help")
.required(false)
.hasArg(false)
.build();
public static boolean checkForHelp(String[] args) throws ParseException {
boolean hasHelp = false;
Options options = new Options();
try {
options.addOption(helpOption);
CommandLineParser parser = new DefaultParser();
CommandLine cmd = parser.parse(options, args);
if (cmd.hasOption(helpOption.getOpt())) {
hasHelp = true;
}
}
catch (ParseException e) {
throw e;
}
return hasHelp;
}
然后在main
方法中,类似于:
options.addOption(hostOption);
options.addOption(portOption);
options.addOption(serviceNameOption);
options.addOption(helpOption); // <-- must also be here to avoid exception
try {
if (checkForHelp(args)) {
HelpFormatter fmt = new HelpFormatter();
fmt.printHelp("Help", options);
return;
}
CommandLineParser parser = new DefaultParser();
CommandLine cmd = parser.parse(options, args);
if (cmd.hasOption("host")) {
host = cmd.getOptionValue("host");
System.out.println(host); // gets in here but prints null
}
if (cmd.hasOption("port")) {
port = ((Number) cmd.getParsedOptionValue("port")).intValue();
System.out.println(port); // gets in here but throws a null
// pointer exception
}
if (cmd.hasOption("service_name")) {
serviceName = cmd.getOptionValue("service_name");
System.out.println(serviceName); // gets in here but prints null
}
}
catch (Exception e) {
e.printStackTrace();
}
编辑:事实证明,此方法与此处提供的答案类似:Commons CLI required groups。我想我感觉更好,我们的方法让其他人支持我们所相信的。
EDIT2 :在快速测试中,我认为使用&#34; OptionGroup&#34;可以避免使用所需选项的问题。这是修订后的checkForHelp
,可以通过将所有选项添加到OptionGroup来实现。在我的快速测试中,它避免了存在的问题,例如,(&#34; - arg1 --help&#34;)。
public static boolean checkForHelp(String[] args) throws ParseException
{
boolean hasHelp = false;
Options options = new Options();
try {
options.addOption(hostOption); //has required set
options.addOption(portOption);
options.addOption(serviceNameOption);
options.addOption(helpOption);
// create an option group
OptionGroup og = new OptionGroup();
og.addOption(hostOption);
og.addOption(portOption);
og.addOption(serviceNameOption);
og.addOption(helpOption);
CommandLineParser parser = new DefaultParser();
CommandLine cmd = parser.parse(options, args, false);
if (cmd.hasOption(helpOption.getOpt()) || cmd.hasOption(helpOption.getLongOpt())) {
hasHelp = true;
}
}
catch (ParseException e) {
throw e;
}
return hasHelp;
}
答案 1 :(得分:2)
使用--help/-h
进行解析之前,仅解析原始args并检查help.getOpt()/help.getLongOpt()
或DefaultParser
关键字是否会更容易?这样可以避免双重解析开销。
for (String s : args) {
if (s.equals("-h") || s.equals("--help")) { // or use help.getOpt() || help.getLongOpt()
formatter.printHelp("ApplicationName", arguments);
System.exit(1);
}
}
答案 2 :(得分:1)
添加另一种方法,正如之前的海报所说,但要确保你停在第一个无法识别的论点。
private static boolean hasHelp(final Option help, final String[] args) throws ParseException
{
Options options = new Options();
options.addOption(help);
CommandLineParser parser = new DefaultParser();
CommandLine cmd = parser.parse(options, args, true);
return cmd.hasOption(help.getOpt());
}
如果stopAtNonOption
设置为false,则此函数将抛出有效参数,例如java -jar app.jar -doStuff