問題描述
在開發(fā)過程中我們經(jīng)常會碰到要在代碼中獲取資源文件的情況，而我在最近將原有的Tomcat的原生項(xiàng)目遷移到SpringBoot項(xiàng)目中時(shí)碰到一個(gè)問題，就是在本地運(yùn)行時(shí)，獲取本地的xml資源文件是能夠獲取到的，但是項(xiàng)目打成war包然后將其部署到Tomcat中運(yùn)行時(shí)，就會發(fā)生問題，報(bào)找不到資源文件的錯(cuò)誤。然后經(jīng)過尋找排查確定了是下面代碼通過ClassLoader獲取路徑的時(shí)候出錯(cuò)了。
ExcelXmlModelFactory.class.getClassLoader().getResource("template/").getPath()
我的資源文件存放路徑如下
在本地中打印的日志路徑為
/Users/hupengfei/git/lap/lap-service/out/production/resources/template
但是在將SpringBoot打包成war包部署到Tomcat中時(shí)打印的目錄為
/home/app/lap/app/lap-service-1.0.0-SNAPSHOT.war!/WEB-INF/classes!/template/
可以看到在Linux中無法直接訪問未經(jīng)解壓的文件，所以就會找不到文件。
解決辦法
通過ClassLoader的getResourceAsStream()方法獲取其流，就能夠獲取到
讀取jar里面的文件，我們只能用流去讀取，不能用File
獲取資源的兩種方式
通常在開發(fā)過程中會碰到讀取配置文件的問題，一般有兩種方式進(jìn)行讀取。一種是Class.getResource(String path)，一種是ClassLoader.getResource(String path)，這兩種雖然都能讀取文件，但是在path的填寫上有一點(diǎn)點(diǎn)的不同。
Class.getResource
- path以
/開頭：則是從ClassPath根下獲取 - path不以
/開頭：默認(rèn)是從此類所在的包下取資源
下面有個(gè)例子
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下有三個(gè)資源文件
那么該怎么獲取這三個(gè)文件呢，因?yàn)樵赾lass文件夾中的目錄結(jié)構(gòu)如下
-- 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是默認(rèn)是從根目錄下進(jìn)行讀取的
例子如下
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("/")
兩個(gè)獲取資源文件的差別
其實(shí)查看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);
}
他最后調(diào)用的還是ClassLoader.getResource這個(gè)方法，那么為什么會有path的差別呢，因?yàn)槠?code>resolveName方法中對傳的/進(jìn)行了解析，解析為了空字符串。
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;
}
可以看到在這穿進(jìn)去的為/
傳出的是
