Log4j 在 Web 項目中的集成原理與配置要點

關係本質

Log4j 是日誌框架，Web 容器（Tomcat/Jetty）負責管理 Servlet 生命周期。兩者不自動關聯，必須在 Web 應用啟動時主動初始化 Log4j 配置。

標準集成方式

1. web.xml 配置監聽器（傳統 Spring MVC）

<context-param>
    <param-name>log4jConfigLocation</param-name>
    <param-value>/WEB-INF/classes/log4j.properties</param-value>
</context-param>
<context-param>
    <param-name>log4jRefreshInterval</param-name>
    <param-value>60000</param-value> <!-- 60秒自動刷新 -->
</context-param>
<listener>
    <listener-class>org.springframework.web.util.Log4jConfigListener</listener-class>
</listener>

Spring 的 Log4jConfigListener 會在上下文初始化時讀取配置文件並調用 PropertyConfigurator.configure()。

2. Spring Boot 自動配置（推薦）

只需在 src/main/resources 下放入 logback-spring.xml（Spring Boot 2.x 默認用 Logback，兼容 Log4j2 配置），零代碼集成。

3. 手動代碼初始化（無 Spring 環境）

public class MyServletContextListener implements ServletContextListener {
    @Override
    public void contextInitialized(ServletContextEvent sce) {
        String path = sce.getServletContext().getRealPath("/WEB-INF/classes/log4j.properties");
        PropertyConfigurator.configure(path);
    }
}

並在 web.xml 註冊該 Listener。

常見坑點

Log4j 2.x 升級建議

Log4j 1.x 已停止維護（EOL），建議遷移至 Log4j 2.x 或 Logback：

• 異步日誌性能提升 10 倍+
• 無 GC 压力、支持 Lambda 延遲求值
• 配置文件改為 XML/JSON/YAML，語法更豐富

總結

Log4j 與 Web 項目無隱式綁定，必須顯式配置監聽器或代碼初始化。現代項目優先選 Spring Boot + Logback，避免手動配置錯誤。