在设计程序的时候偶尔会需要依靠系统指令或是其它的程序来取得一些相关的消息,或是进行一些特殊的处理,如查看系统的网卡界面,或是调用 FFmpeg 来实现影音编码的格式转换。虽然这些工作基本上都可以靠 Java 原生程序或是 JNI 来自行实作,但既然有已存在的指令和可执行文件可以用,能省下许多开发时间,何不去用呢?
使用 Java 去运行系统指令或是其它可可执行文件案,可以用 Runtime.getRuntime().exec 或是 ProcessBuilder,两种方式运行指令后的结果均相同。Runtime 类别对象所提供的 exec 方法可对传入的参数指令使用 StringTokenizer 将指令字符串切割成数组后,再使用 ProcessBuilder 创建出 Process,算是 ProcessBuilder 的外壳。以下是 JDK 内 exec 方法的部分实作程序:
public Process exec(String command, String[] envp, File dir)
throws IOException {
if (command.length() == 0)
throw new IllegalArgumentException("Empty command");
StringTokenizer st = new StringTokenizer(command);
String[] cmdarray = new String[st.countTokens()];
for (int i = 0; st.hasMoreTokens(); i++)
cmdarray[i] = st.nextToken();
return exec(cmdarray, envp, dir);
}
public Process exec(String[] cmdarray, String[] envp, File dir)
throws IOException {
return new ProcessBuilder(cmdarray)
.environment(envp)
.directory(dir)
.start();
}
从上面程序可以知道,使用 Runtime.getRuntime().exec 来运行系统指令或是其它可可执行文件案,会比直接使用 ProcessBuilder 还要方便。然而,如果是要一直重复运行同样的指令的话,自行实体化出 ProcessBuilder 来重复产生 Process 对象会比较有效率。
如果要运行 ping 8.8.8.8 这个指令,可写成如下程序:
Process process = Runtime.getRuntime().exec("ping 8.8.8.8");
或是
ProcessBuilder processBuilder = new ProcessBuilder("ping", "8.8.8.8");
Process process = processBuilder.start();
如果要知道 Process 运行过程所吐出来的消息与结果回传值,可以使用 Process 对象的 getInputStream 搭配 Process 对象的 waitFor 方法。如果要提供数据给 Process 所运行的指令,可以使用 Process 对象的 getOutputStream。这里有个观念要注意的是,Process 对象所运行的指令,其输出数据对于 Process 对象来说是输入(将指令输出的数据传入至 Java 程序中),因此是 InputStream;而 Process 对象所运行的指令,其输入数据对于 Process 对象来说是输出(用 Java 程序输出数据供指令使用),因此是 OutputStream。
取得运行过程与回传结果的程序如下:
BufferedReader reader = new BufferedReader(new InputStreamReader(process.getInputStream()));
String line;
while ((line = reader.readLine()) != null) {
System.out.println(line);
}
int returnValue = process.waitFor();
System.out.println(String.format("Return: %d", returnValue));
使用 Process 的 waitFor() 方法,可以将目前的线程暂时停止,等待 Process 结束运行后才会继续再运行之后的程序。若有使用 waitFor(),而没有去读取 Process 的 InputStream,可能会造成 Process 暂停的情形。
如果需要提供数据给 Process 所运行的指令,可以写成如下程序:
BufferedWriter writer = new BufferedWriter(new OutputStreamWriter(process.getOutputStream()));
writer.write(inputString);
writer.flush();
通常我们提供的数据是一行一行输入进去的,此时就要丢换行字符 \n 进去,分隔每一行的数据。程序如下:
writer.write(line1);
writer.write("\n");
writer.write(line2);
writer.write("\n");
...
上面是使用 Java 原生提供的类别来调用系统指令和外部可执行文件案,实作起来较为繁琐,以下提供一个更快的作法。
MagicCommand
MagicCommand 套件可以用来快速地运行系统指令或是其它可可执行文件案,并提供 CallBack 方法回传指令的运行状况。
取得 MagicCommand
GitHub:
创建 Command 对象
使用 MagicCommand 套件,必须实体化出 Command 对象,并在构造器内传入要运行的指令参数。
final String commandString = "ping 8.8.8.8";
final Command command = new Command(commandString); //实体化出Command对象
设置 CommandListener
为了得知指令的运行状况,需要设置一个 CommandListener 对象给 Command 对象,并实作出 CommandListener 界面所定义的以下几种方法:
- commandStart(String id):指令运行时会调用这个方法。
- commandRunning(String id, String message, boolean isError):运行指令中,每输出一行消息,就会调用这个方法。
- commandException(String id, Exception exception):运行指令时若出现例外,会调用这个方法。
- commandEnd(String id, int returnValue):指令运行结束后,会调用这个方法。
程序如下:
command.setCommandListener(new CommandListener() {
@Override
public void commandStart(final String id) {
}
@Override
public void commandRunning(final String id, final String message, final boolean isError) {
System.out.println(message);
}
@Override
public void commandException(final String id, final Exception exception) {
exception.printStackTrace(System.out);
}
@Override
public void commandEnd(final String id, final int returnValue) {
}
});
运行指令
Command 对象提供 run 或 runAsync 方法来运行指令,一个 Command 对象可以重复调用多次的 run 或 runAsync 方法来运行相同的指令。正常情况下,每调用一次都会产生一个命令进程,可用 Command 对象的 toString 方法来查看目前 Command 对象正在进行的命令进程有哪些,每个命令进程都会在该 Command 对象下有个独立的进程 ID 字符串,以利辨识。进程 ID 建议由设计师自行指定并维护,可在调用 run 或 runAsync 方法时传入进程 ID。run 和 runAsync 方法的差别在于:前者会在同一线程下运行指令,后者会在新的线程下运行指令。
例如,创建出一个 ID 为 first 的命令进程,并在新的线程上运行,程序如下:
command.runAsync("first");
提供数据给指定 ID 的命令进程
有些指令运行的时候可能会需要让用户填入数据进去,可以使用 Command 对象提供的 inputStringToRunningProcess 方法。
输入 exit 字符串与换行字符给 ID 为 first 的命令进程,程序如下:
command.inputStringToRunningProcess("first", "exit\n"); // 注意那个「\n」
停止命令进程
停止 ID 为 first 的命令进程。
command.stop("first");
停止 Command 对象下所有的命令进程。
command.stopAll();
可能会遇到的编码问题
不同系统、不同语系、不同的指令与程序,可能会使用不同的编码方式来输入和输出文字。像是在繁体中文的 Windows 下,预设的文字编码方式是「Big5」,如果直接使用预设的方式来创建 Command 对象,可能会遇到文字乱码的问题。
如要指定编码方式,可以在 Command 的构造器上传入正确的 Charset 对象。如下图,成功解决中文乱码的问题:


