Java Session 監聽器實作錯誤排查：遺漏介面宣告導致屬性監聽失效

問題背景

在開發 Java Web 應用時，使用 HttpSessionListener 與 HttpSessionAttributeListener 監聽 Session 的建立、銷毀及屬性變更，是常見的會話管理手段。然而，若在類別宣告時遺漏實作介面，會導致對應的監聽方法完全不被容器調用，且不拋出任何異常，極難排查。

錯誤代碼示例

package cn.lang.any.listener;

import java.util.*;
import javax.servlet.*;
import javax.servlet.http.*;

public class AmpList implements ServletContextListener, HttpSessionListener /* 遺漏 HttpSessionAttributeListener */ {
    private ServletContext application = null;

    public void contextInitialized(ServletContextEvent sce) {
        this.application = sce.getServletContext();
        this.application.setAttribute("alluser", new ArrayList());
    }

    public void sessionCreated(HttpSessionEvent se) { }

    public void sessionDestroyed(HttpSessionEvent se) {
        List l = (List) this.application.getAttribute("alluser");
        String value = (String) se.getSession().getAttribute("uname");
        l.remove(value);
        this.application.setAttribute("alluser", l);
    }

    // 以下屬性監聽方法因介面未實作，永不會被調用
    public void attributeAdded(HttpSessionBindingEvent se) {
        List lis = (List) this.application.getAttribute("alluser");
        lis.add(se.getValue());
        this.application.setAttribute("alluser", lis);
    }

    public void attributeRemoved(HttpSessionBindingEvent se) { }
    public void attributeReplaced(HttpSessionBindingEvent se) { }
    public void contextDestroyed(ServletContextEvent sce) { }
}

錯誤現象

• Session 建立、銷毀事件正常觸發。
• 呼叫 session.setAttribute("uname", "xxx") 時，attributeAdded 不執行，導致 application 範圍的 alluser 清單未同步更新。
• 控制台無錯誤訊息，單元測試也通過，僅功能失效。

根本原因

類別宣告 implements ServletContextListener, HttpSessionListener，缺少 HttpSessionAttributeListener。Servlet 容器在部署階段掃描監聽器時，僅註冊已實作介面對應的事件；未實作的介面方法視同不存在，故不納入通知鏈。

修正方式

public class AmpList implements ServletContextListener, HttpSessionListener, HttpSessionAttributeListener {
    // ... 原有方法保持不變
}

補上介面後重新部署，屬性監聽即刻生效。

最佳實踐建議

1. 介面檢查清單：在實作監聽器前，列出需監聽的事件與對應介面，逐一核對 implements 子句。
2. 單元測試覆蓋事件：針對每個監聽方法編寫整合測試，驗證事件確實被觸發。
3. 啟用容器除錯日誌：Tomcat 可設定 org.apache.catalina.core.ApplicationContext 為 FINE 級別，觀察監聽器註冊情況。
4. 程式碼審查重點：將「介面宣告與方法實作是否一一對應」列入 Code Review 清單。

總結

這是一個典型的「編譯通過、執行無錯、功能失效」的低級錯誤。Java 的介面機制要求宣告與實作嚴格對應，任何遺漏都會導致對應功能靜默失效。養成「先寫介面、再實作方法、最後核對宣告」的習慣，可有效避免此類問題。