Java 讀取 Properties 配置文件的 6 種標準姿勢 + Servlet 場景補充

java.util.Properties 是 Java 處理鍵值配置的基石。本文梳理 JDK 標準 API 的 6 種加載方式，對比適用場景，並補充 Web 容器場景下的最佳實踐。

一、 核心 API 基礎

Properties props = new Properties();
props.load(inputStream); // 核心加載方法
String value = props.getProperty("key", "defaultValue"); // 安全取值

二、 6 種加載路徑對比

InputStream in = new BufferedInputStream(
    new FileInputStream("config/app.properties"));

ResourceBundle rb = ResourceBundle.getBundle("config/app", Locale.getDefault());

InputStream in = new BufferedInputStream(
    new FileInputStream("config/app.properties"));
ResourceBundle rb = new PropertyResourceBundle(in);

InputStream in = MyClass.class.getResourceAsStream("/config/app.properties");

InputStream in = MyClass.class.getClassLoader()
    .getResourceAsStream("config/app.properties");

InputStream in = ClassLoader.getSystemResourceAsStream("config/app.properties");

三、 關鍵區別：Class vs ClassLoader 路徑規則

// 假設類結構：com.demo.util.ConfigUtil
// 資源位置：src/main/resources/config/app.properties (編譯到 classes 根目錄)

ConfigUtil.class.getResourceAsStream("/config/app.properties")     // ✅ 根路徑
ConfigUtil.class.getResourceAsStream("config/app.properties")      // ❌ 找 com/demo/util/config/app.properties
ConfigUtil.class.getClassLoader().getResourceAsStream("config/app.properties") // ✅ 根路徑
ConfigUtil.class.getClassLoader().getResourceAsStream("/config/app.properties") // ❌ ClassLoader 不認 /

口訣：Class 帶 / 找根，不帶找包；ClassLoader 只認相對根路徑，禁帶 /。

四、 Servlet/Web 容器專屬最佳實踐

@WebListener
public class ConfigLoader implements ServletContextListener {
    private static final String CONFIG_PATH = "/WEB-INF/classes/config/app.properties";
    public static Properties PROPS = new Properties();

    @Override
    public void contextInitialized(ServletContextEvent sce) {
        try (InputStream in = sce.getServletContext().getResourceAsStream(CONFIG_PATH)) {
            if (in == null) throw new IllegalStateException("Config not found: " + CONFIG_PATH);
            PROPS.load(in);
        } catch (IOException e) {
            throw new ExceptionInInitializerError(e);
        }
    }
}

// 業務代碼直接用
String url = ConfigLoader.PROPS.getProperty("db.url");

優勢：
① 容器管理生命周期，啟動失敗快速暴露
② 支持 WAR 內部路徑、解壓目錄、JAR 內資源統一訪問
③ 避免類加載器層級差異導致的找不到資源

五、 生產級增強建議

1. 統一入口：封裝 ConfigService，內部按優先級嘗試：系統屬性 -Dconfig.file → 環境變量 → ServletContext → 類路徑默認值。
2. 熱加載：WatchService 監聽文件變更 + ReentrantReadWriteLock 保護 Properties 實例，或接入 Apollo/Nacos/Spring Cloud Config。
3. 類型安全：getInt()、getBoolean()、getDuration() 封裝轉換與默認值。
4. 敏感信息：密碼、Key 必須加密存儲，啟動時解密注入，絕不明文入 Properties 文件。

六、 總結選型表

掌握這 6 種標準姿勢與路徑規則，配置加載不再是「玄學」，而是可控、可測、可遷移的基礎設施能力。