Java獲取/resources目錄下的資源文件方法
- 2022 年 10 月 31 日
- 筆記
- idea, springboot, 後端
Web項目開發中，經常會有一些靜態資源，被放置在resources目錄下，隨項目打包在一起，程式碼中要使用的時候，通過文件讀取的方式，載入並使用；
今天總結整理了九種方式獲取resources目錄下文件的方法。
其中公用的列印文件方法如下：
查看程式碼
/**
* 根據文件路徑讀取文件內容
*
* @param fileInPath
* @throws IOException
*/
public static void getFileContent(Object fileInPath) throws IOException {
BufferedReader br = null;
if (fileInPath == null) {
return;
}
if (fileInPath instanceof String) {
br = new BufferedReader(new FileReader(new File((String) fileInPath)));
} else if (fileInPath instanceof InputStream) {
br = new BufferedReader(new InputStreamReader((InputStream) fileInPath));
}
String line;
while ((line = br.readLine()) != null) {
System.out.println(line);
}
br.close();
}1、方法一 ：
主要核心方法是使用getResource和getPath方法，這裡的getResource(“”)裡面是空字元串
查看程式碼
public void function1(String fileName) throws IOException {
String path = this.getClass().getClassLoader().getResource("").getPath();//注意getResource("")裡面是空字元串
System.out.println(path);
String filePath = path + fileName;
System.out.println(filePath);
getFileContent(filePath);
}2、方法二：
主要核心方法是使用getResource和getPath方法，直接通過getResource(fileName)方法獲取文件路徑，注意如果是路徑中帶有中文一定要使用URLDecoder.decode解碼。
查看程式碼
/**
* 直接通過文件名getPath來獲取路徑
*
* @param fileName
* @throws IOException
*/
public void function2(String fileName) throws IOException {
String path = this.getClass().getClassLoader().getResource(fileName).getPath();//注意getResource("")裡面是空字元串
System.out.println(path);
String filePath = URLDecoder.decode(path, "UTF-8");//如果路徑中帶有中文會被URLEncoder,因此這裡需要解碼
System.out.println(filePath);
getFileContent(filePath);
}3、方法三：
直接通過文件名+getFile()來獲取文件。如果是文件路徑的話getFile和getPath效果是一樣的，如果是URL路徑的話getPath是帶有參數的路徑。如下所示：
url.getFile()=/admin/java/people.txt?id=5
url.getPath()=/admin/java/people.txt使用getFile()方式獲取文件的程式碼如下：
查看程式碼
/**
* 直接通過文件名+getFile()來獲取
*
* @param fileName
* @throws IOException
*/
public void function3(String fileName) throws IOException {
String path = this.getClass().getClassLoader().getResource(fileName).getFile();//注意getResource("")裡面是空字元串
System.out.println(path);
String filePath = URLDecoder.decode(path, "UTF-8");//如果路徑中帶有中文會被URLEncoder,因此這裡需要解碼
System.out.println(filePath);
getFileContent(filePath);
}4、方法四（★重要）：
直接使用getResourceAsStream方法獲取流，上面的幾種方式都需要獲取文件路徑，但是在SpringBoot中所有文件都在jar包中，沒有一個實際的路徑，因此可以使用以下方式。
查看程式碼
/**
* 直接通過文件名+getFile()來獲取
*
* @param fileName
* @throws IOException
*/
public void function4(String fileName) throws IOException {
String path = this.getClass().getClassLoader().getResource(fileName).getFile();//注意getResource("")裡面是空字元串
System.out.println(path);
String filePath = URLDecoder.decode(path, "UTF-8");//如果路徑中帶有中文會被URLEncoder,因此這裡需要解碼
System.out.println(filePath);
getFileContent(filePath);
}5、方法五（★重要）：
主要也是使用getResourceAsStream方法獲取流，不使用getClassLoader可以使用getResourceAsStream(“/people.txt”)直接從resources根路徑下獲取，SpringBoot中所有文件都在jar包中，沒有一個實際的路徑，因此可以使用以下方式。
查看程式碼
/**
* 直接使用getResourceAsStream方法獲取流
* 如果不使用getClassLoader，可以使用getResourceAsStream("/people.txt")直接從resources根路徑下獲取
*
* @param fileName
* @throws IOException
*/
public void function5(String fileName) throws IOException {
InputStream in = this.getClass().getResourceAsStream("/" + fileName);
getFileContent(in);
}6、方法六（★重要）：
通過ClassPathResource類獲取文件流，SpringBoot中所有文件都在jar包中，沒有一個實際的路徑，因此可以使用以下方式。
查看程式碼
/**
* 通過ClassPathResource類獲取，建議SpringBoot中使用
* springboot項目中需要使用此種方法，因為jar包中沒有一個實際的路徑存放文件
*
* @param fileName
* @throws IOException
*/
public void function6(String fileName) throws IOException {
ClassPathResource classPathResource = new ClassPathResource(fileName);
InputStream inputStream = classPathResource.getInputStream();
getFileContent(inputStream);
}7、方法七：
通過絕對路徑獲取項目中文件的位置，只是本地絕對路徑，不能用於伺服器獲取。
查看程式碼
/**
* 通過絕對路徑獲取項目中文件的位置（不能用於伺服器）
* @param fileName
* @throws IOException
*/
public void function7(String fileName) throws IOException {
String rootPath = System.getProperty("user.dir");//D:\\java\\git\\springBoot-test
String filePath = rootPath + "\\springmvc-test\\src\\main\\resources\\" + fileName;
getFileContent(filePath);
}8、方法八：
通過new File(“”)獲取當前的絕對路徑，只是本地絕對路徑，不能用於伺服器獲取。
查看程式碼
/**
* 通過絕對路徑獲取項目中文件的位置（不能用於伺服器）
* @param fileName
* @throws IOException
*/
public void function8(String fileName) throws IOException {
//參數為空
File directory = new File("");
//規範路徑：getCanonicalPath() 方法返回絕對路徑，會把 ..\ 、.\ 這樣的符號解析掉
String rootCanonicalPath = directory.getCanonicalPath();
//絕對路徑：getAbsolutePath() 方法返迴文件的絕對路徑，如果構造的時候是全路徑就直接返回全路徑，如果構造時是相對路徑，就返回當前目錄的路徑 + 構造 File 對象時的路徑
String rootAbsolutePath =directory.getAbsolutePath();
System.out.println(rootCanonicalPath);
System.out.println(rootAbsolutePath);
String filePath = rootCanonicalPath + "\\java\\src\\main\\resources\\"+fileName;
getFileContent(filePath);
}
9、方法九：
主要是通過設置環境變數，將文件放在環境變數中，原理也是通過絕對路徑獲取。
示例中我設置了一個環境變數：TEST_ROOT = D:\\java\\git\\springBoot-test
System.getenv("TEST_ROOT");
System.getProperty("TEST_ROOT")通過設置環境變數的方式，然後通過絕對路徑獲取文件
查看程式碼
/**
* 通過絕對路徑獲取項目中文件的位置
*
* @param fileName
* @throws IOException
*/
public void function9(String fileName) throws IOException {
System.setProperty("TEST_ROOT","D:\\java\\git\\springBoot-test");
//參數為空
String rootPath = System.getProperty("TEST_ROOT");
System.out.println(rootPath);
String filePath = rootPath + "\\springmvc-test\\src\\main\\resources\\" + fileName;
getFileContent(filePath);
}
