Spring Boot获取resources目录下的文件的三种方式

忘是亡心i 2023-10-12 08:23 68阅读 0赞

在Spring Boot项目中，经常需要获取`resources`目录下的文件。这些文件可以包括配置文件、模板文件、静态资源等。本文将介绍三种常用的方法来获取`resources`目录下的文件。

### 1. 使用`ResourceLoader`接口 ###

`ResourceLoader`接口是Spring框架提供的用于加载各种资源的接口，包括`classpath`下的资源。在Spring Boot中，可以通过依赖注入`ResourceLoader`接口来获取`resources`目录下的文件。以下是一个示例：

import org.springframework.core.io.Resource;
    import org.springframework.core.io.ResourceLoader;
    import org.springframework.stereotype.Component;
    
    @Component
    public class YourComponent {
        
        
        private final ResourceLoader resourceLoader;
        
        public YourComponent(ResourceLoader resourceLoader) {
        
            this.resourceLoader = resourceLoader;
        }
        
        public void getResource() throws IOException {
        
            Resource resource = resourceLoader.getResource("classpath:your-file.txt");
            InputStream inputStream = resource.getInputStream();
            // 对文件进行操作，比如读取内容等
        }
    }

在上述代码中，我们通过构造函数注入了`ResourceLoader`接口的实例。然后，使用`resourceLoader.getResource("classpath:your-file.txt")`方法获取`your-file.txt`文件的`Resource`对象。通过`Resource`对象，我们可以获取文件的输入流并对其进行操作。

### 2. 使用`ClassPathResource`类 ###

`ClassPathResource`类是Spring框架提供的用于加载类路径下资源的类。在Spring Boot中，我们可以使用`ClassPathResource`类来获取`resources`目录下的文件。以下是一个示例：

import org.springframework.core.io.ClassPathResource;
    
    public void getResource() throws IOException {
        
        ClassPathResource resource = new ClassPathResource("your-file.txt");
        InputStream inputStream = resource.getInputStream();
        // 对文件进行操作，比如读取内容等
    }

在上述代码中，我们使用`ClassPathResource`类来获取`your-file.txt`文件。它会直接从类路径下查找文件，并返回一个`Resource`对象。

### 3. 使用`ResourceUtils.getFile()`方法 ###

`ResourceUtils`类是Spring框架提供的用于操作资源的实用工具类。在Spring Boot中，我们可以使用`ResourceUtils.getFile()`方法来获取`resources`目录下的文件。以下是一个示例：

import org.springframework.util.ResourceUtils;
    
    public void getResource() throws IOException {
        
        File file = ResourceUtils.getFile("classpath:your-file.txt");
        // 对文件进行操作，比如读取内容等
    }

在上述代码中，我们使用`ResourceUtils.getFile()`方法来获取`your-file.txt`文件。它会返回一个`File`对象，可以直接对文件进行操作。

### 4. 注意事项 ###

在使用上述方法获取`resources`目录下的文件时，请注意以下事项：

*  确保文件路径和名称正确，以及文件位于`resources`目录下。
 *  如果使用\`ResourceLoader