1

我正在使用 Pico CLI v4.0.0-alpha-3 和 jline v3。我有以下课程(使用注释)。当我运行主类时,我似乎无法运行命令并调用可调用对象。如果我只是传入参数,我可以调用可调用对象。

@CommandLine.Command(name = "Test CLI",
        description = "CLI tool",
        header = "%n@|green test cli |@",
        footer = {"",
                "@|cyan Press Ctrl-D to exit the CLI.|@",
                        ""},
        version = "1.0.0",
        showDefaultValues = true,
        optionListHeading = "@|bold %nOptions|@:%n",
        subcommands = {
                Sync.class,
                Status.class
    })
public class Tester implements Callable<Integer> {

    private static final String PROMPT = "Test CLI> ";

    private LineReaderImpl lineReader;
    private PrintWriter out;


    @Option(names = {"-u", "--username"}, required = true, description = "user name")
    private String userName;

    @Option(names = {"-p", "--password"}, required = true, description = "password")
    private String password;



   final Tester tester = new Tester();
    final CommandLine cmd = prepareCommand(tester);
    final int exitCode = cmd.execute(args);

当我运行 java 应用程序并使用参数运行命令时,不会调用可调用对象。当我简单地传入参数时,可调用对象被调用。关于如何解决此问题的任何想法,以便 CLI 用户必须传入命令和参数。

4

2 回答 2

1

打开 CLI 终端后,我永远无法使用命令名称。我可以只使用没有命令名的参数。

我最终将逻辑移动到一个子命令,之后可以调用该子命令。但是,现在 CLI 将建议的命令显示为“父命令 + 子命令”,我可以看到这非常令人困惑(并且使用该选项不会产生预期的结果)。我最终从父命令中删除了描述以处理它。

于 2019-06-07T03:02:11.737 回答
1

命令行实用程序

我认为 java 应用程序的打包方式是造成混乱的原因。如果您的应用程序是单个可执行文件,比如说myapp.exe,那么您将在命令行上调用该应用程序,如下所示:

myapp -u xxx

如果您的应用程序是 Java 类,则需要像这样调用它:

java -cp mylib.jar com.myorg.MyApp -u xxx

因此,顶级命令是com.myorg.MyApp类本身,无需在命令行上指定myapp为类的参数com.myorg.MyApp

现在假设您的myapp应用程序有一个子命令,称为sub. 同样,如果您的应用程序是单个可执行文件,您将在命令行上调用子命令,如下所示:

myapp sub --subcommand-options

作为一个 Java 类,您需要像下面这样调用它。请注意,在这里,您确实需要将子命令名称指定为类的命令行参数com.myorg.MyApp

java -cp mylib.jar com.myorg.MyApp sub --subcommand-options

旁注:人们经常做的是为 Windows 和 unix 创建启动脚本,允许您执行应用程序myapp而不是java -cp mylib.jar com.myorg.MyApp. 人们对 GraalVM 充满热情的原因之一是 GraalVM 原生镜像解决了这个打包问题,并允许 Java 开发人员将他们的应用程序作为单个可执行文件分发。

Picocli 的主要用例是便于在 Java 中创建命令行实用程序。所以很容易用这样的代码来做上面的事情:

package com.myorg;

@Command(name = "myapp")
public class MyApp implements Runnable {

    @Option(names = {"-u", "--username"}, description = "user name")
    private String userName;

    @Command // subcommand "sub"
    public void sub(@Option(names = "--subcommand-options") String option)  {
        System.out.printf("sub says hello %s!%n", userName);
    }

    @Override
    public void run() {
        System.out.printf("myapp says hi %s!%n", userName);
    }

    public static void main(String[] args) {
        int exitCode = new CommandLine(new MyApp()).execute(args);

    }
}

交互式命令行应用程序

当您使用 JLine 创建交互式 CLI shell 应用程序时,您需要记住在命令行上没有指定顶级命令。

因此,您希望用户能够在 shell 中键入的所有命令都应该是 subcommands,就像您在答案中描述的那样。

顶级命令仍然可以为用户提供帮助。一个想法是在用户输入无效命令(或者只是在没有参数的情况下按回车键)时打印一条友好的帮助消息,然后是顶级命令的使用帮助。

于 2019-06-07T07:25:15.603 回答