五、JAVA接口测试框设计 - DataProvider+txt管理测试数据

接口测试中测试用例数据管理的设计：
这里用到的是DataProvider+txt的方式进行管理，个人认为这种方式管理还是比较便捷的。

1.txt文件设计：

外部有一些使用excel管理的方式，考虑到一些表格格式化、操作便捷性还是更换了txt的方式管理。

（1）txt参数设计模板：

将参数分类为三种 BVT、NORMAL、ABNORMAL，分别代表冒烟用例、正常逻辑用例、非正常逻辑用例（具体用法看这人习惯吧）

（2）文件结构设计：

我们假设一个数据推送接口：datapush，新建一个 dataPushTest_BVT.txt的文件：

文件新建.png

（3）设计txt文件的参数格式：

no+annotation+params的三个字段的方式，即序号、注释、参数：

参数设计.png

2.开始编写处理txt文件的方式：

（1）在公共方法中新建一个工具类：

ReadTxtData.java,就是读取出txt数据的意思。

（2）在公共文件中新建一个文件路径拼接的工具类：

LocalSolution.java 用于拼接文件路径。

（3）在 LocalSolution 拼接工具类中新增用例路径获取拼接方法：

public class LocalSolution {
    //获取用例数据文件路径并拼接资源目录src/main/resources
    public String getCaseDataPath(String filenames) {
        // 获取项目路径
        String localPath = new File("").getAbsolutePath();
        //拼接资源路径，这里固定的框设计文件路径为/src/main/resources/caseData/，所以就写死这个相对路径。
        String localPathfile = localPath+"/src/main/resources/caseData/"+filenames;
        return localPathfile;
    }

(4)在ReadTxtData中新增txt读取方法

import org.testng.annotations.DataProvider;
import org.testng.annotations.Test;
import java.io.*;
import java.lang.reflect.Method;
import java.util.ArrayList;
import java.util.List;
import java.io.BufferedReader;

public class ReadTxtData {
    // 引用路径拼接方法拼接路径
    LocalSolution localSolution = new LocalSolution();
    // 接收逐行查询的数据
    public String UseCaseParameter = null;
    public List readFileContext(String paths) throws IOException {
        // 储存读取的txt数据
        List caseDataParameter = new ArrayList<>();
        // 拼接出测试用例数据的地址
        String fname = localSolution.getCaseDataPath(paths);
        // 取出测试数据
        try {
            String encoding = "UTF-8"; // 字符编码(可解决中文乱码问题 )
            // 新建一个测试数据的文件对象
            File file = new File(fname);
            // 判断文件是否存在且是否为文件
            if (file.isFile() && file.exists()) {
                // 配置读取txt文件信息
                InputStreamReader read = new InputStreamReader(new FileInputStream(file), encoding);
                BufferedReader bufferedReader = new BufferedReader(read);
                // 循环取出对应的文件
                while ((UseCaseParameter = bufferedReader.readLine()) != null) {
                    caseDataParameter.add(UseCaseParameter);
                }
                read.close();
            } else {
                System.out.println("没有找到对应的测试用例数据文件！");
            }
        } catch (Exception e) {
            System.out.println("读取用例数据文件错误！");
            e.printStackTrace();
        }
        return caseDataParameter;
    }

（5）新建一个 dataprivoder方法：

    @DataProvider(name = "testcase")
    public Object[][] dataProviders(Method method ) throws IOException {
        // 获取执行用例方法名称
        String fileName = method.getName().split("_")[0];
        // 方法名称拼接为文件名
        String paths = fileName+"/"+method.getName()+".txt";
        // 获取txt读取出的文件数据
        List caseValue = readFileContext(paths);
        // 循环写入dataprovider参数接收变量中
        Object[][] caseData =new Object[caseValue.toArray().length][1];
        for(int i =0 ;i<caseValue.toArray().length;i++){
            caseData[i][0] = caseValue.get(i).toString();
        }
        return caseData;
    }

（6）新建测试用例获取对应的参数值：

这里要注意方法名要与用例数据文件名完全一致，数据文件夹名要与接口名完全一致。对应关系如图所示：

文件名称关系.png

（7）测试用例接受及请求代码：

// dataProvider设置的为name的值即testcase，其他的文件引用需要把类文件指定所以需要用dataProviderClass = ReadTxtData.class
    @Test(dataProvider = "testcase",dataProviderClass = ReadTxtData.class)
    public void dataPushTest_BVT(String params) throws IOException {
        // 接口数据为JSON参数
        JSONObject params_results = JSONObject.parseObject(params);
        // 取出接口参数
        JSONObject body_bvt =params_results.getJSONObject("params");
        // 参数构造
        System.out.println("本次请求的接口："+requestUrl);
        System.out.println("本次请求的参数："+body_bvt);
        // 请求接口，这里可以参照接口请求篇的文章看到详细的接口请求封装
        JSONObject interfaceResults =  requestHttp.postClientJson(requestUrl,body_bvt.toString());
        System.out.println("接口返回值："+interfaceResults.toString());
        // 获取返回值
        String results = interfaceResults.getString("total");
        // 用例断言
        Assert.assertEquals("0",results,"判断接口返回数据总数");
    }