java截獲標準輸出（1）(轉)
java截獲標準輸出（1）(轉)[@more@]在Java程序中截獲控制臺輸出
內(nèi)容：
一、Java管道流
1.1 注意事項一
1.2 注意事項二
1.3 注意事項三
1.4 解決問題
二、捕獲Java控制臺輸出
三、捕獲其他程序的控制臺輸出
參考資料
關于作者
俞良松 (javaman@163.net)
軟件工程師，獨立顧問和自由撰稿人
2001 年 10 月
在Java開發(fā)中，控制臺輸出仍是一個重要的工具，但默認的控制臺輸出有著各種各樣的局限。本文介紹如何用Java管道流截取控制臺輸出，分析管道流應用中應該注意的問題，提供了截取Java程序和非Java程序控制臺輸出的實例。
即使在圖形用戶界面占統(tǒng)治地位的今天，控制臺輸出仍舊在Java程序中占有重要地位?？刂婆_不僅是Java程序默認的堆棧跟蹤和錯誤信息輸出窗口，而且還是一種實用的調(diào)試工具（特別是對習慣于使用println()的人來說）。然而，控制臺窗口有著許多局限。例如在Windows 9x平臺上，DOS控制臺只能容納50行輸出。如果Java程序一次性向控制臺輸出大量內(nèi)容，要查看這些內(nèi)容就很困難了。
對于使用javaw這個啟動程序的開發(fā)者來說，控制臺窗口尤其寶貴。因為用javaw啟動java程序時，根本不會有控制臺窗口出現(xiàn)。如果程序遇到了問題并拋出異常，根本無法查看Java運行時環(huán)境寫入到System.out或System.err的調(diào)用堆棧跟蹤信息。為了捕獲堆棧信息，一些人采取了用try/catch()塊封裝main()的方式，但這種方式不一定總是有效，在Java運行時的某些時刻，一些描述性錯誤信息會在拋出異常之前被寫入System.out和System.err；除非能夠監(jiān)測這兩個控制臺流，否則這些信息就無法看到。
因此，有些時候檢查Java運行時環(huán)境（或第三方程序）寫入到控制臺流的數(shù)據(jù)并采取合適的操作是十分必要的。本文討論的主題之一就是創(chuàng)建這樣一個輸入流，從這個輸入流中可以讀入以前寫入Java控制臺流（或任何其他程序的輸出流）的數(shù)據(jù)。我們可以想象寫入到輸出流的數(shù)據(jù)立即以輸入的形式“回流”到了Java程序。
本文的目標是設計一個基于Swing的文本窗口顯示控制臺輸出。在此期間，我們還將討論一些和Java管道流（PipedInputStream 和PipedOutputStream）有關的重要注意事項。圖一顯示了用來截取和顯示控制臺文本輸出的Java程序，用戶界面的核心是一個 JTextArea。最后，我們還要創(chuàng)建一個能夠捕獲和顯示其他程序（可以是非Java的程序）控制臺輸出的簡單程序。
圖一：多線程的控制臺輸出截取程序
一、Java管道流
要在文本框中顯示控制臺輸出，我們必須用某種方法“截取”控制臺流。換句話說，我們要有一種高效地讀取寫入到System.out和 System.err所有內(nèi)容的方法。如果你熟悉Java的管道流PipedInputStream和PipedOutputStream，就會相信我們已經(jīng)擁有最有效的工具。
寫入到PipedOutputStream輸出流的數(shù)據(jù)可以從對應的PipedInputStream輸入流讀取。Java的管道流極大地方便了我們截取控制臺輸出。Listing 1顯示了一種非常簡單的截取控制臺輸出方案。
【Listing 1：用管道流截取控制臺輸出】
PipedInputStream pipedIS = new PipedInputStream();
PipedOutputStream pipedOS = new PipedOutputStream();
try {
pipedOS.connect(pipedIS);
}
catch(IOException e) {
System.err.println("連接失敗");
System.exit(1);
}
PrintStream ps = new PrintStream(pipedOS);
System.setOut(ps);
System.setErr(ps);
可以看到，這里的代碼極其簡單。我們只是建立了一個PipedInputStream，把它設置為所有寫入控制臺流的數(shù)據(jù)的最終目的地。所有寫入到控制臺流的數(shù)據(jù)都被轉到PipedOutputStream，這樣，從相應的PipedInputStream讀取就可以迅速地截獲所有寫入控制臺流的數(shù)據(jù)。接下來的事情似乎只剩下在Swing JTextArea中顯示從pipedIS流讀取的數(shù)據(jù)，得到一個能夠在文本框中顯示控制臺輸出的程序。遺憾的是，在使用Java管道流時有一些重要的注意事項。只有認真對待所有這些注意事項才能保證Listing 1的代碼穩(wěn)定地運行。下面我們來看第一個注意事項。
1.1 注意事項一
PipedInputStream運用的是一個1024字節(jié)固定大小的循環(huán)緩沖區(qū)。寫入PipedOutputStream的數(shù)據(jù)實際上保存到對應的PipedInputStream的內(nèi)部緩沖區(qū)。從PipedInputStream執(zhí)行讀操作時，讀取的數(shù)據(jù)實際上來自這個內(nèi)部緩沖區(qū)。如果對應的 PipedInputStream輸入緩沖區(qū)已滿，任何企圖寫入PipedOutputStream的線程都將被阻塞。而且這個寫操作線程將一直阻塞，直至出現(xiàn)讀取PipedInputStream的操作從緩沖區(qū)刪除數(shù)據(jù)。
這意味著，向PipedOutputStream寫數(shù)據(jù)的線程不應該是負責從對應PipedInputStream讀取數(shù)據(jù)的唯一線程。從圖二可以清楚地看出這里的問題所在：假設線程t是負責從PipedInputStream讀取數(shù)據(jù)的唯一線程；另外，假定t企圖在一次對 PipedOutputStream的write()方法的調(diào)用中向對應的PipedOutputStream寫入2000字節(jié)的數(shù)據(jù)。在t線程阻塞之前，它最多能夠寫入1024字節(jié)的數(shù)據(jù)（PipedInputStream內(nèi)部緩沖區(qū)的大?。Ｈ欢?，一旦t被阻塞，讀取 PipedInputStream的操作就再也不會出現(xiàn)，因為t是唯一讀取PipedInputStream的線程。這樣，t線程已經(jīng)完全被阻塞，同時，所有其他試圖向PipedOutputStream寫入數(shù)據(jù)的線程也將遇到同樣的情形。
圖二：管道流工作過程
這并不意味著在一次write()調(diào)用中不能寫入多于1024字節(jié)的數(shù)據(jù)。但應當保證，在寫入數(shù)據(jù)的同時，有另一個線程從PipedInputStream讀取數(shù)據(jù)。
Listing 2示范了這個問題。這個程序用一個線程交替地讀取PipedInputStream和寫入PipedOutputStream。每次調(diào)用write()向 PipedInputStream的緩沖區(qū)寫入20字節(jié)，每次調(diào)用read()只從緩沖區(qū)讀取并刪除10個字節(jié)。內(nèi)部緩沖區(qū)最終會被寫滿，導致寫操作阻塞。由于我們用同一個線程執(zhí)行讀、寫操作，一旦寫操作被阻塞，就不能再從PipedInputStream讀取數(shù)據(jù)。
【Listing 2：用同一個線程執(zhí)行讀/寫操作導致線程阻塞】
import java.io.*;
public class Listing2 {
static PipedInputStream pipedIS = new PipedInputStream();
static PipedOutputStream pipedOS =
new PipedOutputStream();
public static void main(String[] a){
try {
pipedIS.connect(pipedOS);
}
catch(IOException e) {
System.err.println("連接失敗");
System.exit(1);
}
byte[] inArray = new byte[10];
byte[] outArray = new byte[20];
int bytesRead = 0;
try {
// 向pipedOS發(fā)送20字節(jié)數(shù)據(jù)
pipedOS.write(outArray, 0, 20);
System.out.println(" 已發(fā)送20字節(jié)...");
// 在每一次循環(huán)迭代中，讀入10字節(jié)
// 發(fā)送20字節(jié)
bytesRead = pipedIS.read(inArray, 0, 10);
int i=0;
while(bytesRead != -1) {
pipedOS.write(outArray, 0, 20);
System.out.println(" 已發(fā)送20字節(jié)..."+i);
i++;
bytesRead = pipedIS.read(inArray, 0, 10);
}
}
catch(IOException e) {
System.err.println("讀取pipedIS時出現(xiàn)錯誤: " + e);
System.exit(1);
}
} // main()
}
只要把讀/寫操作分開到不同的線程，Listing 2的問題就可以輕松地解決。Listing 3是Listing 2經(jīng)過修改后的版本，它在一個單獨的線程中執(zhí)行寫入PipedOutputStream的操作（和讀取線程不同的線程）。為證明一次寫入的數(shù)據(jù)可以超過 1024字節(jié)，我們讓寫操作線程每次調(diào)用PipedOutputStream的write()方法時寫入2000字節(jié)。那么，在 startWriterThread()方法中創(chuàng)建的線程是否會阻塞呢？按照Java運行時線程調(diào)度機制，它當然會阻塞。寫操作在阻塞之前實際上最多只能寫入1024字節(jié)的有效載荷（即PipedInputStream緩沖區(qū)的大?。５@并不會成為問題，因為主線程（main）很快就會從 PipedInputStream的循環(huán)緩沖區(qū)讀取數(shù)據(jù)，空出緩沖區(qū)空間。最終，寫操作線程會從上一次中止的地方重新開始，寫入2000字節(jié)有效載荷中的剩余部分。
【Listing 3：把讀/寫操作分開到不同的線程】
import java.io.*;
public class Listing3 {
static PipedInputStream pipedIS =
new PipedInputStream();
static PipedOutputStream pipedOS =
new PipedOutputStream();
public static void main(String[] args) {
try {
pipedIS.connect(pipedOS);
}
catch(IOException e) {
System.err.println("連接失敗");
System.exit(1);
}
byte[] inArray = new byte[10];
int bytesRead = 0;
// 啟動寫操作線程
startWriterThread();
try {
bytesRead = pipedIS.read(inArray, 0, 10);
while(bytesRead != -1) {
System.out.println("已經(jīng)讀取" +
bytesRead + "字節(jié)...");
bytesRead = pipedIS.read(inArray, 0, 10);
}
}
catch(IOException e) {
System.err.println("讀取輸入錯誤.");
System.exit(1);
}
} // main()
// 創(chuàng)建一個獨立的線程
// 執(zhí)行寫入PipedOutputStream的操作
private static void startWriterThread() {
new Thread(new Runnable() {
public void run() {
byte[] outArray = new byte[2000];
while(true) { // 無終止條件的循環(huán)
try {
// 在該線程阻塞之前，有最多1024字節(jié)的數(shù)據(jù)被寫入
pipedOS.write(outArray, 0, 2000);
}
catch(IOException e) {
System.err.println("寫操作錯誤");
System.exit(1);
}
System.out.println(" 已經(jīng)發(fā)送2000字節(jié)...");
}
}
}).start();
} // startWriterThread()
} // Listing3
也許我們不能說這個問題是Java管道流設計上的缺陷，但在應用管道流時，它是一個必須密切注意的問題。下面我們來看看第二個更重要（更危險的）問題。
1.2 注意事項二
從PipedInputStream讀取數(shù)據(jù)時，如果符合下面三個條件，就會出現(xiàn)IOException異常：
試圖從PipedInputStream讀取數(shù)據(jù)，
PipedInputStream的緩沖區(qū)為“空”（即不存在可讀取的數(shù)據(jù)），
最后一個向PipedOutputStream寫數(shù)據(jù)的線程不再活動（通過Thread.isAlive()檢測）。
這是一個很微妙的時刻，同時也是一個極其重要的時刻。假定有一個線程w向PipedOutputStream寫入數(shù)據(jù)；另一個線程r從對應的 PipedInputStream讀取數(shù)據(jù)。下面一系列的事件將導致r線程在試圖讀取PipedInputStream時遇到IOException異常：
w向PipedOutputStream寫入數(shù)據(jù)。
w結束（w.isAlive()返回false）。
r從PipedInputStream讀取w寫入的數(shù)據(jù)，清空PipedInputStream的緩沖區(qū)。
r試圖再次從PipedInputStream讀取數(shù)據(jù)。這時PipedInputStream的緩沖區(qū)已經(jīng)為空，而且w已經(jīng)結束，從而導致在讀操作執(zhí)行時出現(xiàn)IOException異常。
構造一個程序示范這個問題并不困難，只需從Listing 3的startWriterThread()方法中，刪除while(true)條件。這個改動阻止了執(zhí)行寫操作的方法循環(huán)執(zhí)行，使得執(zhí)行寫操作的方法在一次寫入操作之后就結束運行。如前所述，此時主線程試圖讀取PipedInputStraem時，就會遇到一個IOException異常。
這是一種比較少見的情況，而且不存在直接修正它的方法。請不要通過從管道流派生子類的方法修正該問題??在這里使用繼承是完全不合適的。而且，如果Sun以后改變了管道流的實現(xiàn)方法，現(xiàn)在所作的修改將不再有效。
最后一個問題和第二個問題很相似，不同之處在于，它在讀線程（而不是寫線程）結束時產(chǎn)生IOException異常。
1.3 注意事項三
如果一個寫操作在PipedOutputStream上執(zhí)行，同時最近從對應PipedInputStream讀取的線程已經(jīng)不再活動（通過 Thread.isAlive()檢測），則寫操作將拋出一個IOException異常。假定有兩個線程w和r，w向 PipedOutputStream寫入數(shù)據(jù)，而r則從對應的PipedInputStream讀取。下面一系列的事件將導致w線程在試圖寫入 PipedOutputStream時遇到IOException異常：
寫操作線程w已經(jīng)創(chuàng)建，但r線程還不存在。
w向PipedOutputStream寫入數(shù)據(jù)。
讀線程r被創(chuàng)建，并從PipedInputStream讀取數(shù)據(jù)。
r線程結束。
w企圖向PipedOutputStream寫入數(shù)據(jù)，發(fā)現(xiàn)r已經(jīng)結束，拋出IOException異常。
實際上，這個問題不象第二個問題那樣棘手。和多個讀線程/單個寫線程的情況相比，也許在應用中有一個讀線程（作為響應請求的
服務器）和多個寫線程（發(fā)出請求）的情況更為常見。
1.4 解決問題
要防止管道流前兩個局限所帶來的問題，方法之一是用一個ByteArrayOutputStream作為代理或替代 PipedOutputStream。Listing 4顯示了一個LoopedStreams類，它用一個ByteArrayOutputStream提供和Java管道流類似的功能，但不會出現(xiàn)死鎖和 IOException異常。這個類的內(nèi)部仍舊使用管道流，但隔離了本文介紹的前兩個問題。我們先來看看這個類的公用方法（參見圖3）。構造函數(shù)很簡單，它連接管道流，然后調(diào)用startByteArrayReaderThread()方法（稍后再討論該方法）。getOutputStream()方法返回一個OutputStream（具體地說，是一個ByteArrayOutputStream）用以替代PipedOutputStream。寫入該 OutputStream的數(shù)據(jù)最終將在getInputStream()方法返回的流中作為輸入出現(xiàn)。和使用PipedOutputStream的情形不同，向ByteArrayOutputStream寫入數(shù)據(jù)的線程的激活、寫數(shù)據(jù)、結束不會帶來負面效果。
圖三：ByteArrayOutputStream原理
【Listing 4：防止管道流應用中出現(xiàn)的常見問題】
import java.io.*;
public class LoopedStreams {
private PipedOutputStream pipedOS =
new PipedOutputStream();
private boolean keepRunning = true;
private ByteArrayOutputStream byteArrayOS =
new ByteArrayOutputStream() {
public void close() {
keepRunning = false;
try {
super.close();
pipedOS.close();
}
catch(IOException e) {
// 記錄錯誤或其他處理
// 為簡單計，此處我們直接結束
System.exit(1);
}
}
};
private PipedInputStream pipedIS = new PipedInputStream() {
public void close() {
keepRunning = false;
try {
super.close();
}
catch(IOException e) {
// 記錄錯誤或其他處理
// 為簡單計，此處我們直接結束
System.exit(1);
}
}
};
public LoopedStreams() throws IOException {
pipedOS.connect(pipedIS);
startByteArrayReaderThread();
} // LoopedStreams()
public InputStream getInputStream() {
return pipedIS;
} // getInputStream()
public OutputStream getOutputStream() {
return byteArrayOS;
} // getOutputStream()
private void startByteArrayReaderThread() {
new Thread(new Runnable() {
public void run() {
while(keepRunning) {
// 檢查流里面的字節(jié)數(shù)
if(byteArrayOS.size() > 0) {
byte[] buffer = null;
synchronized(byteArrayOS) {
buffer = byteArrayOS.toByteArray();
byteArrayOS.reset(); // 清除緩沖區(qū)
}
try {
// 把提取到的數(shù)據(jù)發(fā)送給PipedOutputStream
pipedOS.write(buffer, 0, buffer.length);
}
catch(IOException e) {
// 記錄錯誤或其他處理
// 為簡單計，此處我們直接結束
System.exit(1);
}
}
else // 沒有數(shù)據(jù)可用，線程進入睡眠狀態(tài)
try {
// 每隔1秒查看ByteArrayOutputStream檢查新數(shù)據(jù)
Thread.sleep(1000);
}
catch(InterruptedException e) {}
}
}
}).start();
} // startByteArrayReaderThread()
} // LoopedStreams
