时间戳

首页 > 解决方案 > 使用 picocli 的可扩展应用程序。最佳实践问题

java - 使用 picocli 的可扩展应用程序。最佳实践问题

问题描述

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

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

在我看来，为main每个带注释的类声明 1 个方法适合我@Command，但是，我不确定这是否是个好主意。

也许某种CommandFactory是必要的？

我以前从未构建过 CLI 应用程序或使用过 picocli，所以如果我的思考过程是错误的，请指出这一点。

标签： javacommand-line-interfacepicocli

解决方案

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"); }
}

一个例外是当您的应用程序具有带有子命令的命令时。在这种情况下，您只需要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请注意，当有子命令时，只有顶级命令需要方法。即使使用子命令，也不需要工厂。

推荐阅读