腳本之家服務(wù)器常用軟件

快捷導(dǎo)航

springboot?vue測試平臺接口定義及發(fā)送請求功能實現(xiàn)

更新時間：2022年05月26日 14:42:06 作者：把蘋果咬哭的測試筆記

這篇文章主要為大家介紹了springboot+vue測試平臺接口定義及發(fā)送請求功能實現(xiàn)，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進(jìn)步，早日升職加薪

基于 springboot+vue 的測試平臺開發(fā)

繼續(xù)更新

添加的接口，我要來調(diào)試確定是否是通的，那么要發(fā)送接口請求，今天來實現(xiàn)這個功能，先預(yù)覽一下：

捋一下思路，分為三步走：

點擊發(fā)送按鈕，調(diào)用后端接口后端接口處理內(nèi)部，發(fā)送http接口請求后端接口把響應(yīng)返回給前端展示

一、http客戶端選型

為了更方便快捷的開發(fā)功能，直接選用 hutool 框架中封裝好的 http客戶端。

官方介紹：Hutool-http 針對JDK 的HttpUrlConnection做一層封裝，簡化了HTTPS請求、文件上傳、Cookie記憶等操作，使Http請求變得無比簡單。

Hutool-http的核心集中在兩個類：

HttpRequest

HttpResponse

同時針對大部分情境，封裝了HttpUtil工具類。根據(jù)Hutool的“便捷性與靈活性并存”原則，HttpUtil 的存在體現(xiàn)了便捷性，那 HttpRequest對象的使用則體現(xiàn)了靈活性，使用此對象可以自定義更多的屬性給請求，以適應(yīng)Http請求中的不同場景(例如自定義header、自定義cookie、自定義代理等等)。

看過介紹，我瀏覽了下源代碼，然后測試了一下，發(fā)現(xiàn)可以滿足我使用需求。

//    get1
    @Test
    void get1() {
        String result1 = HttpUtil.get("http://localhost:8080/bloomtest/user/useInfo?token=admin-token");
        System.out.println(result1);
    }
    //    get2
    @Test
    void get2() {
        Map<String, Object> paramMap = new HashMap<>();
        paramMap.put("id", 33);
        String result2 = HttpRequest.get("http://localhost:8080/bloomtest/apiDefinition/getApi")
                    .form(paramMap)
                    .execute()
                    .body();
        System.out.println(result2);
    }

比如，發(fā)送get請求，HttpUtil 其實是基于 HttpRequest 的進(jìn)一步分裝，我這里還是直接統(tǒng)一使用 HttpRequest 。

另外，發(fā)送 post 請求也很簡單，可以直接傳入 json 字符串：

@Test
    void testPost() {
        String reqBody = "{\n" +
                "    \"projectName\": \"項目zzz1\",\n" +
                "    \"description\": \"測試新增項目\"\n" +
                "}";
 
        //鏈?zhǔn)綐?gòu)建請求
        String result3 = HttpRequest.post("http://localhost:8080/bloomtest/project/add")
//                .header(Header.CONTENT_TYPE, "application/json")//頭信息，多個頭信息多次調(diào)用此方法即可
//                .timeout(20000)//超時，毫秒
                .body(reqBody)
                .execute().body();
    }

關(guān)于http請求的常用信息，請求頭、參數(shù)、delete/put 等等其他方法，框架都是支持的，目前我只實現(xiàn)最基本的需求。

二、后端接口實現(xiàn)

測試過了上面的代碼，心里就有數(shù)了，在后端接口里就看怎么使用它了。

這個發(fā)送請求的接口，目前需要支持如下：

get、post 方法查詢參數(shù)(/list?id=3)、rest參數(shù)(/list/3)以及請求 body(json)

header暫時先不加，目前我項目里的接口都不需要傳指定的 header，后期實現(xiàn)了權(quán)限之后再對應(yīng)完善代碼。

1. controller 層

ApiDefinitionController 類中繼續(xù)新增處理器方法。

@PostMapping("/apiTestRun")
  public Result apiTestRun(@RequestBody ApiRunTestRequest apiRunTestRequest) {
      return Result.success(apiDefinitionService.apiTestRun(apiRunTestRequest));
  }

2. service 層

對應(yīng)service層實現(xiàn)，先放出全部代碼，目前還是以初期實現(xiàn)為主，代碼后續(xù)可能會進(jìn)一步優(yōu)化：

public JSONObject apiTestRun(ApiRunTestRequest request) {
 
      // url 拼接
      String url = request.getHost() + request.getPath();
      // 判斷不同請求參數(shù)類型：0 query參數(shù)，1 rest參數(shù)， 2使用 body參數(shù)
      int queryType = request.getRequestType();
      if (queryType == 0) {
          // query 參數(shù)
          HashMap<String, Object> paramMap = new HashMap<>();
          JSONArray jsonArray = JSONArray.parseArray(request.getRequest());
          for (int i=0; i<jsonArray.size(); i++) {
              paramMap.put(jsonArray.getJSONObject(i).get("queryKey").toString(), jsonArray.getJSONObject(i).get("value"));
          }
          if (request.getMethod().equals("get")) {
              String result = HttpRequest.get(url)
                      .form(paramMap)
                      .execute()
                      .body();
              return JSONObject.parseObject(result);
          }
          if (request.getMethod().equals("post")) {
              String result = HttpRequest.post(url)
                      .form(paramMap)
                      .execute()
                      .body();
              return JSONObject.parseObject(result);
          }
      } else if (queryType == 1) {
          // rest參數(shù)
          HashMap<String, Object> paramMap = new HashMap<>();
          JSONArray jsonArray = JSONArray.parseArray(request.getRequest());
          for (int i=0; i<jsonArray.size(); i++) {
              paramMap.put(jsonArray.getJSONObject(i).get("restKey").toString(), jsonArray.getJSONObject(i).get("value"));
          }
          // 去掉path后面的參數(shù)，還原path
          List<String> list = Arrays.asList(request.getPath().split("/\\{"));
          String orginPath = list.get(0);
          // 解析path中的參數(shù)，確認(rèn)參數(shù)拼接順序
          List<String> resultFindAll = ReUtil.findAll("(?<=\\{)(.+?)(?=\\})", request.getPath(), 0);
          String appendParamPath = "";
          for (String i : resultFindAll) {
              appendParamPath = appendParamPath.concat("/" + paramMap.get(i));
          }
          // 發(fā)送請求
          if (request.getMethod().equals("get")) {
              String result = HttpRequest
                      .get(request.getHost() + orginPath + appendParamPath)
                      .execute()
                      .body();
              return JSONObject.parseObject(result);
          }
          if (request.getMethod().equals("post")) {
              String result = HttpRequest
                      .post(request.getHost() + orginPath + appendParamPath)
                      .execute()
                      .body();
              return JSONObject.parseObject(result);
          }
 
      } else if (queryType == 2) {
          // 請求體
          if (request.getMethod().equals("post")) {
              String reqBody = request.getRequest();
              String result = HttpRequest.post(url)
                      .body(reqBody)
                      .execute().body();
              return JSONObject.parseObject(result);
          }
          // 請求體
          if (request.getMethod().equals("get")) {
              String reqBody = request.getRequest();
              String result = HttpRequest.get(url)
                      .body(reqBody)
                      .execute().body();
              return JSONObject.parseObject(result);
          }
      }
      return null;
  }

乍一看比較多，其實分開看就好：

根據(jù)參數(shù)類型，分別對于 query、rest、body 的請求參數(shù)情況進(jìn)行處理
在其中每種類型里，又區(qū)分了 get、post 方法

簡單介紹下其中各種的要點。

(1)query 參數(shù)

主要是前面的 2 步：

拿到前端的入?yún)?，解析?JSONArray，內(nèi)部元素類型又是 JSONObject

遍歷 JSONArray，通過jsonArray.getJSONObject(i)方法獲取各 JSONObject 的 key，對應(yīng)前端入?yún)⒌膓ueryKey和value，就是參數(shù)名和參數(shù)值。

接著發(fā)送請求，拿到的返回是一個 String，解析成 JSONObject 返回給 controller

(2)rest 參數(shù)

處理 rest 參數(shù)稍微麻煩了些，比如：localhost:8080/bloomtest/module/list/3，最后的3才是參數(shù)。

處理過程就像我注視寫的：

獲取前端傳來的參數(shù)

首先跟上面一樣，獲取到前端的參數(shù)名和值，放到 HashMap 里，熟悉 python的童鞋就當(dāng)作放到字典里了。

解析path中的參數(shù)，確認(rèn)參數(shù)拼接順序

因為參數(shù)名需要跟 url 里的拼接的值順序?qū)?yīng)上才行，接口里保存的url是這樣的：/bloomtest/module/list/{projectId}，大括號里的就是參數(shù)。

所以這里使用了正則去匹配我要的內(nèi)容，表達(dá)式(?<=\{)(.+?)(?=\})我搜的，具體我也不熟悉，后續(xù)再學(xué)習(xí)。

ReUtil.findAll方法也是來自于 hutool 框架，可以查找到所有符合表達(dá)式的內(nèi)容，返回是一個數(shù)組。

然后遍歷這個數(shù)組，把里面的參數(shù)逐個拼接到一個空字符串里appendParamPath:

String appendParamPath = "";
  for (String i : resultFindAll) {
      appendParamPath = appendParamPath.concat("/" + paramMap.get(i));
  }

去掉path后面的參數(shù)，還原path

因為前端傳過來的 path 是/bloomtest/module/list/{projectId}，需要去掉最后的/{projectId}才可以使用。

List<String> list = Arrays.asList(request.getPath().split("/\\{"));
  String orginPath = list.get(0);

使用了字符串分割split方法，返回的是一個String[]數(shù)組，又通過Arrays.asList進(jìn)一步做了轉(zhuǎn)化，就可以使用get(0)獲取第一個使用了，也就是/bloomtest/module/list。

前面都齊了，就可以發(fā)送請求了，注意最終請求的 url 還是要拼接一下：request.getHost() + orginPath + appendParamPath

(3)請求體

這個最簡單，前端傳過來的 json 字符串直接傳入即可：

if (request.getMethod().equals("post")) {
      String reqBody = request.getRequest();
      String result = HttpRequest.post(url)
              .body(reqBody)
              .execute().body();
      return JSONObject.parseObject(result);
  }

要注意的是，這里用的 JSONObject 是來自fastjson，之前用 hutool 帶的處理，會有報錯，搞了好一會。