9 種方式
- 使用 ClassLoader.getResourceAsStream() 方法
可以使用類加載器來擷取資源檔案的輸入流。該方法接受一個資源檔案路徑參數,傳回一個 InputStream 對象。
InputStream inputStream = getClass().getClassLoader().getResourceAsStream("file.txt");
注意,該方法傳回的資源檔案路徑是相對于類加載器的根路徑。是以,對于 resources 目錄下的檔案,需要在檔案名前加上 "classpath:" 字首。例如: "classpath:file.txt"。
- 使用 Class.getResourceAsStream() 方法
可以使用 Class 類的 getResourceAsStream() 方法來讀取資源檔案。該方法接受一個資源檔案路徑參數,傳回一個 InputStream 對象。
InputStream inputStream = getClass().getResourceAsStream("/file.txt");
該方法傳回的資源檔案路徑是相對于目前類的路徑。是以,對于 resources 目錄下的檔案,需要在檔案名前加上 "/" 字首。例如: "/file.txt"。
- 使用 ResourceLoader 加載檔案
可以使用 Spring 的 ResourceLoader 接口來加載資源檔案。ResourceLoader 接口有一個 getResource() 方法,接受一個資源檔案路徑參數,傳回一個 Resource 對象。
Resource resource = resourceLoader.getResource("classpath:file.txt");
InputStream inputStream = resource.getInputStream();
需要注意的是,需要在類中注入 ResourceLoader 對象,并在方法中使用。例如:
@Autowired
private ResourceLoader resourceLoader;
public void readResourceFile() throws IOException {
Resource resource = resourceLoader.getResource("classpath:file.txt");
InputStream inputStream = resource.getInputStream();
}
- 使用 ResourceUtils 加載檔案
ResourceUtils 是 Spring 提供的一個工具類,用于加載資源檔案。可以使用 ResourceUtils.getFile() 方法來擷取檔案對象。
File file = ResourceUtils.getFile("classpath:file.txt");
需要注意的是,該方法隻适用于本地檔案系統和 JAR 檔案。對于 WAR 檔案或者其他類型的檔案,該方法可能無法正常工作。
- 使用 ApplicationContext 加載檔案
可以使用 ApplicationContext 的 getResource() 方法來加載資源檔案。該方法接受一個資源檔案路徑參數,傳回一個 Resource 對象。
Resource resource = applicationContext.getResource("classpath:file.txt");
InputStream inputStream = resource.getInputStream();
需要注意的是,需要在類中注入 ApplicationContext 對象,并在方法中使用。例如:
@Autowired
private ApplicationContext applicationContext;
public void readResourceFile() throws IOException {
Resource resource = applicationContext.getResource("classpath:file.txt");
InputStream inputStream = resource.getInputStream();
}
- 使用 ServletContext 加載檔案
可以使用 ServletContext 的 getResourceAsStream() 方法來讀取資源檔案。該方法接受一個資源檔案路徑參數,傳回一個 InputStream 對象。
InputStream inputStream = servletContext.getResourceAsStream("/WEB-INF/classes/file.txt");
需要注意的是,需要在類中注入 ServletContext 對象,并在方法中使用。例如:
@Autowired
private ServletContext servletContext;
public void readResourceFile() throws IOException {
InputStream inputStream = servletContext.getResourceAsStream("/WEB-INF/classes/file.txt");
}
- 使用 File System 加載檔案
可以使用 File 類來讀取資源檔案。需要提供完整的檔案路徑。
File file = new File("src/main/resources/file.txt");
InputStream inputStream = new FileInputStream(file);
需要注意的是,使用該方法需要提供完整的檔案路徑,是以需要知道檔案所在的絕對路徑。
- 使用 Paths 和 Files 加載檔案
可以使用 Java NIO 中的 Paths 和 Files 類來讀取資源檔案。該方法需要提供完整的檔案路徑。
Path path = Paths.get("src/main/resources/file.txt");
InputStream inputStream = Files.newInputStream(path);
需要注意的是,使用該方法需要提供完整的檔案路徑,是以需要知道檔案所在的絕對路徑。
- 使用 ClassPathResource 加載檔案
可以使用 Spring 提供的 ClassPathResource 類來讀取資源檔案。該方法需要提供資源檔案的相對路徑。
ClassPathResource resource = new ClassPathResource("file.txt");
InputStream inputStream = resource.getInputStream();
需要注意的是,ClassPathResource 會在類路徑下查找資源檔案,是以不需要提供完整的檔案路徑。
以上 9 種方式,都可以用來讀取 Spring Boot 項目中 resources 目錄下的檔案。不同的方法适用于不同的場景,可以根據需要選擇合适的方法。
實際開發中推薦
推薦使用以下幾種方法:
- 使用 ClassLoader.getResourceAsStream() 方法
這是一種通用的方式,可以适用于大多數情況。
- 使用 ResourceLoader 加載檔案
如果使用 Spring 架構,可以使用 ResourceLoader 接口來加載資源檔案。這種方式适用于大多數 Spring Boot 項目。
- 使用 ClassPathResource 加載檔案
如果隻需要讀取 resources 目錄下的檔案,可以使用 Spring 提供的 ClassPathResource 類來加載檔案。這種方式比較簡單,不需要提供完整的檔案路徑。
需要注意的是,使用不同的方式需要了解其适用的場景和使用方法。對于不同的項目和需求,可能需要選擇不同的方式。