springboot vue測試平臺介面定義及傳送請求功能實現

2022-05-26 18:04:17

基於 springboot+vue 的測試平臺開發

繼續更新

新增的介面，我要來偵錯確定是否是通的，那麼要傳送介面請求，今天來實現這個功能，先預覽一下：

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

點選傳送按鈕，呼叫後端介面後端介面處理內部，傳送http介面請求後端介面把響應返回給前端展示

一、http使用者端選型

為了更方便快捷的開發功能，直接選用 hutool 框架中封裝好的 http使用者端。

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

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

HttpRequest

HttpResponse

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

看過介紹，我瀏覽了下原始碼，然後測試了一下，發現可以滿足我使用需求。

//    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);
    }

比如，傳送get請求，HttpUtil 其實是基於 HttpRequest 的進一步分裝，我這裡還是直接統一使用 HttpRequest 。

另外，傳送 post 請求也很簡單，可以直接傳入 json 字串：

@Test
    void testPost() {
        String reqBody = "{n" +
                "    "projectName": "專案zzz1",n" +
                "    "description": "測試新增專案"n" +
                "}";
 
        //鏈式構建請求
        String result3 = HttpRequest.post("http://localhost:8080/bloomtest/project/add")
//                .header(Header.CONTENT_TYPE, "application/json")//頭資訊，多個頭資訊多次呼叫此方法即可
//                .timeout(20000)//超時，毫秒
                .body(reqBody)
                .execute().body();
    }

關於http請求的常用資訊，請求頭、引數、delete/put 等等其他方法，框架都是支援的，目前我只實現最基本的需求。

二、後端介面實現

測試過了上面的程式碼，心裡就有數了，在後端介面裡就看怎麼使用它了。

這個傳送請求的介面，目前需要支援如下：

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

header暫時先不加，目前我專案裡的介面都不需要傳指定的 header，後期實現了許可權之後再對應完善程式碼。

1. controller 層

ApiDefinitionController 類中繼續新增處理器方法。

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

2. service 層

對應service層實現，先放出全部程式碼，目前還是以初期實現為主，程式碼後續可能會進一步優化：

public JSONObject apiTestRun(ApiRunTestRequest request) {
 
      // url 拼接
      String url = request.getHost() + request.getPath();
      // 判斷不同請求引數型別：0 query引數，1 rest引數， 2使用 body引數
      int queryType = request.getRequestType();
      if (queryType == 0) {
          // query 引數
          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引數
          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後面的引數，還原path
          List<String> list = Arrays.asList(request.getPath().split("/\{"));
          String orginPath = list.get(0);
          // 解析path中的引數，確認引數拼接順序
          List<String> resultFindAll = ReUtil.findAll("(?<=\{)(.+?)(?=\})", request.getPath(), 0);
          String appendParamPath = "";
          for (String i : resultFindAll) {
              appendParamPath = appendParamPath.concat("/" + paramMap.get(i));
          }
          // 傳送請求
          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;
  }

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

根據引數型別，分別對於 query、rest、body 的請求引數情況進行處理
在其中每種型別裡，又區分了 get、post 方法

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

(1)query 引數

主要是前面的 2 步：

拿到前端的入參，解析成 JSONArray，內部元素型別又是 JSONObject

遍歷 JSONArray，通過jsonArray.getJSONObject(i)方法獲取各 JSONObject 的 key，對應前端入參的queryKey和value，就是引數名和引數值。

接著傳送請求，拿到的返回是一個 String，解析成 JSONObject 返回給 controller

(2)rest 引數

處理 rest 引數稍微麻煩了些，比如：localhost:8080/bloomtest/module/list/3，最後的3才是引數。

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

獲取前端傳來的引數

首先跟上面一樣，獲取到前端的引數名和值，放到 HashMap 裡，熟悉 python的童鞋就當作放到字典裡了。

解析path中的引數，確認引數拼接順序

因為引數名需要跟 url 裡的拼接的值順序對應上才行，介面裡儲存的url是這樣的：/bloomtest/module/list/{projectId}，大括號裡的就是引數。

所以這裡使用了正則去匹配我要的內容，表示式(?<={)(.+?)(?=})我搜的，具體我也不熟悉，後續再學習。

ReUtil.findAll方法也是來自於 hutool 框架，可以查詢到所有符合表示式的內容，返回是一個陣列。

然後遍歷這個陣列，把裡面的引數逐個拼接到一個空字串裡appendParamPath:

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

去掉path後面的引數，還原path

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

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

使用了字串分割split方法，返回的是一個String[]陣列，又通過Arrays.asList進一步做了轉化，就可以使用get(0)獲取第一個使用了，也就是/bloomtest/module/list。

前面都齊了，就可以傳送請求了，注意最終請求的 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 帶的處理，會有報錯，搞了好一會。