Java 應用程式日誌實戰：Log4j 完整配置指南

為什麼需要日誌框架？

每個應用程式都需要與外部世界溝通、收集執行數據。雖然資料庫、API 介面都是選項，但純文字日誌檔案仍是最直觀、最低成本的除錯與審計手段。它不需要額外基礎設施，卻能完整重現系統行為軌跡。

Log4j 核心三大概念

1. Logger（記錄器/類別）：命名空間層級結構（如 com.example.module），支援繼承關係。
2. Appender（輸出端）：決定日誌「寫到哪裡」—— Console、File、RollingFile、Socket、JMS 等。
3. Layout（佈局/格式化）：決定日誌「長什麼樣子」—— 日期、執行緒、類別名、訊息內容等。

優先級體系（由低到高）

DEBUG < INFO < WARN < ERROR < FATAL

設定 Logger 優先級為 WARN 時，DEBUG 和 INFO 訊息將被忽略。這能在生產環境大幅減少 I/O 開銷。

經典配置範例

log4j.properties（屬性檔風格）

# 根 Logger 設定：DEBUG 等級，掛載三個 Appender
log4j.rootLogger=DEBUG, A1, A2, A3

# A1: Console 輸出
log4j.appender.A1=org.apache.log4j.ConsoleAppender
log4j.appender.A1.layout=org.apache.log4j.PatternLayout
log4j.appender.A1.layout.ConversionPattern=%-5p %d %t %m%n

# A2: 滾動檔案（依大小切割）
log4j.appender.A2=org.apache.log4j.RollingFileAppender
log4j.appender.A2.File=logs/app.log
log4j.appender.A2.MaxFileSize=10MB
log4j.appender.A2.MaxBackupIndex=10
log4j.appender.A2.layout=org.apache.log4j.PatternLayout
log4j.appender.A2.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss} %-5p [%t] %c - %m%n

# A3: UDP 廣播（適合即時監控工具接收）
log4j.appender.A3=org.apache.log4j.net.SyslogAppender
log4j.appender.A3.SyslogHost=localhost
log4j.appender.A3.Facility=LOCAL7
log4j.appender.A3.layout=org.apache.log4j.PatternLayout
log4j.appender.A3.layout.ConversionPattern=%-5p %c - %m%n

PatternLayout 常用轉換字元速查表

程式碼整合三步驟

1. 初始化配置（應用程式啟動時一次）

import org.apache.log4j.PropertyConfigurator;

public class AppInit {
    public static void initLogging() {
        // 路徑建議放在 classpath 根目錄或絕對路徑
        PropertyConfigurator.configure("config/log4j.properties");
    }
}

2. 宣告 Logger（建議 static final）

import org.apache.log4j.Logger;

public class OrderService {
    private static final Logger log = Logger.getLogger(OrderService.class);

    public void createOrder(Order order) {
        log.info("建立訂單: " + order.getId());
        // ...
    }
}

3. 記錄事件（搭配條件檢查避免無謂字串組裝）

// 基本用法
log.debug("訂單詳細資料: " + order.toString()); // 即使 DEBUG 關閉，字串仍會組裝

// 進階用法：效能優化
if (log.isDebugEnabled()) {
    log.debug("訂單詳細資料: " + expensiveToString(order)); // 只有開啟 DEBUG 才執行
}

// 記錄例外堆疊（關鍵！）
try {
    // risky operation
} catch (Exception e) {
    log.error("處理訂單失敗", e); // 完整堆疊會寫入日誌
}

最佳實務建議

• 分模組配置：不同子系統（如 com.example.payment、com.example.warehouse）設定不同等級與 Appender。
• 生產環境關閉 DEBUG：預設 INFO 或 WARN，問題時動態調整（Log4j 2 支援 JMX 熱修改）。
• 使用非同步 Appender：高併發系統請包裝 AsyncAppender，避免日誌 I/O 阻塞業務執行緒。
• 結構化日誌：現代系統建議輸出 JSON 格式，配合 ELK/EFK 堆疊做集中分析。

遷移提醒：Log4j 1.x 已停止維護

請務必升級至 Log4j 2.x 或改用 SLF4J + Logback。Log4j 2 提供：

• 無鎖非同步架構，效能提升 10 倍以上
• 支援 Lambda 延遲求值（log.debug(() -> expensiveOp())）
• 豐富的外掛生態（Kafka、Elasticsearch、Syslog 等）
• 修復了著名的 Log4Shell (CVE-2021-44228) 安全漏洞