『動善時』JMeter基礎 — 37、將JMeter測試結果寫入Excel

在使用JMeter進行測試的過程中,有時候需要將測試結果寫入到Excel文件,本篇文章將詳細說明具體步驟。

把測試結果寫入Excel文件中操作思路分析

(1)準備需要的環境

  1. 引入操作Excel文件的基礎JAR包:jxl.jar
  2. 封裝自定義操作Excel的JAR包
    • Excel中一般有三個要素:workbooksheetcell
      要想把結果存儲到指定的單元格中,那麼就必須要確定好這三個元素依次來定位。
      1)先獲取Excel的文件名。
      2)獲取表單名。
      3)獲取單元格的坐標。
    • 獲取結果,寫入到對應的單元格裡面去。
    • 需要利用BeanShell編寫Java程式碼,獲取對應的數據寫入到Excel裡面去。

(2)準備需要的數據文件。

(3)編寫JMeter腳本,添加需要的組件,並控制組件的執行順序,完成最終的測試。

1、環境準備

(1)引入操作Excel文件的基礎JAR包

  1. 需要使用第三方jar包:jxl.jar
  2. jxl.jar的作用:完成對Excel文件的讀寫以及修改操作。
  3. 下載好之後,放到JMeter的安裝路徑下的lib目錄下。

(2)引入封裝自定義操作Excel文件的JAR包

我們可以使用Java語言,對jxl.jar包的功能,進行自定義封裝,訂製成我們自己需要功能。

然後把封裝好的程式碼,打成JAR包,放入到JMeter安裝目錄下的lib\ext目錄下。

簡易自定義封裝程式碼如下:

import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.text.SimpleDateFormat;
import java.util.Date;

import jxl.Cell;
import jxl.JXLException;
import jxl.Workbook;
import jxl.format.Alignment;
import jxl.format.Colour;
import jxl.format.VerticalAlignment;
import jxl.read.biff.BiffException;
import jxl.write.Label;
import jxl.write.WritableCellFormat;
import jxl.write.WritableFont;
import jxl.write.WritableSheet;
import jxl.write.WritableWorkbook;
import jxl.write.WriteException;
import jxl.write.biff.RowsExceededException;


public class CWOutputFile {

    /**
     * wOutputFile 作用:把內容寫入到Excel文件中。
     * wOutputFile寫結果文件   wOutputFile(文件路徑、用例編號、用例標題、預期結果、實際結果、測試結果)
     * @throws IOException
     * @throws BiffException
     * @throws WriteException
     */
    public void wOutputFile(String filepath,String caseNo,String testPoint,String testData,String preResult,String fresult) throws BiffException, IOException, WriteException{
        File output=new File(filepath);
        String result = "";
        InputStream instream = new FileInputStream(filepath);
        Workbook readwb = Workbook.getWorkbook(instream);
        WritableWorkbook wbook = Workbook.createWorkbook(output, readwb);  //根據文件創建一個操作對象
        WritableSheet readsheet = wbook.getSheet(0);  //定位到文件的第一個sheet頁簽
        int rsRows = readsheet.getRows();   //獲取sheet頁簽的總行數
        //獲取sheet表中所包含的總行數

        /******************設置字體樣式***************************/
        WritableFont font = new WritableFont(WritableFont.createFont("宋體"),10,WritableFont.NO_BOLD);
        WritableCellFormat wcf = new WritableCellFormat(font);
        /****************************************************/

        Cell cell = readsheet.getCell(0,rsRows);  //獲取sheet頁的單元格
        if(cell.getContents().equals("")){
            Label labetest1 = new Label(0,rsRows,caseNo);   //第一列:用例編號
            Label labetest2 = new Label(1,rsRows,testPoint);//第二列:用例標題
            Label labetest3 = new Label(2,rsRows,testData); //第三列:測試數據
            Label labetest4 = new Label(3,rsRows,preResult);//第四列:預期結果
            Label labetest5 = new Label(4,rsRows,fresult); //第五列:實際結果
            if(preResult.equals(fresult)){ // 判斷兩個值同時相等才會顯示通過
                result = "通過"; //預期結果和實際結果相同,測試通過
                wcf.setBackground(Colour.BRIGHT_GREEN);  //通過案例標註綠色
            }
            else{
                result = "不通過"; //預期結果和實際結果不相同,測試不通過
                wcf.setBackground(Colour.RED);  // 不通過案例標註紅色
            }
            Label labetest6 = new Label(5,rsRows,result,wcf);//第六列:測試結果
            readsheet.addCell(labetest1);
            readsheet.addCell(labetest2);
            readsheet.addCell(labetest3);
            readsheet.addCell(labetest4);
            readsheet.addCell(labetest5);
            readsheet.addCell(labetest6);
        }
        wbook.write();
        wbook.close();
    }

    /**
     * cOutputFile 作用:創建Excel文件,
     * tradeType為文件名稱前綴,
     * 返回結果:文件路徑,作為wOutputFile寫入結果文件的入參
     * @throws IOException
     * @throws WriteException
     * */
    public String cOutputFile(String tradeType) throws IOException, WriteException{
        String temp_str = "";
        Date dt = new Date();
        SimpleDateFormat sdf = new SimpleDateFormat("yyyyMMddHHmmss");
        temp_str = sdf.format(dt); //獲取時間戳
        // 相對路徑默認為 JMeter_home\bin 目錄
        // 以時間戳命名結果文件,確保唯一
        // 生成文件路徑
        String filepath = "D:\\\\"+tradeType+"_output_" + "_" + temp_str + ".xls";
        File output = new File(filepath);
        if(!output.isFile()){
            // 如果指定的文件不存在,創建新該文件
            output.createNewFile();
            // 寫文件
            // 新建一個writeBook,在新建一個sheet
            WritableWorkbook writeBook = Workbook.createWorkbook(output);
            //命名sheet // createsheet(sheet名稱,第幾個sheet)
            WritableSheet sheet = writeBook.createSheet("輸出結果", 0);
            //設置首行字體為宋體,11號,加粗
            WritableFont headfont = new WritableFont(WritableFont.createFont("宋體"),11,WritableFont.BOLD);
            WritableCellFormat headwcf = new WritableCellFormat(headfont);
            headwcf.setBackground(Colour.GRAY_25); // 灰色顏色
            // 設置列寬度setcolumnview(列號,寬度)
            sheet.setColumnView(0, 11); //設置列寬
            sheet.setColumnView(1, 20);
            sheet.setColumnView(2, 40);
            sheet.setColumnView(3, 10);
            sheet.setColumnView(4, 10);
            sheet.setColumnView(5, 10); //如果需要再新增列,這裡往下添加
            headwcf.setAlignment(Alignment.CENTRE); //設置文字居中對齊方式;//文字居中
            headwcf.setVerticalAlignment(VerticalAlignment.CENTRE); // 設置垂直居中;
            Label labe00 = new Label(0,0,"用例編號",headwcf); //寫入內容:Label(列號,行號,內容)
            Label labe10 = new Label(1,0,"用例標題",headwcf);
            Label labe20 = new Label(2,0,"測試數據",headwcf);
            Label labe30 = new Label(3,0,"預期結果",headwcf);
            Label labe40 = new Label(4,0,"實際結果",headwcf);
            Label labe50 = new Label(5,0,"執行結果",headwcf); //往下添加
            sheet.addCell(labe00);
            sheet.addCell(labe10);
            sheet.addCell(labe20);
            sheet.addCell(labe30);
            sheet.addCell(labe40);
            sheet.addCell(labe50);//往下添加
            writeBook.write();
            writeBook.close();
        }
        return filepath;
    }
}

提示:

  • 使用自己的IDE開發工具,把該文件生成JAR文件。
  • 在編寫Java程式碼的時候,別忘記把jxl.jar導入到項目中,因為是對jxl.jar中的功能進行的封裝。
  • 我使用的是IDEA編輯Java程式碼,創建的Maven項目,在src/main/java目錄下直接創建該文件即可。如果你自己增加了Package,也就是多增加了路徑,在下面引用程式碼的時候,就會變得麻煩。需要導包操作,或者調用的時候增加路徑。
  • 上面定義生成的Excel文件在D盤根目錄,如需生成到其他位置,在程式碼中修改。
  • 關於生成Excel文件內容的格式,可以自定義修改。

當然,你也可以不封裝上面的程式碼,把上面的程式碼直接寫在BeanShell取樣器腳本中也是一樣的。(有Java基礎你會明白的)

2、準備測試需要的數據

程式碼準備好後,我們要準備對應的測試數據,需要準備的數據有兩部分:

  1. 測試用例數據。
  2. 參數化數據。

說明:我們都用.csv格式的數據文件,注意編碼UTF-8,防止中文亂碼。

(1)測試用例數據

測試用例數據文件內容如下:

image

(2)參數化數據

參數化數據文件內容如下:

image

提示:測試用例數據參數化數據可以準備到一個文件中,也可以分開準備,根據自己的需求去做。

3、測試結果寫入Excel演示

(1)測試計劃內包含的元件

添加元件操作步驟

  1. 創建測試計劃。
  2. 創建執行緒組:選中「測試計劃」右鍵 —> 添加 —> 執行緒(用戶) —> 執行緒組
  3. 在執行緒組中,添加配置元件CSV Data Set Config組件:選中「執行緒組」右鍵 —> 添加 —> 配置元件 —> CSV Data Set Config
  4. 在執行緒組中,添加取樣器「HTTP請求」組件:選中「執行緒組」右鍵 —> 添加 —> 取樣器 —> HTTP請求
  5. 在取樣器下,添加後置處理器「正則表達式提取器」組件:選中「取樣器」右鍵 —> 添加 —> 後置處理器 —> 正則表達式提取器
  6. 在執行緒組中,添加邏輯控制器「僅一次控制器」組件:選中「執行緒組」右鍵 —> 添加 —> 邏輯控制器 —> 僅一次控制器
  7. 在執行緒組中,添加取樣器「BeanShell 取樣器」組件:選中「執行緒組」右鍵 —> 添加 —> 取樣器 —> BeanShell取樣器
  8. 在執行緒組中,添加監聽器「察看結果樹」組件:選中「執行緒組」右鍵 —> 添加 —> 監聽器 —> 察看結果樹

提示:需要重複添加的組件這裡不重複描述。

最終測試計劃中的元件如下:

image

點擊運行按鈕,會提示你先保存該腳本,腳本保存完成後會直接自動運行該腳本。

(2)CSV數據文件設置介面內容

我們需要添加兩個CSV Data Set Config組件,一個用於讀取測試用例的數據文件,另一個用於讀取測試數據的參數化文件。

讀取測試用例數據的CSV組件:

image

讀取測試數據參數化文件的CSV組件:

image

提示:要查看好數據文件中是否有標題行,是否有中文,數據是否帶引號,進行相應的配置。如果不明白請看前面的參數化文章,寫的很詳細。

(3)登陸介面請求內容

標準的POST請求,填寫好請求的基本要素,和需要的參數。

如下圖所示:

image

(4)正則表達式提取器內容

使用正則表達式提取器,將每一次請求返回的數據,提取出來,用於後面的操作。

並且正則表達式提取器是放在登陸請求的下一級。

如下圖所示,提取返回的全部內容,賦值給fresult變數。

image

(5)BeanShell取樣器(創建Excel)

創建一個BeanShell取樣器請求,用於創建Excel文件。

因為登陸操作有多條用例,但不需要創建多個Excel文件,我們就需要使用一個邏輯控制器,來控制該BeanShell請求只執行一次。

把此BeanShell取樣器請求放在僅一次控制器的下一級,使該取樣器整個循環過程中只會執行一次,也就是只會生成一個Excel文件。

如下圖所示:

image

然後在腳本中,寫入BeanShell程式碼:

// 1.新建對象
t = new CWOutputExcelFile();

// 2.新建excel文件
String filepath = t.cOutputFile("測試");

// 3.將excel文件路徑保存為jmeter變數,方便後期使用。
vars.put("filepath",filepath);

BeanShell取樣器介面內容介紹

  • Reset bsh.Interpreter before each call:每個BeanShell測試元素都有自己的解釋器副本(對於每個執行緒)。如果重複調用測試元素,例如在循環內,除非選擇在每次調用之前重置bsh.Interpreter選項,否則解釋器將保留在調用之間。一些長時間運行的測試可能會導致解釋器使用大量記憶體。
    由於BeanShell的bsh.Interpreter存在記憶體泄露,常規方法無法支援長時間的壓力測試。JMeter官網推薦,在使用BeanShell進行長時間測試時,打開選項Reset bsh.Interpreterbefore each call,則在每次調用BeanShell程式前,都把解釋器重置,以釋放解釋器之前佔用的記憶體。

  • 參數 (-> String Parameters和String[]bsh.args):輸入String參數。String []bsh.args是主類main函數的形式參數,是一個String 對象數組,可以用來獲取命令行用戶輸入進去的參數。

  • 腳本文件:腳本文件(可以填入腳本文件路徑),可以點擊後邊的瀏覽選擇腳本文件。

  • Script (see below for variables that are defined):編寫腳本,參照下文定義的變數(使腳本文件參照定義的變數來運行)

(6)BeanShell取樣器(寫回結果)

把每次請求介面返回的結果,寫入到Excel文件中。因為每次循環都要執行,所以放在和登陸請求同級。

介面內容如下圖所示:

image

編寫腳本內容如下:

// 1.創建寫回結果的對象
s = new CWOutputExcelFile();

// 2.參數準備
// (1)拼接成json格式的測試數據
String testData="{"+"\"mobilephone\":\""+"${mobilephone}\","+"\"pwd\":\""+"${pwd}\""+"}";

//用get方法可以確保獲取到的是字元串,裡面傳遞的是變數名,不需要用${變數名}這種方式咯!
// (2)獲取預期結果
// 獲取參數化文件中的變數,返回值為字元串類型,否則直接引用為json類型
String preResult = vars.get("preResult"); 

// (3)獲取返回結果
// 獲取正則表達式中的結果文件,返回值為字元串類型,否則直接引用為json類型
String fresult = vars.get("fresult");


// 3.寫測試結果到excel文件,調用方法wOutputFile方法
s.wOutputFile("${filepath}","${caseNo}","${testPoint}",testData,preResult,fresult);

提示:在JMeter中我們經常會使用正則表達式去獲取介面返回的參數,在引用參數的時候,可以直接使用${參數名}。如果這個參數中不帶有任何需要轉義的符號的時候,那麼這種引用方式就沒有問題,否則JMeter就沒法識別。這時可以用vars.get("參數名")的方式,將JMeter變數先變成Java變數,然後再去操作,就不會報錯了。

(7)執行緒組介面內容

因為我們有4個用例,所以循環數填寫4。(不要修改執行緒數)

image

提示:執行緒數和循環次數的區別

僅一次控制器,對某個執行緒組只執行一次。

  • 如果修改執行緒數,如10 ,就是開啟是10個執行緒跑這個執行緒組,所以僅一次控制器中的內容執行10次。
  • 如果修改循環次數,如10 ,表示只開啟一個執行緒,跑這個執行緒組10次,而這10次中僅執行一次僅一次控制器中的內容。

(8)運行查看結果

運行腳本查看結果,我們可以看到創建了一次Excel文件,執行了4次登陸操作,也寫了四次內容到Excel中。這和我們預習的流程是一樣的。

如下圖所示:

image

然後我們再來看看Excel文件中的內容,如下圖所示:

image

我們可以根據自己的需求,自定義文件中的格式和需要存儲的內容(修改封裝程式碼)。