01_命令行工具

命令行工具

Java虚拟机启动时，需要指定类启动应用程序。

但是Java虚拟机规范中并没有明确规定，怎么指定类启动应用程序，也就是主类（包含main方法的类）。

Oracle的虚拟机实现是通过 java 命令来启动的，主类名由命令函参数指定。

java [-options] class [args]
java [-options] -jar jarfile [args]
javaw [-options] class [args]
javaw [-options] -jar jarfile [args]

• class：主类名

• jarfile：jar包文件名

• args：main() 方法参数

• 标准选项比较稳定，不会轻易变动

• 非标准选项以 -X 开头，很有可能在未来版本中发生变更

• 非标准选项中的高级选项，以 -XX 开头

一、编写命令行工具

目前主要添加几个命令参数：

• -help
• -version
• -classpath

另外，启动程序主类名也是参数之一，并且必须放在所有参数中的第一位。

private boolean helpFlag = false;
private boolean versionFlag = false;
private String cpOption = null;
private String mainClass = null;

命令行参数的生成和解析，采用了 Apache 的一个 commons-cli 命令行工具包。

完整代码如下：

public class Cmd {

    private final static Options options;

    static {
        options = new Options();
        options.addOption(new Option("help", false, "print help message"));
        options.addOption(new Option("?", false, "print help message"));
        options.addOption(new Option("version", false, "print version and exit"));
        options.addOption(Option.builder("classpath")
                .hasArg().desc("classpath")
                .type(String.class)
                .build());
        options.addOption(Option.builder("cp")
                .hasArg().desc("classpath")
                .type(String.class)
                .build());
    }

    private boolean helpFlag = false;
    private boolean versionFlag = false;
    private String cpOption = null;
    private String mainClass = null;
    private String[] args = null;

    /**
     * 解析命令行参数
     * @param args 命令行参数
     */
    public void parse(String[] args) {
        try {
            // 解析命令行参数
            CommandLineParser parser = new DefaultParser();
            CommandLine line = parser.parse(options, args);
            this.args = Arrays.copyOfRange(args, 1, args.length);

            // 打印帮助信息
            if (line.hasOption("help") || line.hasOption("?")) {
                helpFlag = true;
                printHelp();
            }

            // 版本信息
            if (line.hasOption("version")) {
                versionFlag = true;
                System.out.println("version 0.0.1");
            }

            // 启动程序主类名
            if (args.length > 0) {
                mainClass = args[0];
            }

            // classpath路径
            if (line.hasOption("classpath")) {
                cpOption = line.getOptionValue("classpath");
            } else if (line.hasOption("cp")) {
                cpOption = line.getOptionValue("cp");
            }

            // 打印所有参数
            System.out.println("helpFlag = " + helpFlag);
            System.out.println("versionFlag = " + versionFlag);
            System.out.println("mainClass = " + mainClass);
            System.out.println("classpath = " + cpOption);
        } catch (ParseException e) {
            e.printStackTrace();
        }
    }

    /**
     * 打印命令行帮助信息
     */
    public void printHelp() {
        HelpFormatter formatter = new HelpFormatter();
        formatter.printHelp("self-jvm", options);
    }
}

二、添加测试类

测试类代码如下：

public class CmdTest {

    @Test
    public void parse() {
        String[] args = new String[]{ "com.wjd.cmd.Cmd", "-classpath", "/projects" };
        Cmd cmd = new Cmd();
        cmd.parse(args);
    }

    @Test
    public void printHelp() {
        Cmd cmd = new Cmd();
        cmd.printHelp();
    }
}

测试的打印结果大概是这样子的：

# parse
helpFlag = false
versionFlag = false
mainClass = com.wjd.cmd.Cmd
classpath = /projects

# printHelp
usage: self-jvm
 -?                 print help message
 -classpath <arg>   classpath
 -cp <arg>          classpath
 -help              print help message
 -version           print version and exit