在这里,我们可以看到,在url,header,param中,我们使用了${param_name}的形式,这些变量可以从我们的公共参数池中取得,而后面的verify,可以对返回值使用JSONPath来精准判定。而对于,save中的内容,我们可以将其存入公共参数池,供后面的接口进行调用。
/** * 公共参数数据池(全局可用) */ private static Map<String, String> saveDatas = new HashMap<String, String>(); /** * 替换符,如果数据中包含“${}”则会被替换成公共参数中存储的数据 */ protected Pattern replaceParamPattern = Pattern.compile("\\$\\{(.*?)\\}"); /** * 获取公共数据池中的数据 * * @param key * 公共数据的key * @return 对应的value */ protected String getSaveData(String key) { if ("".equals(key) || !saveDatas.containsKey(key)) { return null; } else { return saveDatas.get(key); } } protected void setSaveDatas(Map<String, String> map) { saveDatas.putAll(map); }
在使用过程中,我们可以将参数分为两类。第一类为全局参数,意思是可以将之前从xml中读取的配置,作为全局参数存入公共参数数据池,在整个接口测试运行的过程中均可进行调用。第二类是,接口过程中产生对的过程参数,即,接口A返回的数据,可以作为参数使用在接口B的请求中。这类参数在接口请求执行过程中进行定义,也存入公共参数池。
这两类参数,均使用${param_name}的形式进行调用。来看下面一段代码:
/** * 取公共参数 并替换参数,处理${} * @param param * @return */ protected String getCommonParam(String param) { if (stringUtil.isEmpty(param)) { //stringUtil后续进行说明 return ""; } Matcher m = replaceParamPattern.matcher(param);// 取公共参数正则 while (m.find()) { String replaceKey = m.group(1); // 如果公共参数池中未能找到对应的值,该用例失败。 Assert.assertNotNull(replaceKey, String.format("格式化参数失败,公共参数中找不到%s。", replaceKey)); String value; // 从公共参数池中获取值 value = getSaveData(replaceKey); //如果值不为空,则将参数替换为公共参数池里读取到的value的值。 if(null != value) { param = param.replace(m.group(), value); //如果值为空,则将参数替换为字符串“null” }else { param = param.replace(m.group(), "null"); } } return param; }
这里使用了正则表达式来匹配参数中出现的${XXXX}形式的字符串。这一段的主要思想为,使用定义好的正则表达式来匹配param的字符串,如果匹配的到,则进行循环,把匹配到的第一个字符串(基本就是1个字符串)作为key,然后到saveData的Map中取得对应的值,并返回。
这样,我们就实现了使用${param_name}的形式,调用公共参数池的目的。
那么说完了“取参数”,我们还需要说一下“存参数”。在接口测试执行的过程中,假如我想把某个返回的值作为参数,存入公共参数池中,我们应该怎么做呢?
/** * 提取json串中的值保存至公共池中 * * @param json * 将被提取的json串。 * @param allSave * 所有将被保存的数据:xx=$.jsonpath.xx;将$.jsonpath. * xx提取出来的值存放至公共池的xx中 */ protected void saveResult(String json, String allSave) { if (null == json || "".equals(json) || null == allSave || "".equals(allSave)) { return; } allSave = getCommonParam(allSave); String[] saves = allSave.split(";"); String key, value; for (String save : saves) { Pattern pattern = Pattern.compile("([^;=]*)=([^;]*)"); Matcher m = pattern.matcher(save.trim()); while (m.find()) { key = getBuildValue(json, m.group(1)); //getBuildValue的方法后续说明 value = getBuildValue(json, m.group(2)); reportUtil.log(String.format("存储公共参数 %s值为:%s.", key, value)); saveDatas.put(key, value); } } }
这里我们在save时,同样是通过正则表达式来进行匹配,具体的形式类似于 aa=$.Content.User 的形式,即变量名=JSONPath,将JSONPath找到的值来赋此变量,并存储到公共参数池中。
这里提到了一个getBuildValue的方法,具体的代码如下:
/** * 获取格式化后的值 * * @param sourchJson * @param key * @return */ private String getBuildValue(String sourchJson, String key) { key = key.trim(); Matcher funMatch = funPattern.matcher(key); //funPattern为函数匹配正则表达式,后续进行说明 if (key.startsWith("$.")) {// 如果为JSONPath,获取该JSONPath对应的值(对象) Object x = JSONPath.read(sourchJson, key);
//空值处理 if(x == null) { key = (String)x; }else { key = x.toString(); }
//如果匹配到的是自定义函数,则先解析该自定义函数的参数,若该自定义函数的参数中有JSONPath,则对该JSONPath取值,并对应转成字符串对象。 } else if (funMatch.find()) { String args = funMatch.group(2); String[] argArr = args.split(","); for (int index = 0; index < argArr.length; index++) { String arg = argArr[index]; if (arg.startsWith("$.")) { argArr[index] = JSONPath.read(sourchJson, arg).toString(); } } String value = functionUtil.getValue(funMatch.group(1), argArr); // functionUtil为自定义函数工具类,后续说明 key = stringUtil.replaceFirst(key, funMatch.group(), value); } return key; }
那么,通过以上的代码,我们可以较为清晰的看到,我们设计了这个公共参数池,来对全局参数和过程参数进行管理,即可取也可存。方便了在之后的代码中进行调用。
在上面的代码中,我们出现了一个stringUtil的工具类,这算是一个字符串处理工具。请看以下代码:
public class stringUtil { public static boolean isNotEmpty(String str) { return null != str && !"".equals(str); } public static boolean isEmpty(String str) { return null == str || "".equals(str); } /** * * @param sourceStr 待替换字符串 * @param matchStr 匹配字符串 * @param replaceStr 目标替换字符串 * @return */ public static String replaceFirst(String sourceStr,String matchStr,String replaceStr){ int index = sourceStr.indexOf(matchStr); int matLength = matchStr.length(); int sourLength = sourceStr.length(); String beginStr = sourceStr.substring(0,index); String endStr = sourceStr.substring(index+matLength,sourLength); sourceStr = beginStr + replaceStr + endStr; return sourceStr; } }
这个工具类中,写了判定字符串是否为空的方法,还有一个替换首个匹配字符串的方法。有兴趣的童鞋可以自行继续扩展。