在 Eclipse 控制台輸出自定義訊息的實作指南

在開發 Eclipse 外掛或 RCP 應用程式時，經常需要將除錯資訊、操作日誌等直接輸出到 Eclipse 的 Console 視圖中，方便開發人員追蹤程式執行狀態，或讓終端使用者查看當前操作回饋。Eclipse 提供了 org.eclipse.ui.console 套件，讓我們能以程式化方式建立專屬的 Console 並寫入訊息。

核心實作步驟

以下範例示範如何建立一個名為「RCP」的 Console，並輸出帶時間戳記的訊息：

// 取得或建立 Console
MessageConsoleStream console = this.openLogConsole("RCP", "Information", "org.eclipse.workbench.ui.ide");
// 寫入訊息
console.println(new Date(System.currentTimeMillis()) + ": selected!");

openLogConsole 方法完整實作

public MessageConsoleStream openLogConsole(String domainName,
                                           String stationId,
                                           String applicationId) {
    System.err.println("openLogConsole(domain=" + domainName +
                       ", station=" + stationId + ", app=" + applicationId + ")");

    // 組裝 Console 名稱，格式：Domain > Station > Application
    StringBuffer consoleName = new StringBuffer(domainName);
    if (stationId != null) {
        consoleName.append(" > " + stationId);
        if (applicationId != null) {
            consoleName.append(" > " + applicationId);
        }
    }

    // 建立 MessageConsole 及其輸出串流
    MessageConsole console = new MessageConsole(consoleName.toString(), null);
    final MessageConsoleStream consoleStream = console.newMessageStream();
    consoleStream.setColor(Display.getDefault().getSystemColor(SWT.COLOR_BLUE));

    // 向 Console Manager 註冊並顯示
    IConsoleManager manager = (IConsoleManager) ConsolePlugin.getDefault().getConsoleManager();
    manager.addConsoles(new IConsole[] { console });
    manager.showConsoleView(console);

    return consoleStream;
}

關鍵點解析

• MessageConsole：Eclipse 主控台模型的核心類別，可包含多個輸出串流。
• MessageConsoleStream：實際寫入文字的管道，支援設定顏色、編碼等屬性。
• IConsoleManager：管理所有 Console 的註冊、顯示、隱藏等生命週期。
• 命名慣例：建議採用「領域 > 站台 > 應用」的階層命名，便於在 Console 下拉選單中快速識別。

應用場景

此機制適用於：

• 外掛開發時的除錯輸出，替代 System.out.println
• RCP 應用記錄使用者操作審計軌跡
• 長時間執行任務的進度回報
• 多模組系統的模組化日誌分離

掌握這套 API 後，即可在 Eclipse 環境中建立專業、可維護的控制台輸出體系。