将基于picocli的CLI使用情况输出解析为结构化数据

问题描述

我有一组基于picocli的应用程序，我想将使用情况输出解析为结构化数据。到目前为止，我已经编写了三个不同的输出解析器，但我对它们中的任何一个都不满意（脆弱性，复杂性，扩展难度等）。关于如何干净地解析此类半结构化输出的任何想法？

使用情况输出通常如下所示：

Usage: taker-mvo-2 [-hV] [-C=file] [-E=file] [-p=payoffs] [-s=millis] PENALTY
                    (ASSET SPREAD)...
Submits liquidity-taking orders based on mean-variance optimization of multiple
assets.
      PENALTY             risk penalty for payoff variance
      (ASSET SPREAD)...   Spread for creating market above fundamental value
                            for assets
  -C,--credential=file   credential file
  -E,--endpoint=file     marketplace endpoint file
  -h,--help              display this help message
  -p,--payoffs=payoffs   payoff states and probabilities (default: .fm/payoffs)
  -s,--sleep=millis      sleep milliseconds before acting (default: 2000)
  -V,--version           print product version and exit

我想将程序名称和描述，选项，参数和参数组及其描述捕获到agent中：

public class Agent {
    private String name;
    private String description = "";
    private List<Option> options;
    private List<Parameter> parameters;
    private List<ParameterGroup> parameterGroups;
}

程序名称为taker-mvo-2，（可能是多行的）描述在（可能是多行的）参数列表之后：

Submits liquidity-taking orders based on mean-variance optimization of multiple assets.

选项（在方括号中）应解析为：

public class Option {
    private String shortName;
    private String parameter;
    private String longName;
    private String description;

}

解析的选项的JSON是：

options: [ {
  "shortName": "h","parameter": null,"longName": "help","description": "display this help message"
},{
  "shortName": "V","longName": "version","description": "print product version and exit"
},{
  "shortName": "C","parameter": file,"longName": "credential","description": "credential file"
},{
  "shortName": "E","longName": "endpoint","description": "marketplace endpoint file"
},{
  "shortName": "p","parameter": payoffs,"longName": "payoffs","description": "payoff states and probabilities (default: ~/.fm/payoffs)"
}]

类似地，对于应解析为的参数：

public class Parameter {
    private String name;
    private String description;

}

和由(和)...包围的参数组应解析为：

public class ParameterGroup {
    private List<String> parameters;
    private String description;

}

我编写的第一个手写解析器遍历缓冲区，并在处理过程中捕获数据。它工作得很好，但是看起来很可怕。而且扩展是可怕的。第二个手写解析器在遍历缓冲区时使用正则表达式。比第一个看起来更好，但仍然很难看并且很难扩展。第三个解析器使用正则表达式。可能是一堆看上去最好的，但仍然丑陋且难以管理。

我认为手动编写文本非常简单，但是现在我想知道ANTLR是否可能是一个更好的工具。有什么想法或替代想法吗？

解决方法

模型

听起来您需要的是模型。一个对象模型，描述命令，命令选项，选项参数类型，选项描述，选项名称，以及位置参数，参数组和可能的子命令的类似名称。

然后，一旦有了应用程序的对象模型，将其呈现为JSON或其他某种格式相对简单。

Picocli具有对象模型

您可以自己构建它，但是如果您仍在使用picocli，为什么不利用picocli的优势并使用picocli的内置模型呢？

• CommandSpec
• OptionSpec
• PositionalParamSpec
• ArgGroupSpec
• 还有更多...

访问picocli的对象模型

1. 命令可以访问自己的模型

在基于picocli的应用程序中，带有@Command注释的类可以通过声明带有@Spec注释的字段来访问其自己的picocli对象模型。 Picocli会将CommandSpec注入该字段。

例如：

@Command(name = "taker-mvo-2",mixinStandardHelpOptions = true,version = "taker-mvo-2 0.2")
class TakerMvo2 implements Runnable {
    // ...

    @Option(names = {"-C","--credential"},description = "credential file")
    File file;

    @Spec CommandSpec spec; // injected by picocli

    public void run() {
        for (OptionSpec option : spec.options()) {
            System.out.printf("%s=%s%n",option.longestName(),option.getValue());
        }
    }
}

picocli用户手册中有更详细的example that uses the CommandSpec，用于遍历命令中的所有选项，以查看该选项是否为默认选项或是否在命令行上指定了值。

1. 创建任何picocli命令的模型

访问picocli对象模型的另一种方法是使用带有CommandLine注释的类（或该类的对象）构造一个@Command实例。您可以在picocli应用程序之外执行此操作。

例如：

class Agent {
    public static void main(String... args) {
        CommandLine cmd = new CommandLine(new TakerMvo2());
        CommandSpec spec = cmd.getCommandSpec();
        
        // get subcommands
        Map<String,CommandLine> subCmds = spec.subcommands();
        
        // get options as a list
        List<OptionSpec> options = spec.options()

        // get argument groups
        List<ArgGroupSpec> argGroups = spec.argGroups()

        ...
    }
}