Spring 讀取配置檔案完整指南：PropertiesFactoryBean、Resource 抽象與最佳實踐

前言

Spring 提供了多層次的資源讀取抽象：從底層 org.springframework.core.io.Resource 介面，到 PropertySource 機制、@Value 注入、@ConfigurationProperties 綁定，再到 Environment 統一存取。本文梳理三種常見場景的實作方式，並說明現代 Spring Boot 專案的推薦做法。

場景一：傳統 XML 註冊 PropertiesFactoryBean

適用於純 Spring XML 配置專案，將 .properties 暴露為 java.util.Properties Bean：

XML 配置

<bean id="configProperties" 
      class="org.springframework.beans.factory.config.PropertiesFactoryBean">
    <property name="location" value="classpath:jdbc.properties"/>
</bean>

Java 程式碼取得

ApplicationContext ctx = new ClassPathXmlApplicationContext("applicationContext-datasource.xml");
Properties props = (Properties) ctx.getBean("configProperties");
String driver = props.getProperty("jdbcOrcale.driverClassName");

場景二：Resource 介面直接讀取（低層 API）

Resource 是 Spring 統一資源抽象（classpath、file、URL、ServletContext 等），適用於需讀取非 Properties 格式（如 JSON、XML、純文字）的場景。

方式 A：程式碼中直接取得 Resource

public void readDirectly() throws IOException {
    Resource resource = applicationContext.getResource("classpath:com/springdemo/resource/test.txt");
    File file = resource.getFile(); // 僅當 resource 為 FileSystemResource 時可用
    
    try (FileInputStream fis = new FileInputStream(file)) {
        byte[] buffer = new byte[(int) file.length()];
        fis.read(buffer);
        String content = new String(buffer, StandardCharsets.UTF_8);
        System.out.println(content);
    }
}

方式 B：注入 Resource 欄位（推薦）

public class ResourceBean {
    private Resource resource;
    // getter/setter
}

<bean id="resourceBean" class="com.springdemo.resource.ResourceBean">
    <property name="resource" value="classpath:/com/springdemo/resource/test.txt"/>
</bean>

場景三：現代 Spring Boot 推薦做法（重點）

Spring Boot 2.0+ 強烈建議使用 @ConfigurationProperties 類型安全綁定，而非手動讀取 Properties。

1. 配置檔 application.yml

jdbc:
  oracle:
    driver-class-name: oracle.jdbc.OracleDriver
    url: jdbc:oracle:thin:@localhost:1521:orcl
    username: scott
    password: tiger

2. 綁定類別

@ConfigurationProperties(prefix = "jdbc.oracle")
@Data // Lombok
public class OracleJdbcProperties {
    private String driverClassName;
    private String url;
    private String username;
    private String password;
}

3. 啟用配置綁定

@Configuration
@EnableConfigurationProperties(OracleJdbcProperties.class)
public class JdbcConfig {
    // 也可用 @Bean 方法註冊 DataSource
}

4. 使用注入

@Service
public class DataService {
    private final OracleJdbcProperties props;

    public DataService(OracleJdbcProperties props) {
        this.props = props;
    }

    public void printConfig() {
        System.out.println("URL: " + props.getUrl());
    }
}

核心抽象對比表

進階技巧

1. 多環境配置隔離

# application-dev.yml
jdbc.oracle.url: jdbc:oracle:thin:@dev-db:1521:orcl

# application-prod.yml
jdbc.oracle.url: jdbc:oracle:thin:@prod-db:1521:orcl

啟動時指定 --spring.profiles.active=prod，Spring 自動合併覆蓋。

2. 配置驗證（JSR-303）

@ConfigurationProperties(prefix = "jdbc.oracle")
@Validated
public class OracleJdbcProperties {
    @NotBlank
    private String url;
    
    @Pattern(regexp = "^jdbc:oracle:thin:@.+")
    private String url; // 進一步格式驗證
}

3. 動態刷新（Spring Cloud Config / Actuator）

@RefreshScope
@ConfigurationProperties(prefix = "jdbc.oracle")
public class OracleJdbcProperties { ... }

配合 POST /actuator/refresh 實現不重啟更新配置。

4. 避免硬編碼路徑：使用 @Value 搭配 SpEL

@Value("classpath:${config.file.path:default-config.json}")
private Resource configResource;

常見錯誤與避坑

• resource.getFile() 拋出 FileNotFoundException：classpath 資源打包在 JAR 內時無法轉為 File，請改用 resource.getInputStream()。
• PropertiesFactoryBean 回傳的 Properties 若為 null：檢查 location 路徑是否正確、檔案是否在 classpath 根目錄。
• 同時使用 @PropertySource 與 @ConfigurationProperties 導致重複綁定：Boot 2.4+ 已整合，建議僅用 @ConfigurationProperties。
• 敏感資訊（密碼、金鑰）明文寫在配置檔：請使用 Spring Cloud Vault、AWS Secrets Manager 或環境變數注入。

總結

Spring 讀取配置的演進路徑：

1. XML + PropertiesFactoryBean → 傳統專案維護用
2. Resource API → 非標準格式、流式讀取
3. @ConfigurationProperties → 現代 Spring Boot 專案標準做法

新專案請直接從第 3 種開始，享受類型安全、IDE 智慧提示、驗證與動態刷新的完整體驗。