在日常自动化测试开发中,经常要使用配置文件,或进行环境配置,或进行数据驱动等;我们常常把这些文件放置在
resources目录下,然后通过getResource、ClassLoader.getResource和getResourceAsStream()等方法去读取,经常看到有人在读取配置文件时踩坑,本人也是踩坑过来了,这里做梳理分享
1、何为classpath
读取资源文件最关键的就是找到文件的位置,归根结底就是找路径,而怎么找,在哪找就是个问题;这其中和
classpath有很大的关系,因此先了解下classpath帮助理解
- 我们用
Java编写的文件都是.java文件,而想要运行,还需将其编译成.class字节码文件才可被JVM运行;这就需要JVM先找到对应的.class才行,这也就是要找到对应的classpath。 JVM会在编译项目时,会主动将.java文件编译成.class文件 并和resources目录下的静态文件一起放在target/classes(如果是test下的类,便会放于/target/test-classes下)目录下; 现有工程目录如下: 编译后进入
target目录下查看如下:
2、class.getResource()
先来看
getResource的用法
-
先分别执行如下测试代码,打印
带有"/"和不带"/"的pathimport org.junit.jupiter.api.Test; public class ResourceTestDemo { @Test void getResourceTest(){ System.out.println(ResourceTestDemo.class.getResource("")); System.out.println(ResourceTestDemo.class.getResource("/")); }打印结果:
file:/Users/username/Documents/TestDev/MyTraining/XUnit/ResourceTest/target/test-classes/resourcetest/ file:/Users/username/Documents/TestDev/MyTraining/XUnit/ResourceTest/target/test-classes/结果分析:
1、getResource("")不带"/"时候是从当前类所在包路径去获取资源
2、getResource("/")带"/"时候是从classpath的根路径获取 -
现在来尝试获取
resources下的文件2.txt和3.txt: 测试代码:
@Test void getResourceFileTest(){ System.out.println(ResourceTestDemo.class.getResource("/3.txt")); System.out.println(ResourceTestDemo.class.getResource("/test/2.txt")); }打印结果:
file:/Users/username/Documents/TestDev/MyTraining/XUnit/ResourceTest/target/classes/3.txt file:/Users/username/Documents/TestDev/MyTraining/XUnit/ResourceTest/target/classes/test/2.txt
3、getClassLoader().getResource()
- 和上述一样,先分别执行测试代码,打印
带有"/"和不带"/"的path打印结果:@Test void getClassLoaderResourceTest(){ System.out.println(ResourceTestDemo.class.getClassLoader().getResource("")); System.out.println(ResourceTestDemo.class.getClassLoader().getResource("/")); }结果分析:file:/Users/qinzhen/Documents/TestDev/MyTraining/XUnit/ResourceTest/target/test-classes/ null
1、getClassLoader().getResource("")不带"/"时候是从classpath的根路径获取
2、getClassLoader().getResource("/")带有"/"打印为null,路径中无法带有"/" - 现在继续尝试获取
resources下的文件2.txt和3.txt:@Test void getClassLoaderResourceFileTest(){ System.out.println(ResourceTestDemo.class.getClassLoader().getResource("3.txt")); System.out.println(ResourceTestDemo.class.getClassLoader().getResource("test/2.txt")); }打印结果:file:/Users/qinzhen/Documents/TestDev/MyTraining/XUnit/ResourceTest/target/classes/3.txt file:/Users/qinzhen/Documents/TestDev/MyTraining/XUnit/ResourceTest/target/classes/test/2.txt
4、getResourceAsStream()
getResourceAsStream() 方法仅仅是获取对应路径文件的输入流,在路径的用法上与getResource()一致
5、补充
其实当我们查看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);
}
其实这里也是调用了getClassLoader,只是方便了我们使用而已
6、总结
class.getResource()不带"/"时候是从当前类所在包路径去获取资源class.getResource()带"/"时候是从classpath的根路径获取class.getResource()本质上也是调用了getClassLoader,只是封装了一层方便了我们使用而已getClassLoader().getResource("")不带"/"时候是从classpath的根路径获取getClassLoader().getResource("/")路径中无法带有"/"getResourceAsStream()方法仅仅是获取对应路径文件的输入流,在路径的用法上与getResource()一致