Spring应用Jar包分发时，如何外置src/main/resources下的各类文件

以下是几种可行的实现方式，帮你把原本放在src/main/resources下的资源文件外置到Jar包外：

1. 配置Spring资源加载优先级 #

Spring默认支持配置资源加载顺序，你可以通过配置文件让外部目录的资源优先级高于classpath：

• 在application.properties（或application.yml）中添加：

  # 优先加载Jar同级的external-resources目录，再加载Jar内的classpath资源
  spring.resources.static-locations=file:./external-resources/,classpath:/
  

• 将需要外置的txt、json文件放到Jar包同级的external-resources目录下，Spring会自动优先读取这里的文件；外部文件不存在时，才会加载Jar内的对应资源。

2. 自定义文件读取逻辑 #

如果需要更灵活的控制逻辑，可以在代码中手动判断外部文件是否存在，优先读取外部资源：

import org.springframework.stereotype.Component;
import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.nio.charset.StandardCharsets;
import java.nio.file.Files;

@Component
public class ResourceFileReader {
    public String readResourceFile(String fileName) throws IOException {
        // 检查Jar包同级目录下的目标文件
        File externalFile = new File("./" + fileName);
        if (externalFile.exists() && externalFile.isFile()) {
            return Files.readString(externalFile.toPath(), StandardCharsets.UTF_8);
        }
        // 外部文件不存在时，读取classpath内的资源
        try (InputStream inputStream = getClass().getResourceAsStream("/" + fileName)) {
            assert inputStream != null;
            return new String(inputStream.readAllBytes(), StandardCharsets.UTF_8);
        }
    }
}

使用时直接注入该类，调用readResourceFile("data.txt")即可自动优先读取外部文件。

3. 通过启动参数指定外部资源路径 #

如果需要动态切换外部资源目录，可以在启动Jar时通过系统参数传递路径：

• 启动命令示例：

  java -jar your-spring-app.jar -Dresource.dir=./external-resources
  

• 在代码中读取该参数并构建文件路径：

  public String readExternalFile(String fileName) throws IOException {
      // 获取启动时指定的外部目录，默认值为Jar同级目录
      String resourceDir = System.getProperty("resource.dir", "./");
      File targetFile = new File(resourceDir + "/" + fileName);
      if (targetFile.exists()) {
          return Files.readString(targetFile.toPath());
      }
      // 外部无文件时， fallback到classpath资源
      try (InputStream is = getClass().getResourceAsStream("/" + fileName)) {
          return new String(is.readAllBytes(), StandardCharsets.UTF_8);
      }
  }
  

注意事项 #

• 若为前端依赖的静态资源，使用第一种spring.resources.static-locations配置最便捷；
• 若为业务逻辑中读取的业务文件，自定义读取逻辑或启动参数的方式更灵活；
• 确保外部目录具备读写权限，避免应用因权限问题无法读取文件。

内容的提问来源于stack exchange，提问作者Jack sopy