SpringBoot打jar包或war包獲取不到資源文件解決辦法

問題描述

在開發過程當中咱們常常會碰到要在代碼中獲取資源文件的狀況，而我在最近將原有的Tomcat的原生項目遷移到SpringBoot項目中時碰到一個問題，就是在本地運行時，獲取本地的xml資源文件是可以獲取到的，可是項目打成war包而後將其部署到Tomcat中運行時，就會發生問題，報找不到資源文件的錯誤。而後通過尋找排查肯定了是下面代碼經過ClassLoader獲取路徑的時候出錯了。

ExcelXmlModelFactory.class.getClassLoader().getResource("template/").getPath()

個人資源文件存放路徑以下

在本地中打印的日誌路徑爲

/Users/hupengfei/git/lap/lap-service/out/production/resources/template

可是在將SpringBoot打包成war包部署到Tomcat中時打印的目錄爲

/home/app/lap/app/lap-service-1.0.0-SNAPSHOT.war!/WEB-INF/classes!/template/

能夠看到在Linux中沒法直接訪問未經解壓的文件，因此就會找不到文件。

解決辦法

經過ClassLoader的getResourceAsStream()方法獲取其流，就可以獲取到

讀取jar裏面的文件，咱們只能用流去讀取，不能用File

獲取資源的兩種方式

一般在開發過程當中會碰到讀取配置文件的問題，通常有兩種方式進行讀取。一種是Class.getResource(String path)，一種是ClassLoader.getResource(String path)，這兩種雖然都能讀取文件，可是在path的填寫上有一點點的不一樣。

Class.getResource

• path以/開頭：則是從ClassPath根下獲取
• path不以/開頭：默認是今後類所在的包下取資源

下面有個例子

public class Test {
    public static void main(String[] args) {
    	 System.out.println(Test.class.getResource("/"));
        System.out.println(Test.class.getResource(""));
    }
}

輸出以下

file:/Users/hupengfei/git/Test/out/production/classes/
file:/Users/hupengfei/git/Test/out/production/classes/Practice/Day13/

那麼若是在resource下有三個資源文件

那麼該怎麼獲取這三個文件呢，由於在class文件夾中的目錄結構以下

-- classes
	-- Convience
	-- Practice
	-- Test

因此若是想要獲取Test下的資源文件，就以下的獲取方法

System.out.println(Test.class.getResource("../../Test/1.xml"));
System.out.println(Test.class.getResource("/Test/1.xml"));

ClassLoader.getResource

ClassLoader.getResource的path中不能以/開頭，path是默認是從根目錄下進行讀取的

例子以下

System.out.println(Test.class.getClassLoader().getResource(""));
System.out.println(Test.class.getClassLoader().getResource("/"));

打印以下

file:/Users/hupengfei/git/Test/out/production/classes/
null

從上面例子咱們能夠看到

Test.class.getClassLoader().getResource("")=Test.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 方法中對傳的/進行了解析，解析爲了空字符串。

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;
    }

能夠看到在這穿進去的爲/

傳出的是

參考文章

• https://www.cnblogs.com/yejg1212/p/3270152.html
• https://blog.csdn.net/xiaoxudong666/article/details/82192425