如何使用Apache Commons CLI来解析属性文件和--help选项?

时间:2014-12-23 05:29:54

标签: java properties command-line-arguments apache-commons-cli

我有一个属性文件,就像这样 -

hostName=machineA.domain.host.com
emailFrom=tester@host.com
emailTo=world@host.com
emailCc=hello@host.com

现在我正在从我的Java程序中读取上面的属性文件,如下所示。我现在正在解析上面的属性文件手册 -

public class FileReaderTask {
    private static String hostName;
    private static String emailFrom;
    private static String emailTo;
    private static String emailCc;

    private static final String configFileName = "config.properties";
    private static final Properties prop = new Properties();

    public static void main(String[] args) {
        readConfig(arguments);

        // use the above variables here
        System.out.println(hostName);
        System.out.println(emailFrom);
        System.out.println(emailTo);
        System.out.println(emailCc);
    }

    private static void readConfig(String[] args) throws FileNotFoundException, IOException {
        if (!TestUtils.isEmpty(args) && args.length != 0) {
            prop.load(new FileInputStream(args[0]));
        } else {
            prop.load(FileReaderTask.class.getClassLoader().getResourceAsStream(configFileName));
        }

        StringBuilder sb = new StringBuilder();
        for (String arg : args) {
            sb.append(arg).append("\n");
        }
        String commandlineProperties = sb.toString();

        if (!commandlineProperties.isEmpty()) {
            // read, and overwrite, properties from the commandline...
            prop.load(new StringReader(commandlineProperties));
        }           

        hostName = prop.getProperty("hostName").trim();
        emailFrom = prop.getProperty("emailFrom").trim();
        emailTo = prop.getProperty("emailTo").trim();
        emailCc = prop.getProperty("emailCc").trim();
    }
}

大多数时候,我将通过命令行运行我的上述程序作为这样的可运行的jar -

java -jar abc.jar config.properties
java -jar abc.jar config.properties hostName=machineB.domain.host.com

我的问题是 -

  • 有没有办法在运行--help时添加abc.jar选项,它可以告诉我们更多关于如何运行jar文件以及每个属性的含义以及如何使用它们的方法?我在运行大部分C ++可执行文件或Unix时看到--help所以不确定我们如何在Java中做同样的事情?

我是否需要在Java中使用Commons CLI之类的CommandLine解析器实现此目的,而不是进行手动解析,我应该使用Commons CLI来解析文件?如果是,那么任何人都可以提供一个例子,我将如何在我的场景中做到这一点?

1 个答案:

答案 0 :(得分:2)

从长远来看,如果你计划在未来添加其他选项,那么commons-cli肯定是一个相当不错的选择,因为它可以很容易地添加新选项,手动解析很快变得复杂。

看一下official examples,它们可以很好地概述图书馆的功能。

您的具体案例可能会导致以下情况:

    // create Options object
    Options options = new Options();

    Option help = new Option( "h", "help", false, "print this message" );
    options.addOption(help);

    CommandLineParser parser = new PosixParser();
    CommandLine cmd = parser.parse( options, args);

    if(cmd.hasOption("help") || cmd.getArgList().isEmpty()) {
        // automatically generate the help statement
        HelpFormatter formatter = new HelpFormatter();
        formatter.printHelp( "cli-test [options] <property-file>", options );

        return;
    }

    // do your thing...
    System.out.println("Had properties " + cmd.getArgList());