SpringBoot如何讀取war包jar包和Resource資源
這篇文章主要介紹了SpringBoot如何讀取war包jar包和Resource資源,文中通過示例程式碼介紹的非常詳細,對大家的學習或者工作具有一定的參考學習價值,需要的朋友可以參考下
場景描述
在開發過程中我們經常會碰到要在程式碼中獲取資原始檔的情況,而我在最近在SpringBoot專案中時碰到一個問題,就是在本地執行時,獲取本地的xml資原始檔是能夠獲取到的,但是專案打成war包jar包啟動執行時,就會發生問題,報找不到資原始檔的錯誤。然後經過尋找排查確定了是下面程式碼通過ClassLoader獲取路徑的時候出錯了。
常用方式:
/** * @author mazhq * @Title: TestMain * @ProjectName: zeus * @Description: TODO * @date 2019/3/5 16:10 */ public class TestMain { public static void main(String[] args) { String path = TestMain.class.getClassLoader().getResource("1.xml").getPath(); System.out.println(path); } /** * 輸出: * */D:/demo_projects/sc-architecture/service-hi/target/classes/1.xml */ }
但是在將SpringBoot打包放到Linux伺服器啟動列印的目錄為
/data/zeus/service-hi-1.0.0-SNAPSHOT.war!/WEB-INF/classes!/1.xml
可以看到在Linux中無法直接訪問未經解壓的檔案,所以就會找不到檔案。
解決辦法
1. 通過ClassLoader的getResourceAsStream()方法獲取其流,就能夠獲取到。
讀取jar裡面的檔案,我們只能用流去讀取,不能用File
public class TestMain { public static void main(String[] args) { try { List<String> content = IOUtils.readLines(TestMain.class.getClassLoader().getResourceAsStream("1.xml"),"UTF-8"); } catch (IOException e) { e.printStackTrace(); } } }
2. 採用絕對路徑將檔案放到伺服器某個路徑,在application.properties中配置路徑讀取。
3. 不推薦:將內容放到資料庫中。
獲取資源的兩種方式
通常在開發過程中會碰到讀取配置檔案的問題,一般有兩種方式進行讀取。一種是Class.getResource(String path),一種是ClassLoader.getResource(String path),這兩種雖然都能讀取檔案,但是在path的填寫上有一點點的不同。
Class.getResource
path以/開頭:則是從ClassPath根下獲取
path不以/開頭:預設是從此類所在的包下取資源
下面有個例子
public class TestMain { public static void main(String[] args) { System.out.println(TestMain.class.getResource("/")); System.out.println(TestMain.class.getResource("")); } /** * 輸出: * * file:/D:/demo_projects/sc-architecture/service-hi/target/classes/ * file:/D:/demo_projects/sc-architecture/service-hi/target/classes/com/mazhq/servicehi/ */ }
那麼讀取在resource下的1.xml,就如下的獲取方法
public class TestMain { public static void main(String[] args) { System.out.println(TestMain.class.getResource("/1.xml")); System.out.println(TestMain.class.getResource("../../../1.xml")); } /** * 輸出: * * file:/D:/demo_projects/sc-architecture/service-hi/target/classes/1.xml * file:/D:/demo_projects/sc-architecture/service-hi/target/classes/1.xml */ }
ClassLoader.getResource
ClassLoader.getResource的path中不能以/開頭,path是預設是從根目錄下進行讀取的
程式碼如下:
public class TestMain { public static void main(String[] args) { System.out.println(TestMain.class.getClassLoader().getResource("")); System.out.println(TestMain.class.getClassLoader().getResource("/")); } /** * 輸出: * * file:/D:/demo_projects/sc-architecture/service-hi/target/classes/ * null */ }
從上面例子我們可以看到
TestMain.class.getClassLoader().getResource("")=TestMain.class.getResource("/")
兩個獲取資原始檔的差別
其實檢視Class.getResource中可以看到
public java.net.URL getResource(String name) { name = resolveName(name); ClassLoader cl = getClassLoader0(); if (cl==null) { // A system class. return ClassLoader.getSystemResource(name); } return cl.getResource(name); }
他最後呼叫的還是ClassLoader.getResource這個方法,那麼為什麼會有path的差別呢,因為其resolveName方法中對傳的/進行了解析,解析為了空字串。
resolveName 方法實現如下:
private String resolveName(String name) { if (name == null) { return name; } if (!name.startsWith("/")) { Class<?> c = this; while (c.isArray()) { c = c.getComponentType(); } String baseName = c.getName(); int index = baseName.lastIndexOf('.'); if (index != -1) { name = baseName.substring(0,index).replace('.','/') +"/"+name; } } else { name = name.substring(1); } return name; }<br><br> //傳入 "/" 返回 ""
最後:大家用的時候注意一下這些問題,避免在這個上面耽誤時間。
以上就是本文的全部內容,希望對大家的學習有所幫助,也希望大家多多支援我們。