Jmeter函數助手中添加自定義函數

最近，群里的牛肉面大神有個需求，是將每個post請求的body部分做一個加密操作，其實這個需求不算難，用beanshell引入加密函數的包，然后調用就行了。只是，如果請求多了，每次都要調用一下自己加密函數，有點麻煩，也不利於給team內部其他人員，解決方法是把這個加密函數加到函數助手中去，這里我采用的方法是，將jmeter3.0的源代碼下載下來，引入到eclipse當中，找到函數助手的包名，然后添加對應的java文件，編譯，打包，再貼回到$JMETER_HOME/lib/ext/下面。網上有部分教程，但是不是很全，有些地方也沒有說明白，這里我整理一下。

 

另外，國外的網站上說有另外一種方法，是直接寫一個加密函數的java文件，包名必須名為.functions后綴，然后單獨打成jar包放到$JMETER_HOME/lib/ext/，這種方法可能簡單一點，然而我並沒有調試成功，如果有成功的朋友可以在下方留言。

 

我自己的方法步驟及代碼如下（關鍵部分代碼隱去）：

• 環境准備：

　　　　eclipse，這個就不細說了。

　　　　Jmeter3.0的源碼，下載地址是：http://jmeter.apache.org/download_jmeter.cgi，頁面上下載apache-jmeter-3.0_src.zip並解壓到硬盤即可。

　　　　這里有沒有ant不重要，我們這里只需要對函數助手打包即可。

• 把Jmeter源碼導入到eclipse：

　　　　不能按照普通的導入java項目的方法導入。導入步驟如下：

　　　　第一步：新建一個java項目，比如名字叫jmeter

　　　　第二步：打開jmeter項目存放位置，關閉eclipse，刪除jmeter目錄下bin和src兩個文件夾

　　　　

　　　　第三步：修改.classpath文件：編輯.classpath文件，用apache-jmeter-3.0_src解壓文件夾中的eclipse.classpath內容替換之。

 　　　　

　　　　第四部：重新打開eclipse，利用import導入源代碼。

　　　　

　　　　導入過后應該是這樣的：

　　　　

　　　　第五步：修改依賴，在build path中修改依賴包，加入$JMETER_HOME/lib下所有的jar包，同時加入$JMETER_HOME/lib/ext/ApacheJMeter_components.jar和$JMETER_HOME/lib/ext/ApacheJMeter_core.jar。

　　　　　　　　這樣差不多項目前面的感嘆號就消失了。

　　　　

 

到此，倒入jmeter源代碼的工作就完成了，我們可以加入代碼。

• 找到src/functions，這里存放了所有函數助手中包含的函數：

　　　　

• 我們這里增加一個java文件，我這里命名為AbbottEncry.java，關於依賴，可以參考下其他的java文件怎么寫的，貼進去就行了，當然也要引入你的方法需要用的jar包，比如我這里的加密所用的jar包。　　

　　　　具體代碼如下：代碼實現部分省略，前后的定義放出來供大家參考。

package org.apache.jmeter.functions;

import java.util.Collection;
import java.util.LinkedList;
import java.util.List;

import org.apache.jmeter.engine.util.CompoundVariable;
import org.apache.jmeter.samplers.SampleResult;
import org.apache.jmeter.samplers.Sampler;
import org.apache.jmeter.threads.JMeterVariables;
import org.apache.jmeter.util.JMeterUtils;
import net.heyfinance.aes.AesCryptUtil;
import net.sf.json.JSONObject;

/**
 * for Abbott
 * 
 * 
 */
public class AbbottEncry extends AbstractFunction {

//    private static final String CHARSET_ENCODING = "UTF-8"; //$NON-NLS-1$
    
    private static final List<String> desc = new LinkedList<>();

    private static final String KEY = "__AbbottEncry"; 
//這個是在函數助手上顯示的函數名稱

    static {
        desc.add(JMeterUtils.getResString("src_body")); 
        desc.add(JMeterUtils.getResString("base_args"));    
        desc.add(JMeterUtils.getResString("encrtion_key"));        
        desc.add(JMeterUtils.getResString("encr_body"));     
/*
        這里4個參數，就是我們在調用函數助手時，輸入的參數，這里有4個
        src_body =  要加密的串串
        base_args = 另外一條要加密的串串
        encrtion_key = 加密用的key
        encr_body = 加密后想存在jmeter中的參數名
*/
    }

    private Object[] values;
    public AbbottEncry() {
    }

    /** {@inheritDoc} */
    @Override
    public String execute(SampleResult previousResult, Sampler currentSampler)
            throws InvalidVariableException {
        JSONObject jsonThree = new JSONObject();        
        String encrString = ""; //$NON-NLS-1$
        String varName = ((CompoundVariable) values[values.length - 1]).execute().trim();
        JMeterVariables vars = getVariables();
        

        String srcBody = ((org.apache.jmeter.engine.util.CompoundVariable) values[0]).execute();
        String baseArgs = ((org.apache.jmeter.engine.util.CompoundVariable) values[1]).execute();
        String encrKey = ((org.apache.jmeter.engine.util.CompoundVariable) values[2]).execute(); 
//把參數轉換成String

        //此處略去。。。
        
        return encrString;
    }

    /** {@inheritDoc} */
    @Override
    public void setParameters(Collection<CompoundVariable> parameters) throws InvalidVariableException {
        checkParameterCount(parameters, 3, 4);
//這里，后面的3，4是指調用函數助手時，可以接受的參數個數，低於3就不會執行（這個地方，可能解釋不是很明確，后面再去看下官檔）
        values = parameters.toArray();
//把接受到的參數裝成array，然后用value[i]取出來。
    }

    /** {@inheritDoc} */
    @Override
    public String getReferenceKey() {
        return KEY;
    }

    /** {@inheritDoc} */
    @Override
    public List<String> getArgumentDesc() {
        return desc;
    }
}

 

•  寫完了以后我們可以打包了，右鍵src/functions用export功能達成jar包，注意3.0后，函數助手的名字叫ApacheJMeter_functions.jar。打成jar包后，放到$JMETER_HOME/lib/ext/注意備份一下原來文件。

　　　　另外，自己的函數依賴包要放到$JMETER_HOME/lib。

　　　　

　　　　

• 重新啟動Jmeter就行了，我們可以看到我們需要的函數了。這里還有個小bug，暫時不知道原因，第一次進去函數助手，看到自己的函數的時候，發現參數列表是空的，我以為是程序問題，但是選擇一個別的函數，然后再選回到自己的函數上，參數又出現了，並且可以正常使用，暫時不知道原因，有興趣的朋友可以討論下。

　　　　

　　　　

 

 至此，文章結束。