JAR 包中獲取項目絕對路徑的最佳實踐：System Property 傳遞法

Web 容器中通過 ServletContext.getRealPath("/") 獲取項目根路徑是常識，但JAR 包類無法直接訪問 ServletContext。本文提供一種零依賴、線程安全、部署無關的通用方案：啟動階段注入 System Property。

一、 核心思路

1. 在 Web 應用啟動時（ServletContextListener、Filter 或 Servlet.init()）獲取真實路徑。
2. 寫入 JVM 系統屬性：System.setProperty("app.root.path", realPath)。
3. JAR 內任意類通過 System.getProperty("app.root.path") 讀取。

二、 完整實現

1. 啟動監聽器（推薦）

import javax.servlet.ServletContextEvent;
import javax.servlet.ServletContextListener;

public class AppPathInitializer implements ServletContextListener {
    private static final String PROP_KEY = "app.root.path";

    @Override
    public void contextInitialized(ServletContextEvent sce) {
        String realPath = sce.getServletContext().getRealPath("/");
        if (realPath != null) {
            System.setProperty(PROP_KEY, realPath);
        } else {
            // 兜底：嘗試從類路徑推導
            String fallback = AppPathInitializer.class.getProtectionDomain()
                    .getCodeSource().getLocation().getPath();
            System.setProperty(PROP_KEY, fallback);
        }
    }

    @Override
    public void contextDestroyed(ServletContextEvent sce) {
        System.clearProperty(PROP_KEY);
    }
}

2. web.xml 註冊

<listener>
    <listener-class>com.yourpkg.AppPathInitializer</listener-class>
</listener>

3. JAR 內工具類讀取

public final class AppPathUtil {
    private static final String PROP_KEY = "app.root.path";

    public static String getAppRootPath() {
        String path = System.getProperty(PROP_KEY);
        if (path == null) {
            throw new IllegalStateException("App root path not initialized! Ensure AppPathInitializer runs first.");
        }
        return path;
    }

    public static File getAppRootDir() {
        return new File(getAppRootPath());
    }

    public static File resolve(String relativePath) {
        return new File(getAppRootDir(), relativePath);
    }
}

三、 關鍵優勢

• 零耦合：JAR 無 Servlet API 依賴，可獨立單元測試（測試前手動 System.setProperty 即可）。
• 線程安全：System Property 進程級可見，多線程讀取無競態。
• 部署無關：支持 WAR、解壓部署、Docker 掛載卷等各種部署形態。
• 可測試性：單元測試用 @BeforeClass 設置屬性即可模擬真實環境。

四、 避坑指南

1. 初始化順序：確保监听器早于使用方加載。若用 Spring，可改用 ApplicationListener<ContextRefreshedEvent> 或 @PostConstruct Bean 注入。
2. Windows 路徑斜槓：getRealPath 返回反斜槓，建議工具類內統一 path.replace('\\', '/')。
3. 多應用隔離：同一 JVM 部署多個 WebApp 時，Key 需帶應用前綴（如 myapp.root.path），避免互覆蓋。
4. 容器安全管理器：極少數生產環境啟用 SecurityManager 禁止 System.setProperty，需改用 JNDI 或環境變量傳遞。

五、 替代方案對比

總結：「啟動時注入 System Property，運行時靜態讀取」是 JAR 包獲取項目絕對路徑的最優解，簡單、穩健、可測試，推薦作為項目基礎設施標準化組件。