接口自动化测试(httpclient)

使用的自动化框架

java + httpclient + log4j + json + mybatis + excel + testng

• excel : API 管理
• httpclient：接口请求
• log4j：脚本log记录
• json-lib：接口返回数据的解析
• mybatis： 脚本与数据库的交互
• testng：测试用例管理，断言

excel

httpclient ( get / post)

/** * get 形式请求API *
 * @param uri url 和 对应参数
 * @param @key key 
 * @return 返回相应信息 
 * @throws java.net.URISyntaxException 
 * @throws java.io.IOException 
 */
  public static JSON getAPI(URI uri) throws URISyntaxException, IOException {    
          CloseableHttpClient httpclient = HttpClients.createDefault();    
          try {
               httpget = new HttpGet(uri);  
               log.info("执行API请求" + httpget.getRequestLine());
               ResponseHandler<String> responseHandler = new ResponseHandler<String>() { 
            public String handleResponse(final HttpResponse response) throws ClientProtocolException, IOException {                
                int status = response.getStatusLine().getStatusCode();
                if (status >= 200 && status < 300) {
                    HttpEntity entity = response.getEntity();
                    return entity != null ? EntityUtils.toString(entity) : null;
                } else {
                    log.error("请求错误，状态码为：" + response.getStatusLine().getStatusCode());
                    throw new ClientProtocolException("意外的状态返回: " + status);
                } 
           } 
       };
        String responseBody = httpclient.execute(httpget, responseHandler);
        JSONObject dataObject = JSONObject.fromObject(responseBody.trim());
        return dataObject;
    } finally {
        httpclient.close(); 
   }
}

/** * Post 形式请求API *
 * @param uri url 和 对应参数 
 * @param @key key 
 * @return 返回相应信息
 * @throws java.net.URISyntaxException
 * @throws java.io.IOException 
 */
 public static JSON postAPI(URI uri) throws URISyntaxException, IOException {
    CloseableHttpClient httpclient = HttpClients.createDefault();
    try {
        httpPost = new HttpPost(uri); 
        log.info("执行API接口请求" + httpPost.getRequestLine());
        ResponseHandler<String> responseHandler = new ResponseHandler<String>() {
            public String handleResponse(
                    final HttpResponse response) throws ClientProtocolException, IOException {
                int status = response.getStatusLine().getStatusCode();
                if (status >= 200 && status < 300) {
                    HttpEntity entity = response.getEntity();
                    return entity != null ? EntityUtils.toString(entity) : null;
                } else {
                    throw new ClientProtocolException("意外的状态返回: " + status);
                }
            } 
       };
        String responseBody = httpclient.execute(httpPost, responseHandler);
        JSONObject dataObject = JSONObject.fromObject(responseBody);
        return dataObject;
    } finally {
        httpclient.close();
    }
}

log4g

###set output encoding###
log4j.appender.logfile.encoding=UTF-8

### set log levels ###
log4j.rootLogger = INFO , ERROR  ,stdout , logfile

### 控制台输出 ###
log4j.appender.stdout=org.apache.log4j.ConsoleAppender
log4j.appender.stdout.Target = System.out
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
log4j.appender.stdout.layout.ConversionPattern=%-d{yyyy-MM-dd HH:mm:ss} %p %t [%c]%M(line:%L)%m%n

### save error log ###
log4j.appender.ERROR = org.apache.log4j.DailyRollingFileAppender
log4j.appender.ERROR.File = logs/error.log
log4j.appender.ERROR.Append = true
log4j.appender.ERROR.Threshold = ERROR
log4j.appender.ERROR.layout = org.apache.log4j.PatternLayout
log4j.appender.ERROR.layout.ConversionPattern =%-d{yyyy-MM-dd HH:mm:ss} %p %t [%c]%M(line:%L)%m%n

### write in log ###
log4j.appender.logfile = org.apache.log4j.DailyRollingFileAppender
log4j.appender.logfile.File=logs/debug.log
log4j.appender.logfile.Append = true
log4j.appender.logfile.Threshold = DEBUG
log4j.appender.logfile.layout=org.apache.log4j.PatternLayout
log4j.appender.logfile.layout.ConversionPattern=%-d{yyyy-MM-dd HH:mm:ss} %p %t [%c]%M(line:%L)%m%n

mybatis：跟mysql交互

• 根据表名创建各跟表名一样的类 例如Account_info表如下，并定义跟表结构一样的字段。
• 新建一个interface(如Account_infoDao) 创建一个方法，参数为mysql语句中你想通过什么查询的，例如下面我想通过account_id来查询出Accounts_info表的某行数据
• 实现接口interface(如Account_infoDaoImpl)
• 新建mapper文件（如新建个Accounts_infoMapper.xml文件）
• 在config.xml文件配置上mapper文件路径，如下Accounts_infoMapper.xml 路径
• 新建个类，用于接口需要时调用
• 接口需要处使用

  public class Accounts_infoTest {
    static Accounts_infoDao accountsDao = new Accounts_InfoDaoImpl();    

/*** 通过account_id查询出 accounts_info表数据
     * @param account_id 用户id
     * @return account_info 表数据 
    */
    public static Accounts_Info byAccount_id(String account_id){
        Accounts_info a = accountsDao.account_id(account_id);
        return a;
    }

 Accounts_info accounts_info=Accounts_infoTest.byAccount_id(Integer.valueOf(account_id));
int coin_num_sql = accounts_info.getCoin();// 拿到数据库中 coin_num 字段

返回json解析

• 例1

// 拿到response_status对应的值success
 String response_status = jsonObject .getString("response_status");
// 拿到post_enable的值1
    String post_enable = json.getJSONObject("info").getJSONObject("data").getJSONObject("priv_option").getString("post_enable");

• 例2 返回的json是一组一组的

// 拿到list下多个组数据
 JSONArray jsonArray = json.getJSONObject("info").getJSONObject("data").getJSONArray("list"); 

// 获取组数据中第一个数据（数组从0开始）并强制转成json格式
 JSONObject jsonObject = (JSONObject) jsonArray.get(0);

String id = jsonObject.getString("id");// 获取强制转成json后的id

创建一个自动化API脚本的步骤

• 从api文档地址查找到对应api
• 配置对应api的 信息到 excel 表格
  • 唯一标示（tid），协议（http），服务器地址与端口，api路径，api参数（0到多个）
• 新建个跟API 同名的类（例如LoginTest）
• 发起请求
  • JSONObject jsonObject = ApiEngine.taquAPI(唯一标识, Parameters.KEY,参数1的值，参数2的值);
• Html例子
  • Document document= ApiEngine.XXXAPIHtml(tid, m, a, ticket_id);
• log.info(jsonObject) 输出jsonObject 便于控制台查看结果

可能遇到的问题

• 控制台输出如下，可能你代码中的tid唯一标示在excel不存在或者excel编写后未能保存

  
  

• 控制台输入如下 可能原因 excel 配置的参数个数和代码发起请求是给的参数值的个数不一致通常发起请求代码给的参数个数大于excel配置的个数

  
  

• 错误提示 【x】【y】单元格为空，请。。。。 类似问题基本上解决方案是打开excel 找到第X+1 行 第Y+1 列，随便数据数据，保存，右键清空数据