SpringBoot项目中读取resource目录下的文件（六种方法）

在Spring Boot项目中，读取resources目录下的文件是一个常见的需求。接下来，我们将介绍六种不同的方法来实现这一功能，并为每种方法提供代码示例。

方法一：使用ClassPathResource

ClassPathResource是Spring框架提供的一个用于加载classpath下资源的类。可以通过该类轻松读取资源文件。

import org.springframework.core.io.ClassPathResource;
import org.springframework.core.io.Resource;

import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStreamReader;

public class ResourceLoaderExample {
    public void loadUsingClassPathResource() throws IOException {
        Resource resource = new ClassPathResource("data.txt"); // 假设data.txt位于resources根目录
        try (BufferedReader reader = new BufferedReader(new InputStreamReader(resource.getInputStream()))) {
            String line;
            while ((line = reader.readLine()) != null) {
                System.out.println(line);
            }
        }
    }
}

方法二：使用@Value注解

Spring提供了@Value注解，可以将资源文件中的内容直接注入到变量中。这种方法适合用于读取小型配置或文本内容。

import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;

@Component
public class ValueInjectionExample {
    @Value("classpath:data.txt")
    private Resource resource;

    public void printResourceContent() throws IOException {
        try (BufferedReader reader = new BufferedReader(new InputStreamReader(resource.getInputStream()))) {
            String line;
            while ((line = reader.readLine()) != null) {
                System.out.println(line);
            }
        }
    }
}

方法三：使用InputStream直接读取

通过InputStream可以直接读取资源文件，适用于一些较大的文件或不需要整行读取的场景。

import org.springframework.core.io.ClassPathResource;

import java.io.IOException;
import java.io.InputStream;

public class InputStreamExample {
    public void loadUsingInputStream() throws IOException {
        ClassPathResource resource = new ClassPathResource("data.txt");
        try (InputStream inputStream = resource.getInputStream()) {
            int data = inputStream.read();
            while (data != -1) {
                System.out.print((char) data);
                data = inputStream.read();
            }
        }
    }
}

方法四：使用ResourceLoader

ResourceLoader是Spring提供的，能够根据路径加载各种类型的资源。可以注入ResourceLoader并使用它加载资源。

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.CommandLineRunner;
import org.springframework.core.io.Resource;
import org.springframework.core.io.ResourceLoader;
import org.springframework.stereotype.Component;

import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStreamReader;

@Component
public class ResourceLoaderExample implements CommandLineRunner {
    @Autowired
    private ResourceLoader resourceLoader;

    @Override
    public void run(String... args) throws IOException {
        Resource resource = resourceLoader.getResource("classpath:data.txt");
        try (BufferedReader reader = new BufferedReader(new InputStreamReader(resource.getInputStream()))) {
            String line;
            while ((line = reader.readLine()) != null) {
                System.out.println(line);
            }
        }
    }
}

方法五：使用File读取

如果项目的打包方式是JAR文件，那么直接读取文件的方式会有所不同。这种方式不推荐在生产环境中使用，因为或许会导致文件找不到。

import java.io.File;
import java.io.IOException;
import java.nio.file.Files;

public class FileExample {
    public void loadUsingFile() throws IOException {
        File file = new File("src/main/resources/data.txt");
        Files.lines(file.toPath()).forEach(System.out::println);
    }
}

方法六：使用Spring Boot的@ConfigurationProperties

如果需要读取配置文件中的配置信息，使用@ConfigurationProperties是一个好选择，能将配置映射为Java对象。

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;

import java.util.List;

@Component
@ConfigurationProperties(prefix = "my")
public class MyConfig {
    private List<String> data;

    public List<String> getData() {
        return data;
    }

    public void setData(List<String> data) {
        this.data = data;
    }
}

在application.yml或application.properties中，你可以配置：

my:
  data:
    - value1
    - value2

总结

以上六种方法展示了在Spring Boot项目中读取资源目录下文件的不同方式。选择合适的方法通常依赖于具体需求，比如文件类型、大小及如何使用读取到的数据。在开发中合理利用这些方法，有助于提高程序的灵活性和可维护性。