IDEA 如何讓程式執行期間 不在 RUN 視窗的輸出，而是輸出到log 檔案

gongchengship發表於2024-10-10
Idea

在 IntelliJ IDEA 中，可以將程式的輸出重定向到一個日誌檔案，而不是直接輸出到 Run 視窗。這個可以透過配置 log4j 或者 java.util.logging 等日誌框架來實現，也可以使用標準的輸出重定向方法將 System.out 和 System.err 輸出到檔案中。

下面是幾種實現方式：

1. 使用 log4j 或 slf4j 等日誌框架

log4j、slf4j 等日誌框架是標準的日誌輸出工具，支援將日誌輸出到檔案中。假設你已經在專案中使用了 log4j，可以透過配置日誌檔案輸出。

log4j 配置示例（log4j2.xml）

<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="WARN">
    <Appenders>
        <!-- 控制檯輸出 -->
        <Console name="Console" target="SYSTEM_OUT">
            <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n" />
        </Console>
        
        <!-- 檔案輸出 -->
        <File name="File" fileName="logs/app.log">
            <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n" />
        </File>
    </Appenders>

    <Loggers>
        <!-- 根日誌記錄器 -->
        <Root level="info">
            <AppenderRef ref="Console"/>
            <AppenderRef ref="File"/>
        </Root>
    </Loggers>
</Configuration>

在這個配置檔案中：

  • Console appender 負責輸出到 IDEA 的控制檯。
  • File appender 負責輸出到指定的檔案（比如 logs/app.log）。

你可以根據需求刪除 Console appender 使得所有日誌都只輸出到檔案。

使用 log4j 的程式碼示例

import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;

public class MyApplication {
    private static final Logger logger = LogManager.getLogger(MyApplication.class);

    public static void main(String[] args) {
        logger.info("This is an info message.");
        logger.error("This is an error message.");
    }
}

2. 使用標準輸出重定向

如果你不想引入日誌框架，也可以透過標準的 System.out 和 System.err 重定向實現輸出到檔案。

示例程式碼：

import java.io.FileOutputStream;
import java.io.PrintStream;

public class MyApplication {
    public static void main(String[] args) {
        try {
            // 建立輸出流
            FileOutputStream fileOut = new FileOutputStream("logs/app_output.log");
            PrintStream printStream = new PrintStream(fileOut);
            
            // 將標準輸出重定向到檔案
            System.setOut(printStream);
            
            // 將標準錯誤輸出重定向到檔案
            System.setErr(printStream);
            
            // 測試輸出
            System.out.println("This message will be written to the log file.");
            System.err.println("This is an error message.");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

在這個示例中：

  • System.setOut() 用來將標準輸出（System.out）重定向到檔案。
  • System.setErr() 用來將標準錯誤輸出（System.err）重定向到檔案。

這樣，所有原本會輸出到 Run 視窗的內容，現在會被寫入到 logs/app_output.log 檔案中。

3. 使用 java.util.logging

Java 內建的日誌框架 java.util.logging 也支援將日誌輸出到檔案中。配置較為簡單，以下是如何透過 java.util.logging 將輸出重定向到檔案的示例。

示例程式碼：

import java.io.IOException;
import java.util.logging.FileHandler;
import java.util.logging.Logger;
import java.util.logging.SimpleFormatter;

public class MyApplication {
    private static final Logger logger = Logger.getLogger(MyApplication.class.getName());

    public static void main(String[] args) {
        try {
            // 建立檔案處理器，日誌檔案將輸出到 logs/app_log.log
            FileHandler fileHandler = new FileHandler("logs/app_log.log", true);
            fileHandler.setFormatter(new SimpleFormatter());
            
            // 將檔案處理器新增到日誌記錄器中
            logger.addHandler(fileHandler);
            
            // 測試輸出
            logger.info("This is an info message.");
            logger.severe("This is a severe error message.");
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}

在這個示例中，日誌資訊會被寫入到 logs/app_log.log 檔案中，而不是輸出到 Run 視窗。

4. IntelliJ IDEA 自帶日誌功能

IntelliJ IDEA 允許你在 Run/Debug Configurations 中配置輸出日誌檔案：

  1. 開啟 Run/Debug Configurations。
  2. 選擇你的應用程式的執行配置。
  3. 在右側選擇 Logs 選項卡。
  4. 點選 + 號，選擇 Log File，設定日誌檔案路徑和其他引數。
  5. 你可以配置 IDEA 自動將執行時輸出寫入指定的日誌檔案。

這種方式主要適用於你已經有其他方式來輸出日誌（如 log4j 等），並希望 IDEA 將輸出寫入到日誌檔案。

總結

  • 如果使用日誌框架（如 log4j、slf4j），可以透過配置日誌檔案輸出。
  • 如果不使用日誌框架，也可以透過標準輸出和錯誤輸出重定向到檔案。
  • Java 內建的 java.util.logging 也提供了將日誌寫入檔案的功能。
  • IntelliJ IDEA 允許在 Run/Debug Configurations 中直接配置日誌檔案的輸出路徑。

透過這些方式，你可以將 Java 程式執行時的日誌重定向到檔案，而不在 IDEA 的 Run 視窗中顯示。

相關文章