实际业务中，会要求 HTTP 协议中附加 MD5 校验字段， 防止请求参数被恶意篡改， 对于开发同学来说， 这是个很简单的需求。 但是给自动化测试增加了难度， Jmeter 原生不支持这个功能，应测试同学要求，开发了一个简单的小插件。
一、功能分析
1. MD5 值生成规则：
Step1, HTTP 请求增加新参数 ct, 值为当前时间毫秒数；
Step2, 获取HTTP 请求所有参数，放入 list;
Step3, List 增加新参数 key, 值根据通信协议的双方约定(不在 http请求中传递 );
Step4, 把 List 按参数名进行排序，把排序后的参数值进行拼接， 对拼接结果执行 MD5 运算；
Step5, Http请求增加新参数 code, 值是 Step4 计算得出的值。
注：不同业务此规则可能略有差异，请根据实际情况实现。
2. MD5 值需要在 HTTP 请求之前添加 (属于 Jmeter 前置处理器范围)。
二、需要解决的问题
1. 在 Jmeter 的 HTTP 请求中获取参数、 增加参数
2. 实现 MD5 的具体逻辑
3. 在合适的时机把生成的 MD5 校验值附加到 HTTP 请求参数中
4. 集成到 Jmeter 菜单中，方便使用。
三、解决步骤
1. 因之前没有 Jmeter 插件开发经验， 需要先学习一下如何开发。 网上搜集了一下资料没有太明确的方案；不过Jmeter本身有很多插件，就从这里入手，分析一下现有插件的实现方式，然后用相同的方式来完成插件。
2. 到 Apache 官网 下载 Jmeter 的源代码（我使用的2.11版）， 根据 Jmeter 界面中看到的关键字来定位插件代码位置。
3. 开发的是 Http Sampler 插件，那么，我们先搜索一下Http Sampler关键字， 可以找到 HttpSampler.java；阅读代码可以得到问题1的答案。
4. 问题2不在赘述。
5. 分析问题3， 我们需要在 HTTP 请求发送前， 进行插件调用， 可以得知这个插件应该是属于前置处理器范围的。 通过分析前置处理器的代码应该可以解决这个问题。Jmeter 插件中第一个前置处理器是 BeanShell PreProcessor， 用 BeanShell 和 PreProcessor 关键字查找源代码, 查到了类 BeanShellPreProcessor.java；阅读这个类及父类代码可以得到问题3、问题4的答案。
四、具体代码
1. MD5PreProcessor.java
public class MD5PreProcessor extends AbstractTestElement implements TestStateListener, PreProcessor, Serializable {
private static final long serialVersionUID = -1L;
private static final Logger LOGGER = LoggingManager.getLoggerForClass();
/**
* Default constructor.
*/
public MD5PreProcessor() {
}
@Override
public void testStarted() {
}
@Override
public void testStarted(String host) {
}
@Override
public void testEnded() {
}
@Override
public void testEnded(String host) {
}
/*
* ------------------------------------------------------------------------
* Methods implemented from interface org.apache.jmeter.config.Modifier
* ------------------------------------------------------------------------
*/
@Override
public void process() {
Sampler sam = getThreadContext().getCurrentSampler();
HTTPSamplerBase sampler = null;
if (!(sam instanceof HTTPSamplerBase)) {
return;
} else {
sampler = (HTTPSamplerBase) sam;
}
// 排序参数和header(appversion, os)
java.util.List<KeyValue> list = new ArrayList<KeyValue>();
sampler.addArgument("ct", System.currentTimeMillis() + "");
// 添加参数列表
Arguments arguments = sampler.getArguments();
PropertyIterator iter = arguments.iterator();
while(iter.hasNext()) {
Argument arg = getFromJMeterProperty(iter.next());
KeyValue kv = new KeyValue(arg.getName(), arg.getValue());
list.add(kv);
}
// 添加header: os appVersion
HeaderManager headerManager = sampler.getHeaderManager();
for(int i = 0; i < headerManager.getHeaders().size(); i++) {
Header a = headerManager.getHeader(i);
if("os".equals(a.getName()) || "appVersion".equals(a.getName())) {
list.add(new KeyValue(a.getName(), a.getValue()));
}
}
// 加盐
list.add(new KeyValue("key", "+MrK}6seb#$E"));
StringBuffer sbu = new StringBuffer();
// 按顺序拼接所有参数值
Collections.sort(list);
for(KeyValue kv : list) {
//LOGGER.info("key: "+kv.getKey()+", value:"+kv.getValue());
sbu.append(kv.getValue());
}
try {
MessageDigest md = MessageDigest.getInstance("MD5");
byte[] md5sum = md.digest(URLEncoder.encode(sbu.toString(), "UTF-8").getBytes());
String md5Code = new BigInteger(1, md5sum).toString(16);
while(md5Code.length() < 32 ){
md5Code = "0"+md5Code;
}
LOGGER.info("before: "+sbu.toString()+",encode:"+URLEncoder.encode(sbu.toString(), "UTF-8")+",end:"+md5Code);
sampler.addArgument("code", md5Code);
} catch(Exception e) {
e.printStackTrace();
}
}
private Argument getFromJMeterProperty(JMeterProperty o) {
return (Argument)o.getObjectValue();
}
/*
* ------------------------------------------------------------------------
* Methods
* ------------------------------------------------------------------------
*/
private class KeyValue implements Comparable<KeyValue> {
private String key;
private String value;
public KeyValue(String key, String value) {
this.key = key;
this.value = value;
}
@Override
public int compareTo(KeyValue o) {
int result = this.key.compareTo(o.key);
if(result == 0) {
result = this.value.compareTo(o.value);
}
return result;
}
public String getKey() {
return key;
}
public String getValue() {
return value;
}
}
}
2. Md5PreProcessorGui.java
public class Md5PreProcessorGui extends AbstractPreProcessorGui {
private static final long serialVersionUID = 100L;
private static final Logger LOGGER = LoggingManager.getLoggerForClass();
public Md5PreProcessorGui() {
createGui();
}
public String getStaticLabel() {
return "MD5 Encode";
}
public String getLabelResource() {
return getClass().getCanonicalName();
}
public void configure(TestElement element) {
super.configure(element);
}
public TestElement createTestElement() {
MD5PreProcessor sampler = new MD5PreProcessor();
modifyTestElement(sampler);
return sampler;
}
public void modifyTestElement(TestElement element) {
element.clear();
configureTestElement(element);
}
public void clearGui() {
super.clearGui();
}
private void createGui() {
setLayout(new BorderLayout(0, 5));
setBorder(makeBorder());
this.setLayout(new BorderLayout(0, 5));
this.setBorder(this.makeBorder());
this.add(this.makeTitlePanel(), "North");
VerticalPanel mainPanel = new VerticalPanel();
add(mainPanel, "Center");
}
}