软件测试 / 自动化测试之读取配置文件

本文为霍格沃兹测试学院优秀学员学习笔记。

在日常自动化测试开发工作中，经常要使用配置文件，进行环境配置，或进行数据驱动等。我们常常把这些文件放置在 resources 目录下，然后通过 getResource、ClassLoader.getResource 和 getResourceAsStream() 等方法去读取。经常看到有不少同学在读取配置文件时踩坑，本人也是一路踩坑摸索过来，这里做一个简要梳理，供大家参考。

一、何为 classpath ？

读取资源文件最关键的就是找到文件的位置，归根结底就是找路径，而怎么找，在哪找就是个问题。这其中和 classpath 有很大关系，因此我们先了解下 classpath 的概念，帮助理清思路。

• 我们用 Java 编写的文件都是 .java 文件，而想要运行，还需将其编译成 .class 字节码文件才可被 JVM 运行；这就需要 JVM 先找到对应的 .class 才行，这也就是要找到对应的classpath。

• JVM 会在编译项目时，会主动将 .java 文件编译成 .class 文件 并和 resources目录下的静态文件一起放在 target/classes (如果是 test 下的类，便会放于 /target/test-classes 下)目录下；

现有工程目录如下：

编译后进入 target 目录下查看如下：

二、class.getResource()

先来看 getResource 的用法

先分别执行如下测试代码，打印带有"/"和不带"/"的path

    import 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

三、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

四、getResourceAsStream()

getResourceAsStream() 方法仅仅是获取对应路径文件的输入流，在路径的用法上与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);
}  

其实这里也是调用了getClassLoader，只是方便了我们使用而已。

总结

• class.getResource()不带"/"时候是从当前类所在包路径去获取资源；

• class.getResource()带"/"时候是从classpath的根路径获取；

• class.getResource()本质上也是调用了getClassLoader，只是封装了一层方便了我们使用而已；

• getClassLoader().getResource("")不带"/"时候是从classpath的根路径获取；

• getClassLoader().getResource("/")路径中无法带有"/"；

• getResourceAsStream() 方法仅仅是获取对应路径文件的输入流，在路径的用法上与getResource()一致；

以上，供大家探讨。

更多技术文章分享及测试资料