Picocli：如何在父命令和子命令之间共享选项

Question

如何支持所有（或部分）命令和子命令的共享选项？例如，如果最终用户在命令行参数的任何位置提供 --stacktrace，则打印的任何错误都将包括堆栈跟踪。

我们可以使用一个 Mixin 来定义一个布尔值 --stacktrace 选项，并将这个 Mixin 包含在所有（子）命令中，或者使用继承并让所有命令 subclass a class 定义了一个布尔值 --stacktrace 选项，但无论哪种方式，都会为每个命令定义一个单独的布尔值选项。哪个选项为真取决于用户在 args 中放置 --stacktrace 的位置，因此弄清楚是否提供了 --stacktrace 将意味着遍历所有父命令并查看是否有任何为真。

最好有一种更方便的方法来检测用户是否指定了这样的共享选项。

（另见 https://github.com/remkop/picocli/issues/580）

Answer 1

更新：使用 picocli 4.3 有两种方法可以完成此操作：

inherited options
让子命令使用delegates to the parent命令的mixin（因此选项修改的状态在一个地方）

实现此目的的一种方法是将布尔字段设置为静态：

class Shared {
    @Option(names = "--stacktrace")
    static boolean stacktrace;
}

您仍然需要子类化或使用 mixin 在每个命令和子命令中定义此选项：

@Command(subcommands = {Subcommand1.class, Subcommand2.class /*, ...*/}
class MyCommand {
    @Mixin
    Shared shared = new Shared();

    // ...
}

@Command(name = "subcommand1")
class Subcommand1 {
    @Mixin
    Shared shared = new Shared();

    // ...
}

这种设计的好处在于，现在应用程序可以在一个地方检测最终用户是否指定了 --stacktrace：静态布尔字段：

public static void main(String... args) {
    assert Shared.stacktrace == false;

    MyCommand myCommand = new MyCommand();
    CommandLine.parseArgs(myCommand, "subcommand1", "--stacktrace");

    assert Shared.stacktrace == true;
}

Picocli：如何在父命令和子命令之间共享选项

Picocli: how to share options between parent command and subcommands

shell

command-line

command

picocli