在Java中，使用HttpUtils實現傳送HTTP請求

馮文議發表於2023-03-12
JavaHTTP
微信公眾號：馮文議（ID：fwy-world）

HTTP請求，在日常開發中，還是比較常見的，今天給大家分享HttpUtils如何使用。

閱讀本文，你將收穫：

  • 簡單總結HTTP請求常用配置；
  • JavaLib中HttpUtils如何使用；
  • 如何封裝HTTP請求工具類。

第一部分：簡單總結HTTP請求常用配置

大家好，在 Java 開發中，經常遇到需要呼叫第三方提供的介面服務，常見的形式是 HTTP + JSON，下面，就對 http 請求常見的設定，做一個說明

http提供多種請求方式，以滿足我們日常需要，先按請求方式來做說明：

  • GET
  • POST
  • PUT
  • PATCH
  • DELETE

在 RESTful API 開發中，我們可以根據這些請求方式設計我們的API介面。舉例：

  • GET：獲取資源
  • POST：提交資源
  • PUT：更新完整資源
  • PATCH：更新部分資源
  • DELETE：刪除資源

引數格式

  • form表單
  • json

其他

  • 超時時間設定

第二部分：使用JavaLib的HttpUtils

簡單的get請求

System.out.println(HttpUtils.get("https://www.baidu.com"));

響應結果：

baidu

透過簡單嘗試，證明兩點：

  • 一是，這個還是可以使用的；
  • 二是，原來使用如此簡單。

如果要你手寫一個http請求，或許你腦海裡一篇空白，會去搜尋各種資料。

我們再試一個複雜的

介面：

介面地址：https://erwin-api.fengwenyi.com/erwin/blog/page
請求方法：GET
引數：currentPage，pageSize
引數格式：form
響應：application/json

部落格列表分頁查詢介面

String url = "https://erwin-api.fengwenyi.com/erwin/bookmark/page?currentPage=1&pageSize=10";

Request request = new Request();
request.setUrl(url);
request.setMethod(Request.Method.GET);

Map<String, String> headerMap = new HashMap<>();
headerMap.put("Accept", "application/json");

Request.Option option = new Request.Option();
option.setHeaders(headerMap);

try {
    System.out.println(HttpUtils.execute(request, option));
} catch (IOException e) {
    throw new RuntimeException(e);
}

響應結果：

{
    "code":"SUCCESS",
    "message":"Success",
    "success":true,
    "header":null,
    "body":{
        "currentPage":1,
        "pageSize":10,
        "totalRows":661,
        "totalPages":67,
        "content":[
            {
                "id":"1634772578877935617",
                "timestamp":1678595130000,
                "enabledState":null,
                "name":"VScode 中文顯示出現黃色方框的解決方法_vscode漢字被框住_YJer的部落格-CSDN部落格",
                "url":"https://blog.csdn.net/qq_33249042/article/details/123252625",
                "icon":null,
                "classifyName":"軟體",
                "classifyId":"1522587269600481281"
            },
            {
                "id":"1632640455110922241",
                "timestamp":1678086792000,
                "enabledState":null,
                "name":"Spring中init-method和destroy-method的四種方式_星夜孤帆的部落格-CSDN部落格",
                "url":"https://blog.csdn.net/qq_38826019/article/details/117387398",
                "icon":null,
                "classifyName":"Spring",
                "classifyId":"1522586360887742466"
            },
            {
                "id":"1631597310596190209",
                "timestamp":1677838087000,
                "enabledState":null,
                "name":"vue3 + elemenplus實現導航欄 - 掘金",
                "url":"https://juejin.cn/post/7084871748608327687",
                "icon":null,
                "classifyName":"前端",
                "classifyId":"1525554881275990018"
            },
            {
                "id":"1631593154401636354",
                "timestamp":1677837096000,
                "enabledState":null,
                "name":"Spring bean 建立過程原始碼解析 - 騰訊雲開發者社群-騰訊雲",
                "url":"https://cloud.tencent.com/developer/article/1631160",
                "icon":null,
                "classifyName":"Spring",
                "classifyId":"1522586360887742466"
            },
            {
                "id":"1631592987673858050",
                "timestamp":1677837056000,
                "enabledState":null,
                "name":"SpringBoot之容器啟動原始碼分析與Bean載入_springboot載入bean 原始碼_minemine0418的部落格-CSDN部落格",
                "url":"https://blog.csdn.net/minemine0418/article/details/102308912",
                "icon":null,
                "classifyName":"Spring Boot",
                "classifyId":"1522586446766116865"
            },
            {
                "id":"1631586585454678018",
                "timestamp":1677835530000,
                "enabledState":null,
                "name":"Spring-Bean生命週期 - 知乎",
                "url":"https://zhuanlan.zhihu.com/p/158468104",
                "icon":null,
                "classifyName":"Spring",
                "classifyId":"1522586360887742466"
            },
            {
                "id":"1631579732104548354",
                "timestamp":1677833896000,
                "enabledState":null,
                "name":"一文讀懂 Spring Bean 的生命週期_spring bean的生命週期_老周聊架構的部落格-CSDN部落格",
                "url":"https://blog.csdn.net/riemann_/article/details/118500805",
                "icon":null,
                "classifyName":"Spring",
                "classifyId":"1522586360887742466"
            },
            {
                "id":"1630768897186697218",
                "timestamp":1677640578000,
                "enabledState":null,
                "name":"MySQL同時統計多個條件的記錄條數_ztnhnr的部落格-CSDN部落格",
                "url":"https://blog.csdn.net/ztnhnr/article/details/107165942",
                "icon":null,
                "classifyName":"MySQL",
                "classifyId":"1522586805693681666"
            },
            {
                "id":"1630768792098410497",
                "timestamp":1677640553000,
                "enabledState":null,
                "name":"sql查詢近七天，近兩週，近一個月的資料_sql最近一週資料_心誠則靈＇的部落格-CSDN部落格",
                "url":"https://blog.csdn.net/wenchangwenliu/article/details/119891790",
                "icon":null,
                "classifyName":"MySQL",
                "classifyId":"1522586805693681666"
            },
            {
                "id":"1630480535938764801",
                "timestamp":1677571827000,
                "enabledState":null,
                "name":"開源流程引擎哪個好，如何選型？ - 知乎",
                "url":"https://zhuanlan.zhihu.com/p/369761832",
                "icon":null,
                "classifyName":"Java",
                "classifyId":"1522586296119300097"
            }
        ]
    }
}

響應結果，還是符合預期的。

當然，HTTP還有其他，比如超時等等，下面看看完整版的請求示例：

Map<String, Object> paramMap = new HashMap<>();
paramMap.put("currentPage", 1);
paramMap.put("pageSize", 10);

Map<String, String> headerMap = new HashMap<>();
headerMap.put("Accept", "application/json");

Request request = new Request();
request.setUrl("https://erwin-api.fengwenyi.com/erwin/bookmark/page");
request.setParam(paramMap);
request.setMethod(Request.Method.GET);
request.setUtil(Request.Util.OkHttp);

Request.Option option = new Request.Option();
option.setHeaders(headerMap);
option.setConnectTimeoutSecond(3);
option.setReadTimeoutSecond(5);
option.setLogLevel(Request.LogLevel.DEBUG);

try {
    String result = HttpUtils.execute(request, option);
    System.out.println(result);
} catch (IOException e) {
    throw new RuntimeException(e);
}

響應結果也是跟上面一樣的。

第三部分：分享HttpUtils是如何封裝的

首先是 Request 和 Response 對應HTTP的請求和響應，包路徑如下：

  • com.fengwenyi.javalib.http.Request
  • com.fengwenyi.javalib.http.Response

另外，com.fengwenyi.javalib.http.Request.Option 來存放HTTP引數配置。

這一部分的思路來源是 Spring Cloud OpenFeign。

為了相容多種HTTP工具實現請求，引入了 HttpClientFactory，其他工具類，只要實現 HttpClient 介面，就行。

  • com.fengwenyi.javalib.http.client.HttpClient
  • com.fengwenyi.javalib.http.client.HttpClientFactory

歐克，下面我們就以程式碼來看看：

HttpUtils#execute

public static String execute(Request request, Request.Option option) throws IOException {
    check(request);
    HttpClient httpClient = HttpClientFactory.get(request.getUtil());
    Response response = httpClient.execute(request, option);
    return handleResponse(response);
}

HttpClientFactory#get

public static HttpClient get(Request.Util httpUtil) {
    if (Request.Util.JDK == httpUtil) {
        return new JdkHttpClient();
    } else if (Request.Util.OkHttp == httpUtil) {
        return new OkHttpClient();
    } else {
        throw new RuntimeException("not find http util: " + httpUtil.name());
    }
}

所以，只需要實現 HttpClient#execute 介面就行。

Response execute(Request request, Request.Option option) throws IOException;

原始碼：https://github.com/fengwenyi/JavaLib

好了，今天的分享就到這裡了。我是小馮，一名Java程式設計師，專注於程式設計和開發，如果你在開發上遇到問題，歡迎一起交流，微信公眾號：馮文議（ID：fwy-world）。

相關文章