SpringBoot读取Resource下文件

一、前言
有时在项目中，涉及一些导入的功能，那么需要提供一些模板下载，那么就需要读取模板，而模板放在resource下，那么可以通过多种方式读取文件。

二、实现方式
1.通过 T.class.getClassLoader().getResourceAsStream() 方法，获取流。
读取方法：

public class ResourceUtils {

    public void getResourceFile(String fileName) throws IOException{
        InputStream in = this.getClass().getClassLoader().getResourceAsStream(fileName);
        readFileContent(in);
    }
	 public void readFileContent(Object obj) throws IOException {
        if (null == obj) {
            throw new RuntimeException("参数为空");
        }
        BufferedReader reader = null;
        // 如果是文件路径
        if (obj instanceof String) {
            reader = new BufferedReader(new FileReader(new File((String) obj)));
            // 如果是文件输入流
        } else if (obj instanceof InputStream) {
            reader = new BufferedReader(new InputStreamReader((InputStream) obj));
        }
        String line = null;
        while ((line = reader.readLine()) != null) {
            System.out.println(line);
        }
        reader.close();
    }

    public static void main(String[] args) throws IOException {
        new ResourceUtils().getResourceFile("template/test.txt");
    }

}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31

2.第二种：通过 T.class…getResourceAsStream() 方法。

public void getResourceTwo(String fileName) throws IOException{
    InputStream in = this.getClass().getResourceAsStream("/" + fileName);
    readFileContent(in);
}

public static void main(String[] args) throws IOException {
    new ResourceUtils().getResourceTwo("template/test.txt");
}

1
2
3
4
5
6
7
8
9

此方法默认是从 classpath 路径（即：src 或 resources 路径下）下查找文件的，但它的路径前需要加 “/” 。
这个是跟要读取的文件与当前.class 文件的位置有关。
相对于当前类 ResourceUtils，路径前是不需要加 “/”
相对于项目名（即：编译后的 classes 文件夹），路径前是需要加 “/”。

3.第三种：通过 ClassPathResource 方法。

public void getResourceThree(String fileName) throws IOException{
    ClassPathResource classPathResource = new ClassPathResource(fileName);
    readFileContent(classPathResource.getInputStream());
}

public static void main(String[] args) throws IOException {
    new ResourceUtils().getResourceThree("template/test.txt");
}

1
2
3
4
5
6
7
8
9

这种方式path 前加不加 “/” 无所谓。

4.第四种：使用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 MyResource {
    
    private final ResourceLoader resourceLoader;
    
    public MyResource(ResourceLoader resourceLoader) {
        this.resourceLoader = resourceLoader;
    }
    
    public void getResourceFile() throws IOException {
        Resource resource = resourceLoader.getResource("classpath:my-file.txt");
        InputStream inputStream = resource.getInputStream();
        // 对文件进行操作，比如读取内容等
        readFileContent(in);
    }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

以上是常见的读取方式。