学习记录 - Java程序执行Cmd指令所遇问题记录

这篇是有关在编写Java程序执行Cmd指令时所遇到的问题记录，其中有一些是个人的理解，如有问题望不吝赐教，感谢❤

Windows 命令提示符（cmd.exe）是 Windows NT 下的一个用于运行 Windows 控制面板程序或某些 DOS 程序的shell程序

1.执行Cmd命令的两种方式

（1）RunTime.getRunTime().exec(多种重载方式) - 会得到一个Process对象通过其start()方法开启一个新进程以执行输入的指令。

这种方法就不多说了，最后这种形式还是用到第二种方式的方法（Java Api文档中也推荐使用第二种方式去创建一个Process对象）：

* @see ProcessBuilder
* @since 1.3
*/
public Process exec(String[] cmdarray, String[] envp, File dir)
throws IOException {
return new ProcessBuilder(cmdarray)
.environment(envp)
.directory(dir)
.start();
}

(2).new ProcessBuilder().command(指令)

2.获取执行指令后的输出：

在这里就遇到点问题，

上面两种方式执行Windows自带的命令都没有什么问题（像Ping、Ipconfig）。但是当执行像“Java -version”这样的外部命令，其输出通过getInputStream（）方法是拿不到的。

后来是通过参考网上资料，采用将子进程的输出重定向到文件中，再从文件中读取内容的方法：

// 外部程序的输出放到了错误信息输出流中，不将错误信息流输出到文件话，输出信息就看不到了😂
            pb.redirectErrorStream(true);
            // 把执行结果输出
            pb.redirectOutput(file);
            //等待语句执行完成，否则可能会读不到结果。
            pb.start().waitFor();
            InputStream in = new FileInputStream(file);
            br = new BufferedReader(new InputStreamReader(in,charsetName));
            String line = null;
            while ((line = br.readLine()) != null) {
                outPutResult.append(line).append("\n");
            }
            br.close();
            br = null;
            // 删除临时文件
            file.delete();

最新解决方法：刚写完这篇博客，就在想Java开发文档中这句“否则，如果使用ProcessBuilder.redirectErrorStream重定向子进程的标准错误，则此方法返回的输入流将接收合并的标准输出和子进程的标准错误。”（下面图片）怎么就没用呢，结果回头一看，文档是Java 8的，我跑的程序用的是Java 7的，把自己整笑了🙃，还在这一通瞎操作。
而至于为什么要将子进程标准输出和子进程的标准错误输出合并，可以看下小弟下面的拙见。

对于非Windows自带命令，可以这样写（不再需要借助文件）：

public static StringBuilder runOutCmdTest(String command) {
        BufferedReader br = null;
        StringBuilder outPutResult = new StringBuilder();
        try{
        ProcessBuilder pb = new ProcessBuilder().command("cmd.exe", "/c", command);
        // 外部程序的输出放到了错误信息输出流中
        pb.redirectErrorStream(true);
        // 等待语句执行完成，否则可能会读不到结果。
        Process process = pb.start();
        process.waitFor();
        InputStream inputStream = process.getInputStream();
        br = new BufferedReader(new InputStreamReader(inputStream, "GBK"));
        String line;
        while ((line = br.readLine()) != null) {
            outPutResult.append(line).append("\n");
        }
        br.close();
        br = null;
        } catch (Exception e) {
            e.printStackTrace();
        }
        return outPutResult;
    }

3.关于getInputStream （）无法得到子进程输出的原因

此方法获取的流是子进程正常输出流不包括异常错误信息流，Process对象将异常信息放在了ErrorStream中。这里可以试一下，会发现执行“Java -version”控制台输出的是红字，也就是异常信息。

emmm至于为什么非Windows自带命令的正常输出会被视作异常信息，不太清楚，下次再looklook源码。

4.一个调用指令例子

   private static final String TEMP_FILE_PATH = "D:\\temp.txt";

    /**
     * 运行外部程序命令 无参数时调用
     * @param command 输入命令
     * @return 输出内容
     */
    public static StringBuilder runOutCmd(String command) {
        // 默认字符解析GBK
        return runOutCmd(command, null,"GBK");
    }

    /**
     * 运行外部程序命令 带参数
     * @param command 输入命令
     * @param args 输入参数
     * @return
     */
    public static StringBuilder runOutCmd(String command, List<String> args) {
        // 默认字符解析GBK
        return runOutCmd(command, args,"GBK");
    }

    /**
     * 运行外部程序命令 - 带参数并规定字符解析格式
     * @param args 输入参数
     * @param command 输入命令
     * @param charsetName 输出字符解析格式
     * @return
     */
    public static StringBuilder runOutCmd(String command, List<String> args, String charsetName) {
        BufferedReader br = null;
        StringBuilder outPutResult = new StringBuilder();
        try {
            // 新建一个用来存储子进程输出结果结果的缓存文件
            File file = new File(TEMP_FILE_PATH);
            if (!file.getParentFile().exists()) {
                file.getParentFile().mkdirs();
            }
            if (!file.exists()) {
                file.createNewFile();
            }
            List<String> execCommand = new LinkedList<>();
            if (args != null) {
                execCommand.addAll(args);
            }
            execCommand.add(0,command);
            execCommand.add(0,"/c");
            execCommand.add(0,"cmd.exe");
            ProcessBuilder pb = new ProcessBuilder().command(execCommand).inheritIO();
            // 外部程序的输出放到了错误信息输出流中
            pb.redirectErrorStream(true);
            // 把执行结果输出
            pb.redirectOutput(file);
            //等待语句执行完成，否则可能会读不到结果。
            pb.start().waitFor();
            InputStream in = new FileInputStream(file);
            br = new BufferedReader(new InputStreamReader(in,charsetName));
            String line = null;
            while ((line = br.readLine()) != null) {
                outPutResult.append(line).append("\n");
            }
            br.close();
            br = null;
            // 删除临时文件
            file.delete();
        } catch (Exception e) {
            e.printStackTrace();
        } finally {
            if (br != null) {
                try {
                    br.close();
                } catch (IOException e) {
                    e.printStackTrace();
                }
            }
        }
        return outPutResult;
    }

最新例子（不用借助文件）：

/**
 * 运行外部程序命令 - 带参数并规定字符解析格式
 *
 * @param args        输入参数
 * @param command     输入命令
 * @param charsetName 输出字符解析格式
 * @return
 */
public static StringBuilder runOutCmd(String command, List<String> args, String charsetName) {
    BufferedReader br = null;
    StringBuilder outPutResult = new StringBuilder();
    try {
        List<String> execCommand = new LinkedList<>();
        if (args != null) {
            execCommand.addAll(args);
        }
        execCommand.add(0, command);
        execCommand.add(0, "/c");
        execCommand.add(0, "cmd.exe");
        ProcessBuilder pb = new ProcessBuilder().command(execCommand).inheritIO();
        // 外部程序的输出放到了错误信息输出流中
        pb.redirectErrorStream(true);
        //等待语句执行完成，否则可能会读不到结果。
        Process process = pb.start();
        process.waitFor();
        InputStream inputStream = process.getInputStream();
        br = new BufferedReader(new InputStreamReader(inputStream, charsetName));
        String line;
        while ((line = br.readLine()) != null) {
            outPutResult.append(line).append("\n");
        }
        br.close();
        br = null;
    } catch (Exception e) {
        e.printStackTrace();
    } finally {
        if (br != null) {
            try {
                br.close();
            } catch (IOException e) {
                e.printStackTrace();
            }
        }
    }
    return outPutResult;
}

ps:
1. inheritIO()作用：

意味着使用此方法，子进程的报错的异常信息也会在当前Java进程的控制台输出，而Process对象将非Windows命令的输出视为异常信息，那么非Windows命令的输出当使用了此方法的时候会在控制台输出。

2.字符解析格式问题:
输出出现乱码，与Cmd程序字符格式默认为GBK有关。
按实际情况修改流的解析格式就可以了：

 br = new BufferedReader(new InputStreamReader(in,charsetName));