用yaml文件实现接口自动化，本来我打算一个接口对应一个yaml文件，这样看起来比较清晰，但是后来考虑到假如有上千个接口的话，那就得新建上千个yaml文件，那么在打开项目加载的时候就会占用很大一部分资源，加载的也会很慢，所以让把一个模块的接口放在一个yaml文件里面，经过两天的尝试，成功实现

yaml文件格式

login:
  - name: 正常登录
    request:
     data:
       username: 1251651532
       password: 123456
    extract:
      Admin-Token: '"Admin-Token":"(.*?)"'    #在该接口要提取的变量，key是要保存的到的变量，value是要提取的变量
    validate:
      code: "0"
      deptName: 办公室
  - name: 异常登录-username为空
    request:
       data:
        username:
        password: 123456
    validate:
      code: "500"
      deptName:

get_data:
  - name: 获取客户信息
    request:
     data: {'customerId': 1}
    validate:
     code: '0'
     ownerUserName: 大大大
  - name: 获取不存在客户信息
    request:
     data: {'customerId': 3}
    validate:
     code: '500'
     msg: 服务器响应异常

在接口中调用的时候，只需要给每个接口传对应的yaml的数据值即可

获取yaml数据的函数

def read_yaml_file(path,part):
    try:
        with open(make_yaml_path(path), encoding='utf-8') as f:
            caseinfo = yaml.load(stream=f, Loader=yaml.FullLoader)
            new_caseinfo = caseinfo[part]  # 每个接口选择对应的part，如login
            return new_caseinfo

    except Exception as f:
        log.Logger.error("读取用例文件异常：异常信息：%s" % str(traceback.format_exc()))

这样就和一个接口对应一个yaml的使用方法一样了

一些刚开始写接口文档的服务端同学，很容易按着代码的思路去编写接口文档，这让客户端同学或者是服务对接方技术人员经常吐槽，看不懂接口文档。这篇文章提供一个常规接口文档的编写方法，给大家参考。

推荐使用的是 http://docway.net 写接口文档，方便保存和共享，支持导出PDF MARKDOWN，支持团队项目管理。

一、请求参数

1. 请求方法

• GET
  用于获取数据
• POST
  用于更新数据，可与PUT互换，语义上PUT支持幂等
• PUT
  用于新增数据，可与POST互换，语义上PUT支持幂等
• DELETE
  用于删除数据
• 其他
  其他的请求方法在一般的接口中很少使用。如：PATCH HEAD OPTIONS

2. URL
url表示了接口的请求路径。路径中可以包含参数，称为地址参数，如**/user/{id}**，其中id作为一个参数。

3. HTTP Header
HTTP Header用于此次请求的基础信息，在接口文档中以K-V方式展示，其中Content-Type则是一个非常必要的header，它描述的请求体的数据类型。
常用的content-type：

• application/x-www-form-urlencoded
  请求参数使用“&”符号连接。
• application/json
  内容为json格式
• application/xml
  内容为xml格式
• multipart/form-data
  内容为多个数据组成，有分隔符隔开

4. HTTP Body
描述http body，依赖于body中具体的数据类型。如果body中的数据是对象类型。则需要描述对象中字段的名称、类型、长度、不能为空、默认值、说明。以表格的方式来表达最好。
示例：

二、响应参数

1. 响应 HTTP Body
响应body同请求body一样，需要描述请清除数据的类型。
另外，如果服务会根据不同的http status code 返回不同的数据结构， 也需要针对不同的http status code对内容进行描述。

三、接口说明

说明接口的应用场景，特别的注意点，比如，接口是否幂等、处理是同步方式还是异步方式等。

四、示例

上个示例（重点都用红笔圈出来，记牢了）：

接口工具

推荐使用的是 http://docway.net（以前叫小幺鸡） 写接口文档，方便保存和共享，支持导出PDF MARKDOWN，支持团队项目管理。

目录

前言

1、背景公司大部分的服务都是非 HTTP 的接口，都是 dubbo 接口，如今需要对一些接口做性能测试。

2、工具准备Jmeter 3.2、 Java IDE(本文采用 IDEA)，Maven 作为包管理工具

3、创建一个 maven 项目，此处可以创建一个 quickstart，参考截图

 创建好之后，大概的工程结构是这样的：

4、以上配置完毕后，开始撸代码需要继承 Jmeter 的 AbstractJavaSamplerClient 类，并实现 runTest 方法

5、上面那个类是不需要从 jmeter 中获取参数，如果要从 jmeter 中获取相关的参数，可以参考下面这个类

​

6、调试代码写完了，固然可以打成一个 jar 包，然后传到 jmeter 的 lib/ext 下面进行调试，但是这样太麻烦了这里可以直接用 main 方法调试当这里 main 方法调试成功了后，再打 jar 包，上传到 jmeter 的相关路径，再进行测试，会高效很多。

7、调试通之后，将代码打成 jra 包注意，需要将 xsd，dubbo-config.xml 都要打在 jar 包里面，需要在 pom 文件中，还需要配置一些插件

8、因为步骤 7 中引入的第三方的 jar 包都放在了 lib-dependency 中，所以需要指定 jmeter 启动的时候，加载这个目录下的 jar 包修改 jmeter.properties 中的 search_paths，配置相关的依赖的 jar 的路径

9、启动 jmeter，创建一个 java 请求，

10、此处可以把参数放在 csv 文件里，然后测试各种不同的场景

11、以上做完之后，简单调试下脚本，能够正常运行，然后将相关的依赖，脚本，数据文件传到压测机上，调整线程数，进行正式的压测

前言

接口测试包含单接口测试和多接口测试，通过组合多个接口实现一组功能的验证称为多接口测试，单接口重在单个接口多种请求组合的响应断言，多接口重在组合不同接口，实现流程的串联和验证。

当我们在工作中进行接口测试时，项目的接口肯定不止一个，而是很多很多，而且每个接口都需要进行正确参数，错误参数，参数为空，特殊字符等方式来测试接口是否能够正确返回所需的响应值。

今天，我们来一起学习一下怎么用JMeter完成批量的接口测试吧！

 点击链接进群免费领取资料：321255410【备注777】

1、背景
公司大部分的服务都是非 HTTP 的接口，都是 dubbo 接口，如今需要对一些接口做性能测试。

2、工具准备
Jmeter 3.2、 Java IDE(本文采用 IDEA)，Maven 作为包管理工具

3、创建一个 maven 项目，此处可以创建一个 quickstart，参考截图

 
创建好之后，大概的工程结构是这样的：

其中，resource 中存放 dubbo 配置文件。
说到 resources，此处有一个坑，dubbo-config.xml 中的 这个http://code.alibabatech.com/schema/dubbo/dubbo.xsd xsd 文件，由于 code.alibabatech.com 已经停止了服务，需要使用下载一个 xsd 然后进行本地导入。此处也可以不用下载，直接在 pom 文件中，配置 dubbo 的依赖，然后下载 dubbo.jar,解压后就会有 dubbo.xsd 文件，拷贝出来即可，参考下图

​

pom.xml 文件配置

<dependencies>
    <dependency>
      <groupId>junit</groupId>
      <artifactId>junit</artifactId>
      <version>4.12</version>
      <scope>test</scope>
    </dependency>

    <!--jmeter依赖的jar包-->
    <dependency>
      <groupId>org.apache.jmeter</groupId>
      <artifactId>ApacheJMeter_core</artifactId>
      <version>3.2</version>
      <exclusions>
        <exclusion>
          <groupId>org.codehaus.groovy</groupId>
          <artifactId>groovy-all</artifactId>
        </exclusion>
        <exclusion>
          <groupId>commons-math3</groupId>
          <artifactId>commons-math3</artifactId>
        </exclusion>
        <exclusion>
          <groupId>commons-pool2</groupId>
          <artifactId>commons-pool2</artifactId>
        </exclusion>
      </exclusions>
    </dependency>

    <!-- https://mvnrepository.com/artifact/com.alibaba/dubbo -->
    <dependency>
      <groupId>com.alibaba</groupId>
      <artifactId>dubbo</artifactId>
      <version>2.5.3</version>
      <exclusions>
        <exclusion>
          <artifactId>spring</artifactId>
          <groupId>org.springframework</groupId>
        </exclusion>
      </exclusions>
    </dependency>

    <!-- https://mvnrepository.com/artifact/com.101tec/zkclient -->
    <dependency>
      <groupId>com.101tec</groupId>
      <artifactId>zkclient</artifactId>
      <version>0.3</version>
      <exclusions>
        <exclusion>
          <artifactId>zookeeper</artifactId>
          <groupId>org.apache.zookeeper</groupId>
        </exclusion>
      </exclusions>
    </dependency>
    <!-- https://mvnrepository.com/artifact/org.apache.jmeter/ApacheJMeter_java -->
    <dependency>
      <groupId>org.apache.jmeter</groupId>
      <artifactId>ApacheJMeter_java</artifactId>
      <version>3.2</version>
      <exclusions>
        <exclusion>
          <groupId>commons-math3</groupId>
          <artifactId>commons-math3</artifactId>
        </exclusion>
        <exclusion>
          <groupId>commons-pool2</groupId>
          <artifactId>commons-pool2</artifactId>
        </exclusion>
      </exclusions>
    </dependency>

    <!--spring依赖的jar包-->
    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-aop</artifactId>
      <version>${spring.version}</version>
    </dependency>
    <dependency>
      <groupId>com.alibaba</groupId>
      <artifactId>fastjson</artifactId>
      <version>1.2.36</version>
    </dependency>
    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-beans</artifactId>
      <version>${spring.version}</version>
    </dependency>
    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-core</artifactId>
      <version>${spring.version}</version>
    </dependency>
    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-context</artifactId>
      <version>${spring.version}</version>
    </dependency>
    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-context-support</artifactId>
      <version>${spring.version}</version>
    </dependency>
    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-expression</artifactId>
      <version>${spring.version}</version>
    </dependency>
    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-test</artifactId>
      <version>${spring.version}</version>
    </dependency>
  </dependencies>

以上 pom 文件配置都是一些基本的配置，没有配置要测试的接口的依赖的 jar 包，实际操作过程中，需要加上。

dubbo-config.xml 的配置：

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:dubbo="http://code.alibabatech.com/schema/dubbo"
       xsi:schemaLocation="http://www.springframework.org/schema/beans
                             http://www.springframework.org/schema/beans/spring-beans.xsd
                             http://code.alibabatech.com/schema/dubbo
                             http://code.alibabatech.com/schema/dubbo/dubbo.xsd
                             ">

    <dubbo:application name="要测试接口的应用名" owner="某人"/>
    <dubbo:monitor protocol="registry"/>

    <!-- 使用注册中心暴露发现服务地址 -->
    <dubbo:registry address="zookeeper://zk的地址"/>

    <!-- 生成远程服务代理，可以和本地bean一样使用demoService -->

    <dubbo:reference id="iPromiseDubboService"
                     interface="com.dmall.promise.dubbo.IPromiseDubboService" timeout="5000"
                     check="false"/>

</beans>

4、以上配置完毕后，开始撸代码
需要继承 Jmeter 的 AbstractJavaSamplerClient 类，并实现 runTest 方法

public class QueryTimeInfoBySlotId extends AbstractJavaSamplerClient {
    private static final ApplicationContext context = new ClassPathXmlApplicationContext("dubbo-config.xml");

    private static IPromiseDubboService iPromiseDubboService;

    public void setupTest(JavaSamplerContext arg0){
        iPromiseDubboService=(IPromiseDubboService)context.getBean("iPromiseDubboService");
    }

    public SampleResult runTest(JavaSamplerContext javaSamplerContext) {
        SampleResult sr = new SampleResult();
        Long timeSlotId=20000l;
        try{
            sr.sampleStart();
          //此处可以增加请求的label，也可以就这样
           // sr.setSampleLabel(title);
            PromiseRemoteResponse<TimeInfo> responseData=iPromiseDubboService.queryTimeInfoBySlotId(timeSlotId);
            if(responseData!=null && "0000".equals(responseData.getCode())){
                sr.setSuccessful(true);
                sr.setResponseData("code: " + responseData.getCode()+"message: " + responseData.getMessage(),"utf-8");
            }else {
                sr.setSuccessful(false);
            }
            sr.sampleEnd();
        }catch (Exception e){
            e.printStackTrace();
        }

        return  sr;
    }
    public  void teardownTest(JavaSamplerContext arg0){
    }
}

5、上面那个类是不需要从 jmeter 中获取参数，如果要从 jmeter 中获取相关的参数，可以参考下面这个类

public class QueryAllOptionalPeriod extends AbstractJavaSamplerClient {

    private static final ApplicationContext context = new ClassPathXmlApplicationContext("dubbo-config.xml");

    private static IPromiseDubboService iPromiseDubboService;


// 该方法设置的参数，都会出现在jmeter的参数列表中，并且展示相关设置的默认值
    public Arguments getDefaultParameters(){
        Arguments params = new Arguments();
        params.addArgument("title","casetitle");
        params.addArgument("erpStoreId", "110");
        params.addArgument("latitude", "116.435292");
        params.addArgument("longitude","39.994951");
        params.addArgument("saleType","1");
        return params;
    }


    public void setupTest(JavaSamplerContext arg0){
        iPromiseDubboService=(IPromiseDubboService)context.getBean("iPromiseDubboService");
    }

    public SampleResult runTest(JavaSamplerContext javaSamplerContext) {
        SampleResult sr = new SampleResult();
        //从jmeter 中获取相关的参数，组装后，调用相关的接口
        long erpStoreId=Long.parseLong(javaSamplerContext.getParameter("erpStoreId"));
        Double latitude=Double.parseDouble(javaSamplerContext.getParameter("latitude"));
        Double longitude=Double.parseDouble(javaSamplerContext.getParameter("longitude"));
        String title=javaSamplerContext.getParameter("title");
        Integer saleType=Integer.parseInt(javaSamplerContext.getParameter("saleType"));

        System.out.println("param is :  tilte is : " + title+"erpStoreId: " +  erpStoreId
                + "latitude : "+ latitude + "longitude: " + longitude +"saleType: " +saleType);


        PromiseVO promiseVO = new PromiseVO();
        promiseVO.setErpStoreId(erpStoreId);
        Location location = new Location();
        location.setLongitude(longitude);
        location.setLatitude(latitude);
        promiseVO.setUserLocation(location);

        promiseVO.setSaleType(saleType);
        try{
            sr.sampleStart();
            sr.setSampleLabel(title);
            PromiseRemoteResponse<List<OptionalPeriod>> responseData=iPromiseDubboService.queryAllOptionalPeriod(promiseVO);
            if(responseData!=null && "0000".equals(responseData.getCode())){
                sr.setSuccessful(true);
                sr.setResponseData("code : " + responseData.getCode() + "message: " + responseData.getMessage(),"utf-8");
            }else{
                sr.setSuccessful(false);
            }
            sr.sampleEnd();

        }catch (Exception e){
            e.printStackTrace();
        }


        return sr;
    }
    public  void teardownTest(JavaSamplerContext arg0){
    }

}

   点击链接进群免费领取资料：321255410【备注777】

6、调试代码
写完了，固然可以打成一个 jar 包，然后传到 jmeter 的 lib/ext 下面进行调试，但是这样太麻烦了
这里可以直接用 main 方法调试
当这里 main 方法调试成功了后，再打 jar 包，上传到 jmeter 的相关路径，再进行测试，会高效很多。

public class TestMain {
    public static final void  main(String [] args){

        JavaSamplerContext arg0 = new JavaSamplerContext(new Arguments());

        QueryPreSaleOptionalPeriod test=new QueryPreSaleOptionalPeriod();
        test.setupTest(arg0);
        test.runTest(arg0);

    }
}

7、调试通之后，将代码打成 jra 包
注意，需要将 xsd，dubbo-config.xml 都要打在 jar 包里面，需要在 pom 文件中，还需要配置一些插件

<build>
    <plugins>
      <!--复制jar包插件，将使用到的jar包，复制到target/lib中-->
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-dependency-plugin</artifactId>
        <executions>
          <execution>
            <id>copy-dependencies</id>
            <phase>prepare-package</phase>
            <goals>
              <goal>copy-dependencies</goal>
            </goals>
            <configuration>
              <outputDirectory>${project.build.directory}/lib</outputDirectory>
              <overWriteReleases>false</overWriteReleases>
              <overWriteSnapshots>false</overWriteSnapshots>
              <overWriteIfNewer>true</overWriteIfNewer>
            </configuration>
          </execution>
        </executions>
      </plugin>


      <plugin>
        <groupId>org.codehaus.mojo</groupId>
        <artifactId>build-helper-maven-plugin</artifactId>
        <version>1.8</version>
        <executions>
          <execution>
            <id>add-resource</id>
            <phase>generate-resources</phase>
            <goals>
              <goal>add-resource</goal>
            </goals>
            <configuration>
              <resources>
                <resource>
                  <directory>src/main/resources</directory>
                  <includes>
                    <include>*</include>
                  </includes>
                </resource>
              </resources>
            </configuration>
          </execution>
        </executions>
      </plugin>

      <plugin>
        <artifactId>maven-assembly-plugin</artifactId>
        <version>2.4</version>
        <configuration>
          <descriptorRefs>
            <descriptorRef>jar-with-dependencies</descriptorRef>
          </descriptorRefs>
          <archive>
            <manifest>
              <mainClass>TestMain.Main</mainClass>
            </manifest>
          </archive>
        </configuration>
        <executions>
          <execution>
            <id>make-assembly</id>
            <phase>package</phase>
            <goals>
              <goal>single</goal>
            </goals>
          </execution>
        </executions>
      </plugin>


    </plugins>

这样，执行 maven package 后，targer 下面会有两个东西，是我们需要的：

将此处的 jar 文件拷贝到 jmeter 的 lib/ext 里面
然后将 lib 下面的各种依赖的第三方的 jar 拷贝到 jmeter 的的 lib-dependency(自己创建一个就行）

8、因为步骤 7 中引入的第三方的 jar 包都放在了 lib-dependency 中，所以需要指定 jmeter 启动的时候，加载这个目录下的 jar 包
修改 jmeter.properties 中的 search_paths，配置相关的依赖的 jar 的路径

9、启动 jmeter，创建一个 java 请求，

10、此处可以把参数放在 csv 文件里，然后测试各种不同的场景

11、以上做完之后，简单调试下脚本，能够正常运行，然后将相关的依赖，脚本，数据文件传到压测机上，调整线程数，进行正式的压测

本文完
下面是 jmeter 在非 GUI 模式下的分布式测试配置和操作，可以参考。
性能测试过程中，一般是找个 linux 服务器，用命令行模式进行压测
jmeter non GUI 运行分布式压测
前期准备：master 和 slave 尽量使用相同的 jmeter 版本，避免一些奇葩的问题。

配置
slave 机器：启动 jmeter-server &（后台启动）
master 机器：配置 remote_host= slave 机器的 ip
PS： 此处如果 master 也要参与压测，需要启动 master 机器上的 jmeter-server，然后 remote_host 中需要配置 master 机器的 ip

启动命令，在 master 机器上执行：
方式一：指定其中一台机器或者多台
sh jmeter.sh -n -t ../../promise-test/testcase10.jmx -R 192.168.90.130
方式二：全部的 slave 都躁起来压测
sh jmeter.sh -n -t ../../promise-test/testcase10.jmx -r
Attention:注意 slave 和 master 的 host 配置，一定要有这条 host，
本机 ip hostname （不可以是 127.0.0.1，也不可以是 localhsot） 参考 URL: JMeter - User's Manual: Remote (Distributed) Testing

    点击链接进群免费领取资料：321255410【备注777】

衷心感谢每一个观看我文章的人，喜欢的话那就动手给博主点个关注吧！！！