记一次Java错误解析用户终端命令

背景描述

Java执行终端命令是另起一个子进程：

Runtime.getRuntime().exec(cmd);

用户可能需要执行脚本，出于对不必要的可执行权限问题的考虑，可在用户命令之前加上"sh -c"，为了获取完整日志，可在用户命令后加上"2>&1"：

Runtime.getRuntime().exec("sh -c " + cmd + " 2>&1");

这段代码在实际运行时是存在问题的，假设上述cmd对象的值为"rm -fr dirctory"，子进程执行的命令应当为"sh -c rm -fr directory 2>&1"：

sh -c rm -fr directory 2>&1
>>rm: missing operand
>>Try 'rm --help' for more information.

由结果可知，-fr和directory都丢失掉了。

排查思路

查看"man sh"可知：

-c string .If  the  -c option is present, then commands are read from string.
If there are arguments after the string, they are assigned to the positional parameters, starting with $0.

提示的用法中注意string有且仅有一个，而在上文中的命令是"sh -c rm -fr directory 2>&1"，相应的string即rm，而实际上后续的参数被忽略了，因此出现"-fr directory"丢失的情况。

检查Runtime#exec(String)发现，该方法将入参字符串以" \t\n\r\f"切分（见StringTokenizer）成一个命令数组，因此，如果入参为"sh -c rm -fr directory 2>&1"，将被拆分成{“sh”, “-c”, “rm”, “-fr”, “directory”, “2>&1”}：

    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);
    }

进一步向下检查Process#exec(String command, String[], File)的重载方法exec(String[], String[], File)，一直跟进到ProcessImpl#ProcessImpl的私有构造方法，其中cmd即上述代码传入的cmdarray，createCommandLine方法（做一些转义）将生成最终执行的命令行：“sh -c rm -fr directory 2>&1”。

            cmdstr = createCommandLine(
                //legacy mode doesn't worry about extended verification
                VERIFICATION_LEGACY,
                executablePath,
                cmd);

    private static String createCommandLine(int verificationType,
                                     final String executablePath,
                                     final String cmd[])
    {
        StringBuilder cmdbuf = new StringBuilder(80);
        cmdbuf.append(executablePath);
        for (int i = 1; i < cmd.length; ++i) {
            cmdbuf.append(' ');
            String s = cmd[i];
            // needsEscaping方法在传入的数组元素中**含有空格、制表符等**且**没有被该元素没有被"\""闭合时**返回true
            if (needsEscaping(verificationType, s)) {
                cmdbuf.append('"').append(s);
                if ((verificationType != VERIFICATION_CMD_BAT) && s.endsWith("\\")) {
                    cmdbuf.append('\\');
                }
                cmdbuf.append('"');
            } else {
                cmdbuf.append(s);
            }
        }
        return cmdbuf.toString();
    }

通过上述man sh得知，此时生成的命令行对于"sh -c"而言仅能识别到"rm"，后续的参数丢失了，"2>&1"也未能生效。

解决方法

既然Runtime#exec(String)会将入参字符串拆分成数组，并调用Process#exec(String[], String[], File)，那如果我们能够直接传入数组，由RumtimeImpl#createCommandeLine将用户命令用"\""闭合，那么就能拼接出正确的命令。同时为了保证"2>&1"能和用户命令一起闭合，需要事先将它们拼接起来：

String cmd = "rm -fr \"abc\"";
String[] cmdArray = {"sh", "-c", cmd + " 2>&1"};
Process p = Runtime.getRuntime().exec(cmdArray);
// 通过RumtimeImpl#createCommandeLine生成的命令为sh -c "rm -fr "abc" 2>&1"

也可主动通过"\""闭合用户命令的方法实现：

String cmd = "rm -fr \"abc\"";
Runtime.getRuntime().exec("sh -c " + "\"" + cmd + " 2>&1" + "\"");
// 实际生成的命令为sh -c "rm -fr "abc" 2>&1"

如果是在Windows下执行，可将上述"sh -c"替换为"cmd /c"。

总结

没事别重构。