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

1. path以/開頭：則是從ClassPath根下獲取
2. 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;
    }

　　//傳入 "/" 返回  ""

　　

最后：大家用的時候注意一下這些問題，避免在這個上面耽誤時間。