带有picocli的可扩展应用程序。最佳做法问题

时间:2018-11-07 11:34:57

标签: java command-line-interface picocli

说我的项目有很多逻辑,并且有几个入口点,它们是CLI命令。

我用@Command注释入口点,初始化@Parameters@Option注释的字段并执行逻辑,这不再需要CLI。

如我所见,每个main带注释的类都声明1个@Command方法是合适的,但是,我不确定这是否是一个好主意。

也许某种CommandFactory是必要的吗?

我以前从未构建过CLI应用程序,也从未使用过picocli,因此,如果我的想法错误,请指出。

1 个答案:

答案 0 :(得分:0)

对于每个作为入口点的main,都有一个单独的@Command方法是很好的。需要main方法,以便可以从命令行独立调用该命令。

例如:

@Command(name = "hello")
class Hello implements Runnable {
    public static void main(String[] args) {
        CommandLine.run(new Hello(), args);
    }
    public void run() { System.out.println("hello"); }
}

@Command(name = "bye")
class Bye implements Runnable {
    public static void main(String[] args) {
        CommandLine.run(new Bye(), args);
    }
    public void run() { System.out.println("bye"); }
}

一个例外是当您的应用程序带有带有subcommands的命令时。在这种情况下,您只需要对顶级命令使用main方法,而对子命令则不需要。

带有子命令的示例:

@Command(name = "git", subcommands = {Commit.class, Status.class})
class Git implements Runnable {
    public static void main(String[] args) { // top-level command needs main
        CommandLine.run(new Git(), args);
    }
    public void run() { System.out.println("Specify a subcommand"); }
}

@Command(name = "commit")
class Commit implements Runnable {
    @Option(names = "-m") String message;
    @Parameters File[] files;

    public void run() {
        System.out.printf("Committing %s with message '%s'%n",
                Arrays.toString(files), message);
    }
}

@Command(name = "status")
class Status implements Runnable {
    public void run() { System.out.println("All ok."); }
}

请注意,在有子命令时,只有顶层命令才需要main方法。 即使使用子命令,也不需要工厂。