Springboot使用ResourceUtils.getFile()读取resource下文件的坑

  1. 先说结论,使用ResourceUtils.getFile()方法读取resource下文件,在IDEA等开发工具场景下是没问题的,但是将服务达成jar包后,执行该方法就会包错文件找不到;
    因此尽量不要使用该方法来读取文件,可以使用以下几种方式替代:
ClassPathResource classPathResource = new ClassPathResource("excleTemplate/test.txt");
InputStream inputStream =classPathResource.getInputStream();
InputStream inputStream = Thread.currentThread().getContextClassLoader().getResourceAsStream("excleTemplate/test.txt");
InputStream inputStream = this.getClass().getResourceAsStream("/excleTemplate/test.txt");
  1. 为何在jar包中ResourceUtils.getFile()会报错?
    跟踪getFile()源码,找到报错的地方:
  2. image.png

看下URL_PROTOCOL_FILE是什么

image.png

由上可知URL_PROTOCOL_FILE 只的是URL的协议是 “file”,常见的URL协议有以下几种:

image.png

需要的是file类型但是获取得到的是jar类型,所以这里会直接抛出文件未找到异常

### Spring Boot 读取 Resources 文件夹相对路径的方法 在 Spring Boot 中,`resources` 目录通常用于存储应用程序所需的静态资源文件。为了正确读取 `resources` 下的文件并处理其相对路径,有多种方法可供选择。 #### 使用 ResourceUtils 获取 Classpath 资源 一种常见的方式是利用 `ResourceUtils` 类来访问位于 classpath 上的资源。此工具类提供了便捷的方法以获取文件对象: ```java import org.springframework.util.ResourceUtils; import java.io.File; public void readClassPathFile() { try { // 将 "classpath:" 前缀与目标文件名组合起来定位资源位置 File file = ResourceUtils.getFile("classpath:config/settings.properties"); // 进一步对文件进行操作... } catch (Exception e) { System.out.println(e.getMessage()); } } ``` 这种方法适用于大多数场景,在开发环境以及打包后的 jar/war 文件内部均能正常运作[^4]。 #### 利用 @Value 注解读取配置项定义的路径 当需要动态加载不同环境下可能变化的文件时,可以在 application.yml 或 .properties 文件内预先设定占位符变量,并借助于 `@Value` 注解注入这些值至 Java Bean 属性中: ```yaml app: configDir: /data/config/ ``` ```java @Component public class ConfigLoader { private final String configDirectory; public ConfigLoader(@Value("${app.configDir}") String dir){ this.configDirectory = dir; } public void loadConfigFiles(){ Path path = Paths.get(configDirectory); if (!Files.exists(path)){ throw new RuntimeException("Configuration directory does not exist."); } // 执行更多逻辑... } } ``` 对于此类情况,如果希望基于项目的根目录构建相对路径,则应确保所给定的基础路径字符串能够被解释为相对于当前工作目录的位置[^2]。 #### 自动创建不存在的目标文件夹 有时业务需求可能会涉及到按需建立某些特定结构的数据存储空间。此时可以通过如下代码片段实现自动检测并初始化必要的子目录: ```java import org.springframework.util.ResourceUtils; import java.nio.file.Files; import java.nio.file.Path; public static void ensureDirectoryExists(String locationPropertyKey) throws Exception{ File targetFolder = new File(ResourceUtils.getURL(locationPropertyKey).getPath()); if(!targetFolder.exists()){ Files.createDirectories(targetFolder.toPath()); } } ``` 上述函数会尝试依据传入的关键字参数解析出对应的 URL 表达形式,并据此判断相应物理地址是否存在;一旦发现缺失即刻完成新建动作[^5]。
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值