本文探討了在Java應用中通過Runtime.exec(String)執(zhí)行SQL*Plus命令時，輸出與預期不符的問題。主要原因在於Runtime.exec(String)對包含複雜參數(shù)（如空格和引號）的命令字符串解析不當。文章提供了兩種解決方案：使用Runtime.exec(String[])將命令參數(shù)作為數(shù)組傳遞，以及更推薦的ProcessBuilder類，後者提供了更精細的進程控制和標準流管理，確保命令正確執(zhí)行並捕獲預期輸出。

問題描述

在Java應用程序中，開發(fā)者可能需要通過外部進程執(zhí)行系統(tǒng)命令，例如調(diào)用Oracle SQL Plus來執(zhí)行SQL或PL/SQL腳本。然而，當使用Runtime.getRuntime().exec(String cmd)方法執(zhí)行包含複雜參數(shù)（特別是帶有空格和引號的連接字符串）的SQL Plus命令時，觀察到的輸出可能並非預期的腳本執(zhí)行結(jié)果，而是SQL*Plus的幫助信息或用法說明。

例如，直接在操作系統(tǒng)命令行中執(zhí)行如下SQL*Plus命令可以正常獲取到PL/SQL執(zhí)行的錯誤信息：

 sqlplus -s -LOGON <user_name>/<password>@"(DESCRIPTION=(ADDRESS=(PROTOCOL=TCP)(Host= host1.com)(Port=1725))(ADDRESS=(PROTOCOL=TCP)(Host= host2.com)(Port=1725))(LOAD_BALANCE = ON)(FAILOVER = ON) (CONNECT_DATA = (SERVER = DEDICATED)(SERVICE_NAME=service.com)))" @Load.sql</password></user_name>

預期輸出（例如PL/SQL錯誤）：

 BEGIN
*
ERROR at line 1:
ORA-20004: Data is not ready, please check control-M v8 jobs
ORA-06512: at "GLOBAL_OWNER.PKG_COMMON_UTILS", line 282
ORA-06512: at line 2

然而，當相同的命令字符串在Java中使用Runtime.getRuntime().exec(String cmd)執(zhí)行時，輸出卻變成了SQL*Plus的用法說明：

 SQL*Plus: Release 12.1.0.2.0 Production
...
Use SQL*Plus to execute SQL, PL/SQL and SQL*Plus statements.
Usage 1: sqlplus -H | -V
...

根本原因分析

這種差異的根本原因在於Runtime.getRuntime().exec(String cmd)方法與操作系統(tǒng)shell解析命令的方式不同。

1. Runtime.exec(String cmd)的限制：當傳入單個字符串作為命令時，Runtime.exec(String)不會像shell那樣智能地解析引號和空格。它會嘗試將整個字符串作為一個整體來執(zhí)行，或者簡單地根據(jù)空格進行分割，但不會正確處理引號內(nèi)的內(nèi)容為一個參數(shù)。這意味著，複雜的連接字符串（如"(DESCRIPTION=...)"）在被傳遞給sqlplus時，可能被錯誤地分割或解釋，導致sqlplus命令無法識別正確的參數(shù)，從而回退到顯示其用法說明。

2. Shell的智能解析：相反，當在命令行中直接執(zhí)行時，shell（如Bash、CMD等）會負責解析命令字符串。它能夠識別引號，並將引號內(nèi)的內(nèi)容作為一個整體的參數(shù)傳遞給目標程序（sqlplus）。

解決方案

為了解決這個問題，我們需要確保Java將命令參數(shù)以與shell相同的方式傳遞給外部程序。這可以通過兩種主要方式實現(xiàn)：

方案一：使用Runtime.exec(String[] cmdarray)

此方法允許您將命令及其所有參數(shù)作為字符串數(shù)組的單獨元素傳遞。這樣，Java就不會嘗試自行解析整個命令字符串，而是將每個數(shù)組元素作為一個獨立的參數(shù)傳遞給外部進程。

示例代碼：

 import java.io.IOException;
import java.io.BufferedReader;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.util.concurrent.Executors;
import java.util.concurrent.Future;
import java.util.concurrent.ExecutionException;
import java.util.function.Consumer;

public class RunSqlPlusCorrected {

    public static void main(String[] args) {
        try {
            // 將命令及其參數(shù)分解為字符串數(shù)組的每個元素String[] cmdArray = new String[] {
                "sqlplus",
                "-s",
                "-LOGON",
                "<user_name>/<password>@\"(DESCRIPTION=(ADDRESS=(PROTOCOL=TCP)(Host= host1.com)(Port=1725))(ADDRESS=(PROTOCOL=TCP)(Host= host2.com)(Port=1725))(LOAD_BALANCE = ON)(FAILOVER = ON) (CONNECT_DATA = (SERVER = DEDICATED)(SERVICE_NAME=service.com)))\"",
                "@Load.sql"
            };

            Process process = Runtime.getRuntime().exec(cmdArray);

            // 使用StreamGobbler處理標準輸出和標準錯誤流StreamGobbler outputGobbler =
                    new StreamGobbler(process.getInputStream(), System.out::println);
            StreamGobbler errorGobbler =
                    new StreamGobbler(process.getErrorStream(), System.err::println);

            Future> outputFuture = Executors.newSingleThreadExecutor().submit(outputGobbler);
            Future> errorFuture = Executors.newSingleThreadExecutor().submit(errorGobbler);

            int exitCode = process.waitFor();
            System.out.println("Exited with code: " exitCode);

            outputFuture.get(); // 等待輸出流處理完成errorFuture.get(); // 等待錯誤流處理完成} catch (IOException | InterruptedException | ExecutionException e) {
            e.printStackTrace();
        }
    }

    // StreamGobbler 輔助類，用於異步讀取進程輸出流private static class StreamGobbler implements Runnable {
        private InputStream inputStream;
        private Consumer<string> consumer;

        public StreamGobbler(InputStream inputStream, Consumer<string> consumer) {
            this.inputStream = inputStream;
            this.consumer = consumer;
        }

        @Override
        public void run() {
            try (BufferedReader reader = new BufferedReader(new InputStreamReader(inputStream))) {
                reader.lines().forEach(consumer);
            } catch (IOException e) {
                e.printStackTrace();
            }
        }
    }
}</string></string></password></user_name>

注意事項：

• Runtime.exec(String)在JDK 18中已被標記為棄用，因為它在處理複雜命令時確實存在解析問題。推薦使用ProcessBuilder。
• 將命令的每個組成部分（包括命令本身、選項、參數(shù)和文件路徑）作為數(shù)組的一個獨立元素。
• 對於包含空格但需要作為一個整體的參數(shù)，例如連接字符串，將其作為一個獨立的字符串元素放入數(shù)組中。如果該參數(shù)內(nèi)部包含引號，則這些引號也應作為該字符串的一部分。

方案二：使用ProcessBuilder (推薦)

ProcessBuilder類提供了更強大和靈活的方式來創(chuàng)建和管理外部進程。它允許您設置工作目錄、環(huán)境變量，以及更精細地控制標準輸入、輸出和錯誤流的重定向。

示例代碼：

 import java.io.IOException;
import java.io.BufferedReader;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.util.concurrent.Executors;
import java.util.concurrent.Future;
import java.util.concurrent.ExecutionException;
import java.util.function.Consumer;
import java.util.Arrays;

public class RunSqlPlusWithProcessBuilder {

    public static void main(String[] args) {
        try {
            // 將命令及其參數(shù)分解為字符串數(shù)組的每個元素String[] cmdArray = new String[] {
                "sqlplus",
                "-s",
                "-LOGON",
                "<user_name>/<password>@\"(DESCRIPTION=(ADDRESS=(PROTOCOL=TCP)(Host= host1.com)(Port=1725))(ADDRESS=(PROTOCOL=TCP)(Host= host2.com)(Port=1725))(LOAD_BALANCE = ON)(FAILOVER = ON) (CONNECT_DATA = (SERVER = DEDICATED)(SERVICE_NAME=service.com)))\"",
                "@Load.sql"
            };

            ProcessBuilder pb = new ProcessBuilder(cmdArray);
            // 可以設置工作目錄，例如：pb.directory(new File("/path/to/script/directory"));
            // 可以設置環(huán)境變量，例如：pb.environment().put("VAR_NAME", "VAR_VALUE");

            // 將標準錯誤流重定向到標準輸出流，這樣只需要處理一個輸入流pb.redirectErrorStream(true);

            Process process = pb.start();

            // 使用StreamGobbler處理合併後的輸出流StreamGobbler outputGobbler =
                    new StreamGobbler(process.getInputStream(), System.out::println);

            Future> outputFuture = Executors.newSingleThreadExecutor().submit(outputGobbler);

            int exitCode = process.waitFor();
            System.out.println("Exited with code: " exitCode);

            outputFuture.get(); // 等待輸出流處理完成} catch (IOException | InterruptedException | ExecutionException e) {
            e.printStackTrace();
        }
    }

    // StreamGobbler 輔助類（同上）
    private static class StreamGobbler implements Runnable {
        private InputStream inputStream;
        private Consumer<string> consumer;

        public StreamGobbler(InputStream inputStream, Consumer<string> consumer) {
            this.inputStream = inputStream;
            this.consumer = consumer;
        }

        @Override
        public void run() {
            try (BufferedReader reader = new BufferedReader(new InputStreamReader(inputStream))) {
                reader.lines().forEach(consumer);
            } catch (IOException e) {
                e.printStackTrace();
            }
        }
    }
}</string></string></password></user_name>

ProcessBuilder的優(yōu)勢：

• 參數(shù)解析：像Runtime.exec(String[])一樣，ProcessBuilder構(gòu)造函數(shù)接受一個字符串列表或數(shù)組，確保每個參數(shù)都被正確傳遞，避免了shell解析問題。
• 流重定向： ProcessBuilder提供了豐富的流重定向選項，例如redirectOutput(), redirectError(), redirectInput()，以及非常實用的redirectErrorStream(true)，它可以將標準錯誤流合併到標準輸出流，簡化了流處理邏輯，避免了死鎖的風險（當父進程不及時讀取子進程的輸出流時，子進程可能會因為緩衝區(qū)滿而阻塞）。
• 環(huán)境和目錄：可以方便地設置子進程的工作目錄和環(huán)境變量，這對於某些需要特定環(huán)境才能正確運行的命令非常有用。
• 鍊式調(diào)用： ProcessBuilder支持鍊式調(diào)用，使得代碼更簡潔易讀。

總結(jié)

當在Java中執(zhí)行外部命令，特別是那些參數(shù)複雜或包含特殊字符（如空格、引號）的命令時，應避免使用Runtime.getRuntime().exec(String cmd)。最佳實踐是使用Runtime.getRuntime().exec(String[] cmdarray)或更推薦的java.lang.ProcessBuilder類。通過將命令及其參數(shù)分解為獨立的字符串數(shù)組元素，可以確保這些參數(shù)被正確傳遞給外部進程，從而獲得預期的執(zhí)行結(jié)果。同時，務必正確處理外部進程的標準輸出和標準錯誤流，以避免進程阻塞和獲取完整的執(zhí)行信息。對於數(shù)據(jù)庫操作，儘管直接調(diào)用sqlplus在某些特定場景下有用，但通常更推薦使用JDBC驅(qū)動程序進行數(shù)據(jù)庫交互，因為它提供了更安全、高效和類型安全的編程接口。

以上是Java中調(diào)用SQLPlus命令輸出異常的排查與解決方案的詳細內(nèi)容。更多資訊請關注PHP中文網(wǎng)其他相關文章！