springboot项目组引入JMeter

一、前言

• 看到标题的小伙伴肯定很好奇，springboot项目中用JMeter能干什么，那么我先反问你JMeter能用来作什么？压测；接口自动化？，如果你能猜到这两点那你对JMeter肯定是有了一定的认知，同样你也猜对了，用它来做接口自动化

但是可能会有小伙伴会有疑问为什么不拿他来做压测，当然可能拿来做压测但是不建议在springboot项目中整合压测功能，毕竟压测本来就是一种多线程的形式而且极其消耗内存，spring项目本来就很重，所以得不偿失。当然对于压测我又另一种方案，就是容器化的分布式压测，这一块方案我会再后续的文章分享出，接下来我们先来谈谈如何在springboot项目中做接口自动化吧

• 在这篇文章中我详细介绍过JMeter engine启动原理，知道JMeter engine原理之后，是否我们可以这样做，在springboot项目引入JMeter开源组件包然后使用其开启engine的方法，自己开启engine，当然此时你的线程肯定是单线程，所以基本内存消耗很低，那么如何做？我们接着往下说

二、springboot项目引入JMeter完成接口自动化操作

1. 首先导入JMeter对应的maven坐标

<properties>
    <jmeter.version>5.3</jmeter.version>
</properties>

<dependencies>
<dependency>
    <groupId>org.apache.jmeter</groupId>
    <artifactId>ApacheJMeter_http</artifactId>
    <version>${jmeter.version}</version>
    <exclusions>
        <exclusion>
            <groupId>org.apache.logging.log4j</groupId>
            <artifactId>log4j-slf4j-impl</artifactId>
        </exclusion>
    </exclusions>
</dependency>
<dependency>
    <groupId>org.apache.jmeter</groupId>
    <artifactId>ApacheJMeter_functions</artifactId>
    <version>${jmeter.version}</version>
</dependency>
<dependency>
    <groupId>org.apache.jmeter</groupId>
    <artifactId>ApacheJMeter_jdbc</artifactId>
    <version>${jmeter.version}</version>
</dependency>
<dependency>
    <groupId>org.apache.jmeter</groupId>
    <artifactId>ApacheJMeter_tcp</artifactId>
    <version>${jmeter.version}</version>
</dependency>
</dependencies>

2. 在JMeter engine启动原理介绍了StandardJMeterEngine标准的引擎类，通过创建这个对象就可以开启engine，当然事实并非如此简单

//创建engine
StandardJMeterEngine engine = new StandardJMeterEngine();
//将hashTree配置注入engine中
engine.configure(hashTree); 
try {
	//执行engine开始运行
    engine.runTest();
} catch (JMeterEngineException e) {
    engine.stopTest();
    e.printStackTrace();
}

3. 所以开启engine就这么短短的几步操作就行，但是上面需要HashTree对象传入，就是你的配置，关于HashTree的用法及使用，可以参考我写的这篇博文

一文搞懂JMeter engine中的HashTree配置

4. HashTree有了之后，理论上是可以运行了，但是实际却会报错，因为JMeter engine开启会初始化配置文件，也就是我们熟知的jmeter.properties配置的内容，所以你可以在springboot项目的resource下创建jmeter目录存放jmeter.properties等配置

配置文件可以去github上去获取JMeter 配置

6. 好了配置有了，接下来我们需要先初始化jmeter.properties配置属性然后在开启jmeter engine就行

//初始化jmeter属性配置
private void initJMeterProperties() {
    if (!StringUtils.isEmpty(JMeterUtils.getJMeterProperties())){
        return;
    }
    try {
        InputStream inputStream = JMeterUtil.class.getResource("/jmeter/jmeter.properties").openStream();
        File tempFile = FileUtil.createTempFile(null);
        FileUtil.writeFromStream(inputStream,tempFile);
        //这里面loadJMeterProperties方法必须写成临时文件这样的形式，否则会获取不到jmeter.properties
        JMeterUtils.loadJMeterProperties(tempFile.getAbsolutePath());
        JMeterUtils.setJMeterHome(JMeterUtil.PATH);
        JMeterUtils.setLocale(LocaleContextHolder.getLocale());
    } catch (IOException e) {
        e.printStackTrace();
    }
}

7. 在上面代码中必须通过创建临时文件的形式传入临时文件的路径，否则springboot打成jar无法找到路径从而报错
   

8. 在执行步骤2即可，但是会有一个问题engine.runTest()是一个空方法，那你如何接收运行的结果集数据呢？这里就要牵扯到jmeter后端监听器的作用了，JMeter后端监听器作用及原理可以参考这篇文章

后端监听器可以异步的接收jmeter engine运行的结果集，所以我们可以通过这个方式实现一个完整的接口自动化流程

9. 这是关于我的springboot项目采用后端监听器的实现方式

public class CustomBackendListenerClient extends AbstractBackendListenerClient {

    private final List<SampleResult> queue = new ArrayList<>();

    //获得控制台内容。
    private PrintStream oldPrintStream = System.out;
    private ByteArrayOutputStream bos = new ByteArrayOutputStream();

    private void setConsole() {
        System.setOut(new PrintStream(bos));
    }

    private String getConsole() {
        System.setOut(oldPrintStream);
        return bos.toString();
    }
	// engine执行之前会进行前置处理器
    @Override
    public void setupTest(BackendListenerContext context) throws Exception {
        setConsole();
        super.setupTest(context);
    }
	//engine执行中的处理
    @Override
    public void handleSampleResults(List<SampleResult> sampleResults, BackendListenerContext context) {
    	//结果集添加至集合中
        queue.addAll(sampleResults);
    }
	//engine结束后的后置处理器
    @Override
    public void teardownTest(BackendListenerContext context) throws Exception {
    	//处理结果集中的数据并封装至JMeterRequestResult对象中
        RunJMeterRequestService runJMeterRequestService = CommonBeanFactory.getBean(RunJMeterRequestService.class);
        List<JMeterRequestResult> jMeterRequestResults = Lists.newArrayList();
        String testId = context.getParameter("testId");
        queue.stream().forEach(result -> {
            setRequestResult(result, jMeterRequestResults);
        });
        queue.clear();
        runJMeterRequestService.addDebugResult(testId, jMeterRequestResults);
        super.teardownTest(context);
    }

    private void setRequestResult(SampleResult result, List<JMeterRequestResult> jMeterRequestResults) {
        JMeterRequestResult metricResult = new JMeterRequestResult();
        Long responseTime = result.getEndTime() - result.getStartTime();
        metricResult.setUrl(result.getUrlAsString());
        metricResult.setResponseSize(((Integer) result.getBodySize()).toString());
        metricResult.setResponseTime(responseTime.toString());
        metricResult.setResponseResult(result.getResponseDataAsString());
        metricResult.setConsoleResult(getConsole());
        if (result instanceof HTTPSampleResult) {
            HTTPSampleResult res = (HTTPSampleResult) result;
            metricResult.setCookie(res.getCookies());
            metricResult.setRequestMethod(res.getHTTPMethod());
        }
        metricResult.setRequestData(result.getSamplerData());
        metricResult.setResponseHeader(result.getResponseHeaders());
        metricResult.setRequestHeader(result.getRequestHeaders());
        metricResult.setStatusCode(result.getResponseCode());
        jMeterRequestResults.add(metricResult);
    }
}

9. 至此JMeter接口自动化可以通过此方案来实现，希望能对你有所启发