SpringBoot中讀取jar包中的resources目錄下的文件的三種方式

更新時間：2023年06月26日 11:26:19 作者：sco5282

這篇文章給大家總結(jié)了SpringBoot讀取 jar 包中的 resources 目錄下的文件的三種方式，文中有詳細的代碼示例供大家參考，,需要的朋友可以參考下

讀取 resources 目錄下的文件路徑時，需要注意一點：在本地開發(fā)時，我們是能夠通過代碼獲取到這個文件的絕對路徑的（如：在 c 盤下或者 d 盤下的）；但部署后，項目是通過打成 jar 包運行的，里面的文件是沒有實際路徑的（只有相對于項目名的相對路徑）。

因為最后肯定是打包部署的，所以掌握針對后者的這種方式來讀取文件是很有必要的。

代碼圖如下：

方式一：(重要)

通過 T.class.getClassLoader().getResourceAsStream() 方法。如：我要讀取 config 文件夾下的 test.properties 文件：

這是一個公共方法，用來讀取文件中的內(nèi)容的方法，下面就不再重復了：

public static void printFileContent(Object obj) throws IOException {
    if (null == obj) {
        throw new RuntimeException("參數(shù)為空");
    }
    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 class ResourceUtil {
    public void getResource(String fileName) throws IOException{
        InputStream in = this.getClass().getClassLoader().getResourceAsStream(fileName);
        printFileContent(in);
    }
    public static void main(String[] args) throws IOException {
        new ResourceUtil().getResource("config/test.properties");
    }
}

即使是一個 jar 包，也依舊能讀取到。

此方法默認是從 classpath 路徑（即：src 或 resources 路徑下）下查找文件的，所以，路徑前不需要加 “/”。

方式二：(重要)

通過 T.class..getResourceAsStream() 方法。

public void getResource2(String fileName) throws IOException{
    InputStream in = this.getClass().getResourceAsStream("/" + fileName);
    printFileContent(in);
}
public static void main(String[] args) throws IOException {
    new ResourceUtil().getResource2("config/test.properties");
}

方法默認也是從 classpath 路徑（即：src 或 resources 路徑下）下查找文件的，但它的路徑前為什么需要加 “/” 呢？

這個是跟要讀取的文件與當前.class 文件的位置有關。

看看編譯后的文件路徑：

當前文件 ResourceUtil.class 與要加載的文件 test.properties 的位置如上：
很顯然 test.properties 和 ResourceUtil.class 不在同一個文件夾下。

那讀取的時候是要帶上相對路徑的，那么，這會有兩種情況：

相對于當前類 ResourceUtil，路徑前是不需要加 “/”
相對于項目名（即：編譯后的 classes 文件夾），路徑前是需要加 “/”

舉例：

如果 test.properties 和 ResourceUtil 在同一個文件夾下，那么：this.getClass().getResourceAsStream(“test.properties”)
如果 test.properties 和 ResourceUtil 不在同一個文件夾下，那么：this.getClass().getResourceAsStream(“/config/test.properties”)

如果測試，不要在源文件下添加配置文件，因為編譯后，在相應的路徑下看不見此配置文件?？梢允褂?Test.java 代替。

即使是一個 jar 包，也依舊能讀取到。

方式三：(重要)

通過 ClassPathResource 方法：

public void getResource3(String fileName) throws IOException{
    ClassPathResource classPathResource = new ClassPathResource(fileName);
    printFileContent(classPathResource.getInputStream());
}
public static void main(String[] args) throws IOException {
    new ResourceUtil().getResource3("config/test.properties");
}

path 前加不加 “/” 無所謂。

即使是一個 jar 包，也依舊能讀取到。

到此這篇關于SpringBoot中讀取jar包中的resources目錄下的文件的三種方式的文章就介紹到這了,更多相關SpringBoot讀取resources文件內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: