Web 工程獲取項目根路徑的標準姿勢：Spring WebAppRootListener

Web 工程獲取項目根路徑的標準姿勢：Spring WebAppRootListener

在 Web 容器中獲取部署根路徑（webapp/ 目錄）是常見需求：讀取配置文件、存儲上傳文件、生成報表等。Spring 提供開箱即用的監聽器方案。

配置步驟

1. web.xml 註冊監聽器與上下文參數

<context-param>
    <param-name>webAppRootKey</param-name>
    <param-value>webapp.root</param-value>
</context-param>
<listener>
    <listener-class>org.springframework.web.util.WebAppRootListener</listener-class>
</listener>

• webAppRootKey：自定義系統屬性鍵，默認 webapp.root。
• WebAppRootListener：ServletContextListener 實現，容器啟動時將 ServletContext.getRealPath("/") 寫入 System.setProperty(key, path)。

2. Java 代碼中獲取

public class PathUtil {
    private static final String WEB_ROOT = System.getProperty("webapp.root");
    public static String getWebRoot() { return WEB_ROOT; }
    public static String getAbsolutePath(String relativePath) {
        return WEB_ROOT + File.separator + relativePath;
    }
}

原理剖析

// WebAppRootListener 源碼精簡
public class WebAppRootListener implements ServletContextListener {
    public void contextInitialized(ServletContextEvent event) {
        String key = event.getServletContext().getInitParameter("webAppRootKey");
        String root = event.getServletContext().getRealPath("/");
        System.setProperty(key, root);
    }
    public void contextDestroyed(ServletContextEvent event) {
        String key = event.getServletContext().getInitParameter("webAppRootKey");
        System.clearProperty(key); // 防止內存洩漏
    }
}

注意事項與替代方案

最佳實踐

• 不要硬編碼路徑：跨平台（Windows/Linux）分隔符差異、部署結構變更（爆炸部署 vs 打包部署）均會導致失效。
• 統一工具類：封裝 PathUtil，業務代碼僅依賴相對路徑。
• 容器關閉清理：WebAppRootListener 已在 contextDestroyed 中 clearProperty，防止系統屬性污染後續部署。

一行配置，一行代碼，優雅解決「路徑焦慮」。