この記事の要点
Spring で外部ファイルを読み込む 5 つの方法 ResourceLoader: classpath: / file: / http:// 等プレフィックス対応 @Value("classpath:config.json"): Resource 型に注入 ResourceUtils.getFile(): java.io.File として取得 ClassPathResource: classpath: 専用クラス 本番では jar 内ファイルは getInputStream() 経由が安全（getFile() は jar 内で動かない）

 

file: / classpath: プレフィックス

プレフィックス	用途	例
classpath:	クラスパス (jar 内含む)	classpath:config/app.json
classpath*:	複数 jar から検索	classpath*:META-INF/spring.factories
file:	ファイルシステム	file:/etc/myapp/config.json
http:// / https://	リモート URL	https://example.com/config.json
url:	generic URL	url:ftp://...
プレフィックスなし	相対パス（カレントディレクトリ）	config/app.json

方法 1: @Value で Resource 注入

@Service
public class ConfigService {

    @Value("classpath:config/app.json")
    private Resource configResource;

    @Value("file:/etc/myapp/secret.key")
    private Resource secretResource;

    public String readConfig() throws IOException {
        try (InputStream is = configResource.getInputStream();
             BufferedReader reader = new BufferedReader(new InputStreamReader(is, StandardCharsets.UTF_8))) {
            return reader.lines().collect(Collectors.joining("\n"));
        }
    }
}

方法 2: ResourceLoader 注入

@Service
public class FileService {

    @Autowired
    private ResourceLoader resourceLoader;

    public String loadFile(String path) throws IOException {
        Resource resource = resourceLoader.getResource(path);
        // path: "classpath:config/app.json"
        //       "file:/etc/myapp/data.txt"
        //       "https://example.com/data.json"

        try (InputStream is = resource.getInputStream()) {
            return new String(is.readAllBytes(), StandardCharsets.UTF_8);
        }
    }
}

方法 3: ClassPathResource 直接

// classpath: のみ
ClassPathResource resource = new ClassPathResource("config/app.json");

try (InputStream is = resource.getInputStream()) {
    ObjectMapper mapper = new ObjectMapper();
    AppConfig config = mapper.readValue(is, AppConfig.class);
}

// Path 指定 (Spring Boot 標準の resources/ フォルダ基準)
ClassPathResource resource = new ClassPathResource("/templates/email.html");

方法 4: ResourceUtils.getFile()

// java.io.File として取得 (開発時のみ動く、jar 内では NG)
try {
    File file = ResourceUtils.getFile("classpath:config/app.json");
    String content = Files.readString(file.toPath());
} catch (FileNotFoundException e) {
    // jar 内では FileNotFoundException
    // → 本番では getInputStream() 推奨
}

// 安全な書き方
Resource resource = new ClassPathResource("config/app.json");
String content;
try (InputStream is = resource.getInputStream()) {
    content = new String(is.readAllBytes(), StandardCharsets.UTF_8);
}

方法 5: PropertyPlaceholderConfigurer / @PropertySource

@Configuration
@PropertySource("classpath:custom.properties")
@PropertySource(value = "file:${EXTERNAL_CONFIG:/etc/myapp/config.properties}",
                ignoreResourceNotFound = true)
public class AppConfig { }

方法 6: spring.config.import (Spring Boot 2.4+)

# application.yml
spring:
  config:
    import:
      - classpath:custom.properties
      - file:/etc/myapp/override.yml
      - optional:configserver:http://config-server
      - vault://

用途別の選び方

用途	推奨
プロパティ設定読込	application.properties + @Value
テンプレート / 静的ファイル	@Value("classpath:templates/...")
外部設定ファイル（環境別）	spring.config.import
暗号化された秘密情報	Vault / AWS Secrets Manager
大きなデータファイル	file: + StreamingResponseBody

InputStream vs File

// ✅ jar 内・ファイルシステム両方 OK
Resource resource = new ClassPathResource("config/app.json");
try (InputStream is = resource.getInputStream()) {
    // 処理
}

// ❌ jar 内では動かない (FileNotFoundException)
File file = ResourceUtils.getFile("classpath:config/app.json");

// 一時ファイルに展開する例
Resource resource = new ClassPathResource("template.docx");
Path tempFile = Files.createTempFile("template", ".docx");
try (InputStream is = resource.getInputStream()) {
    Files.copy(is, tempFile, StandardCopyOption.REPLACE_EXISTING);
}
// tempFile に対して通常の File API が使える

具体例: テンプレートファイル読込

// resources/templates/email_welcome.html を読む
@Service
public class EmailService {

    @Value("classpath:templates/email_welcome.html")
    private Resource welcomeTemplate;

    public String renderWelcomeEmail(String userName) throws IOException {
        try (InputStream is = welcomeTemplate.getInputStream()) {
            String template = new String(is.readAllBytes(), StandardCharsets.UTF_8);
            return template.replace("{{name}}", userName);
        }
    }
}

具体例: 外部 JSON 設定

// 開発: classpath、本番: 外部ファイル
@Configuration
public class ExternalConfig {

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

    @Bean
    public AppSettings appSettings() throws IOException {
        try (InputStream is = configResource.getInputStream()) {
            return new ObjectMapper().readValue(is, AppSettings.class);
        }
    }
}

# application.properties
myapp.config.path=file:/etc/myapp/production.json
# または環境変数: MYAPP_CONFIG_PATH=...

テスト時の差し替え

@SpringBootTest
@TestPropertySource(properties = "myapp.config.path=classpath:config/test.json")
class MyServiceTest { ... }

// または application-test.yml
myapp:
  config:
    path: classpath:config/test.json

関連記事

• @PropertySource
• @Value
• @Configuration