Apache HttpClient 5 筆記: SSL, Proxy 和 Multipart Upload

来源:https://www.cnblogs.com/milton/archive/2022/12/31/17017446.html
-Advertisement-
Play Games

HttpClient 版本已經到 5.2.1 了. 在版本4中的一些方法已經變成 deprecated, 於是將之前的工具類升級一下, 順便把中間遇到的問題記錄一下 ...


Apache HttpClient 5

最近要在非SpringBoot環境調用OpenFeign介面, 需要用到httpclient, 註意到現在 HttpClient 版本已經到 5.2.1 了. 之前在版本4中的一些方法已經變成 deprecated, 於是將之前的工具類升級一下, 順便把中間遇到的問題記錄一下

基礎使用方法

首先參考Apache官方的快速開始 httpcomponents-client-5.2.x quickstart, 這是頁面上給的例子

Post請求

try (CloseableHttpClient httpclient = HttpClients.createDefault()) {
    HttpPost httpPost = new HttpPost("http://httpbin.org/post");
    List<NameValuePair> nvps = new ArrayList<>();
    nvps.add(new BasicNameValuePair("username", "vip"));
    nvps.add(new BasicNameValuePair("password", "secret"));
    httpPost.setEntity(new UrlEncodedFormEntity(nvps));

    try (CloseableHttpResponse response2 = httpclient.execute(httpPost)) {
        System.out.println(response2.getCode() + " " + response2.getReasonPhrase());
        HttpEntity entity2 = response2.getEntity();
        // do something useful with the response body
        // and ensure it is fully consumed
        EntityUtils.consume(entity2);
    }
}

Get請求

try (CloseableHttpClient httpclient = HttpClients.createDefault()) {
    HttpGet httpGet = new HttpGet("http://httpbin.org/get");
    try (CloseableHttpResponse response1 = httpclient.execute(httpGet)) {
        System.out.println(response1.getCode() + " " + response1.getReasonPhrase());
        HttpEntity entity1 = response1.getEntity();
        // do something useful with the response body
        // and ensure it is fully consumed
        EntityUtils.consume(entity1);
    }
}

替換 Deprecated 的 execute 方法

上面的例子可以正常運行, 但是在HttpClient5中, CloseableHttpResponse execute(ClassicHttpRequest request) 這個方法已經被標記為 Deprecated

@Deprecated
HttpResponse execute(ClassicHttpRequest var1) throws IOException;

@Deprecated
HttpResponse execute(ClassicHttpRequest var1, HttpContext var2) throws IOException;

@Deprecated
ClassicHttpResponse execute(HttpHost var1, ClassicHttpRequest var2) throws IOException;

@Deprecated
HttpResponse execute(HttpHost var1, ClassicHttpRequest var2, HttpContext var3) throws IOException;

取而代之的, 是這四個帶 HttpClientResponseHandler 參數的 execute 方法

<T> T execute(ClassicHttpRequest var1, HttpClientResponseHandler<? extends T> var2) throws IOException;
<T> T execute(ClassicHttpRequest var1, HttpContext var2, HttpClientResponseHandler<? extends T> var3) throws IOException;
<T> T execute(HttpHost var1, ClassicHttpRequest var2, HttpClientResponseHandler<? extends T> var3) throws IOException;
<T> T execute(HttpHost var1, ClassicHttpRequest var2, HttpContext var3, HttpClientResponseHandler<? extends T> var4) throws IOException;
}

這個 HttpClientResponseHandler 作為響應的處理方法, 裡面只有一個介面方法(要註意到這是一個函數式介面)

@FunctionalInterface
public interface HttpClientResponseHandler<T> {
    T handleResponse(ClassicHttpResponse var1) throws HttpException, IOException;
}

JDK中提供了一個預設的實現, BasicHttpClientResponseHandler(基於 AbstractHttpClientResponseHandler)

public abstract class AbstractHttpClientResponseHandler<T> implements HttpClientResponseHandler<T> {
    public AbstractHttpClientResponseHandler() {
    }

    public T handleResponse(ClassicHttpResponse response) throws IOException {
        HttpEntity entity = response.getEntity();
        if (response.getCode() >= 300) {
            EntityUtils.consume(entity);
            throw new HttpResponseException(response.getCode(), response.getReasonPhrase());
        } else {
            return entity == null ? null : this.handleEntity(entity);
        }
    }

    public abstract T handleEntity(HttpEntity var1) throws IOException;
}

public class BasicHttpClientResponseHandler extends AbstractHttpClientResponseHandler<String> {
    public BasicHttpClientResponseHandler() {
    }

    public String handleEntity(HttpEntity entity) throws IOException {
        try {
            return EntityUtils.toString(entity);
        } catch (ParseException var3) {
            throw new ClientProtocolException(var3);
        }
    }

    public String handleResponse(ClassicHttpResponse response) throws IOException {
        return (String)super.handleResponse(response);
    }
}

這樣基礎的使用方式就改為了下麵的形式

public static void main(final String[] args) throws Exception {
    final CloseableHttpClient httpClient = HttpClients.createDefault();
    try (httpClient) {
        final HttpGet httpGet = new HttpGet("https://www.baidu.com/home/other/data/weatherInfo");
        final String responseBody = httpClient.execute(httpGet, new BasicHttpClientResponseHandler());
        System.out.println(responseBody);
    }
}

使用自定義的函數式方法處理響應

可以看到, 上面的 BasicHttpClientResponseHandler 是一個比較簡單的實現, 大於300的響應狀態碼直接拋出異常, 其它的讀出字元串. 這樣的處理方式對於更精細的使用場景是不夠的

  • 需要根據響應狀態碼判斷時
  • 需要對響應解析為Java類時
  • 需要壓住異常, 統一返回類對象時

之前在 HttpClient4 時, 可以通過CloseableHttpResponse response = client.execute(httpRequest), 對 response 進行判斷, 現在response已經完全被handler 包裹, 需要通過自定義函數式方法處理響應, 看下麵的例子

首先定義一個響應結果類, 數據部分使用泛型

@Data
public class Client5Resp<T> implements Serializable {
    private int code;
    private String raw;
    private T data;
    
    public Client5Resp(int code, String raw, T data) {
        this.code = code;
        this.raw = raw;
        this.data = data;
    }
}

然後對響應結果自定義 handler, 因為是函數式介面, 所以很方便在方法中直接定義, 處理的邏輯是:

  1. 如果 T 泛型為String, 直接將 body 作為數據返回
  2. 其它的 T 泛型, 用 Jackson 解開之後返回
  3. 將 status code 一併返回
private static <T> Client5Resp<T> httpRequest(
        TypeReference<T> tp,
        HttpUriRequest httpRequest) {
    try (CloseableHttpClient client = HttpClients.createDefault()) {
        Client5Resp<T> resp = client.execute(httpRequest, response -> {
            if (response.getEntity() != null) {
                String body = EntityUtils.toString(response.getEntity());
                if (tp.getType() == String.class) {
                    return new Client5Resp<>(response.getCode(), body, (T)body);
                } 
                // 當需要區分更多類型時可以增加定義
                else {
                    T t = JacksonUtil.extractByType(body, tp);
                    return new Client5Resp<>(response.getCode(), body, t);
                }
            } else {
                return new Client5Resp<>(response.getCode(), null, null);
            }
        });
        log.info("rsp:{}, body:{}", resp.getCode(), resp.getRaw());
        return resp;
    } catch (IOException|NoSuchAlgorithmException|KeyStoreException|KeyManagementException e) {
        // 當異常也需要返回 Client5Resp 類型對象時可以在catch中封裝
        log.error(e.getMessage(), e);
    }
    return null;
}

自定義請求設置和Header

首先是超時設置

RequestConfig defaultRequestConfig = RequestConfig.custom()
        .setConnectionRequestTimeout(60, TimeUnit.SECONDS)
        .setResponseTimeout(60, TimeUnit.SECONDS)
        .build();

然後是 Header

List<Header> headers = List.of(
    new BasicHeader(HttpHeaders.CONTENT_TYPE, "application/json"),
    new BasicHeader(HttpHeaders.ACCEPT, "application/json"));

在 HttpGet/HttpPost 中設置

HttpGet httpGet = new HttpGet(...);
if (headers != null) {
    for (Header header : headers) {
        httpGet.addHeader(header);
    }
}
RequestConfig requestConfig = RequestConfig.copy(defaultRequestConfig).build();
httpGet.setConfig(requestConfig);

自定義 HttpClient 增加 SSL TrustAllStrategy

在 HttpClient5 中, 增加 SSL TrustAllStrategy 的方法也有變化, 這是獲取 CloseableHttpClient 的代碼

final RequestConfig defaultRequestConfig = RequestConfig.custom()
        .setConnectionRequestTimeout(60, TimeUnit.SECONDS)
        .setResponseTimeout(60, TimeUnit.SECONDS)
        .build();
final BasicCookieStore defaultCookieStore = new BasicCookieStore();
final SSLContext sslcontext = SSLContexts.custom()
        .loadTrustMaterial(null, new TrustAllStrategy()).build();
final SSLConnectionSocketFactory sslSocketFactory = SSLConnectionSocketFactoryBuilder.create()
        .setSslContext(sslcontext).build();
final HttpClientConnectionManager cm = PoolingHttpClientConnectionManagerBuilder.create()
        .setSSLSocketFactory(sslSocketFactory).build();
return HttpClients.custom()
        .setDefaultCookieStore(defaultCookieStore)
        .setDefaultRequestConfig(defaultRequestConfig)
        .setConnectionManager(cm)
        .evictExpiredConnections()
        .build();

增加 Http Proxy

固定的 Proxy

在 HttpClient5 中, RequestConfig.Builder.setProxy()方法已經 Deprecated

@Deprecated
public RequestConfig.Builder setProxy(HttpHost proxy) {
    this.proxy = proxy;
    return this;
}

需要使用 HttpClientBuilder.setRoutePlanner(HttpRoutePlanner routePlanner) 進行設置, 和SSL一起, 獲取client的代碼變成

final HttpHost proxy = new HttpHost(proxyHost, proxyPort);
final DefaultProxyRoutePlanner routePlanner = new DefaultProxyRoutePlanner(proxy);
return HttpClients.custom()
        .setDefaultCookieStore(defaultCookieStore)
        .setDefaultRequestConfig(defaultRequestConfig)
        .setRoutePlanner(routePlanner)
        .setConnectionManager(cm)
        .evictExpiredConnections()
        .build();

如果需要用戶名密碼, 需要再增加一個 CredentialsProvider, 變成

final HttpHost proxy = new HttpHost(proxyHost, proxyPort);
final DefaultProxyRoutePlanner routePlanner = new DefaultProxyRoutePlanner(proxy);
final BasicCredentialsProvider credsProvider = new BasicCredentialsProvider();
credsProvider.setCredentials(
        new AuthScope(proxyHost, proxyPort),
        new UsernamePasswordCredentials(authUser, authPasswd.toCharArray()));

return HttpClients.custom()
        .setDefaultCookieStore(defaultCookieStore)
        .setDefaultRequestConfig(defaultRequestConfig)
        .setDefaultCredentialsProvider(credsProvider)
        .setRoutePlanner(routePlanner)
        .setConnectionManager(cm)
        .evictExpiredConnections()
        .build();

動態 Proxy

如果需要隨時切換 proxy, 需要自己實現一個 HttpRoutePlanner

public static class DynamicProxyRoutePlanner implements HttpRoutePlanner {
    private DefaultProxyRoutePlanner planner;

    public DynamicProxyRoutePlanner(HttpHost host){
        planner = new DefaultProxyRoutePlanner(host);
    }

    public void setProxy(HttpHost host){
        planner = new DefaultProxyRoutePlanner(host);
    }

    public HttpRoute determineRoute(HttpHost target, HttpContext context) throws HttpException {
        return planner.determineRoute(target, context);
    }
}

然後在代碼中進行切換

HttpHost proxy = new HttpHost("127.0.0.1", 1080);
DynamicProxyRoutePlanner routePlanner = new DynamicProxyRoutePlanner(proxy);
CloseableHttpClient httpclient = HttpClients.custom()
    .setRoutePlanner(routePlanner)
    .build();
// 換代理
routePlanner.setProxy(new HttpHost("192.168.0.1", 1081));

構造 Multipart 文件上傳請求

首先是構造 HttpEntity 的方法, 這個方法中設置請求為 1個文件 + 多個隨表單參數

public static HttpEntity httpEntityBuild(NameValuePair fileNvp, List<NameValuePair> nvps) {
    File file = new File(fileNvp.getValue());
    MultipartEntityBuilder builder = MultipartEntityBuilder.create().setMode(HttpMultipartMode.STRICT);
    if (nvps != null && nvps.size() > 0) {
        for (NameValuePair nvp : nvps) {
            builder.addTextBody(nvp.getName(), nvp.getValue(), ContentType.DEFAULT_BINARY);
        }
    }
    builder.addBinaryBody(fileNvp.getName(), file, ContentType.DEFAULT_BINARY, fileNvp.getValue());
    return builder.build();
}

請求流程

// 構造一個文件參數, 其它參數留空
NameValuePair fileNvp = new BasicNameValuePair("sendfile", filePath);
HttpEntity entity = httpEntityBuild(fileNvp, null);
HttpPost httpPost = new HttpPost(api);
httpPost.setEntity(entity);

try (CloseableHttpClient client = getClient(...)) {
    Client5Resp<T> resp = client.execute(httpPost, response->{
        ...
    });

註意: 在使用 HttpMultipartMode 時對 HttpEntity 設置 Header 要謹慎, 因為 HttpClient 會對 Content-Type增加 Boundary 尾碼, 而這個是服務端判斷文件邊界的重要參數. 如果設置自定義 Header, 需要檢查 boundary 是否正確生成. 如果沒有的話需要自定義 Content-Type 將 boundary 加進去, 並且通過 EntityBuilder.setBoundary() 將自定義的 boundary 值傳給 HttpEntity.

Links


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 從USB存儲設備啟動樹莓派
    設置USB啟動 當前環境使用的樹莓派版本為：Raspberry Pi 3B，並且已經在SD卡中燒錄系統； 1.使用SD卡燒錄Raspberry Pi OS。 可以只使用Raspberry Pi OS Lite，無桌面環境； 2.Raspberry Pi啟動進入操作系統中後，更新系統環境： sudo ...
  • 聊一聊 SQLSERVER 的行不能跨頁
    一：背景 1. 講故事 相信有很多朋友在學習 SQLSERVER 的時候都聽說過這句話，但大多都是記憶為主，最近在研究 SQLSERVER，所以我們從 底層存儲 的角度來深入理解下。 二：理解數據頁 1. 數據頁的組織 在前面的文章中我也說過，一個 數據頁 是 8k 大小，那這 8k 是如何組織的呢 ...
  • sql根據團隊樹一級一級彙總統計
    ​ 1、需求描述 最近碰到了一個需求，是要統計各個團隊的員工的銷售金額，然後一級一級向上彙總。 ​編輯 架構團隊樹是類似於這種樣子的，需要先算出每個員工的銷售金額，然後彙總成上一級的團隊金額，然後各個團隊的銷售總金額再往上彙總成一個區域的銷售金額，然後各個區域的金額再往上彙總成總公司的金額。當然我工 ...
  • MySQL報錯解決
    1 mysql 報錯解決mysql> grant all on *.* to "dba"@"%" identified by "mysql123";ERROR 1819 (HY000): Your password does not satisfy the current policy requir ...
  • Flutter異常監控 - 壹 | 從Zone說起
    開啟掘金成長之旅！這是我參與「掘金日新計劃 · 12 月更文挑戰」的第3天，點擊查看活動詳情 如果你正需要處理Flutter異常捕獲，那麼恭喜你，找對地了，這裡從根源上給你準備了Flutter異常捕獲需要是所有知識和原理，讓你更深刻認識Flutter Zone概念。 Zone是什麼 /// A zo ...
  • VUE3 全局共用數據方案之三 Vuex企業級模塊化設計(詳細流程)
    Vue3,webpack,vite 通用 適用於中大型項目中 1.安裝vuex npm i vuex 2.創建倉庫與文件結構（核心） 一，創建入口 在src目錄下創建store文件夾，store文件夾下創建 下麵文件結構 actions.js import * as type from './mut ...
  • 基於jQuery的三種AJAX請求
    基於jQuery的三種AJAX請求 1. 介紹 get請求 通常用於 獲取服務端資源（向伺服器要資源） ​ 例如：根據URL地址，從伺服器獲取HTML文件、CSS文件、JS文件、圖片文件、數據資源等。 post請求 通常用於 向伺服器提交數據（往伺服器發送資源） ​ 例如：登錄時向伺服器提交的登錄信 ...
  • 領域驅動設計四論
    1776 年亞當斯密發表《國富論》，標志著經濟學的誕生。2004 年，一本名為《領域驅動設計·軟體核心複雜性應對之道》的書問世，開闢了軟體開發的一個新流派：領域驅動設計。看完這本書，十個人有九個人的感覺都是：似懂非懂，若有所得，掩卷長思，一無所得，我個人的感覺同樣如此。出於興趣，多年來仔細研讀了幾十... ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發（一）：使用.NET MAUI開發第一個安卓APP
    移動開發（一）：使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說，近來想嘗試開發一款安卓APP，考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP，畢竟是使用Visual Studio開發工具，使用起來也比較的順手，結合微軟官方的教程進行了安卓 ...
  • wpf ToggleButton選中效果和一個登錄界面
    前言 QuestPDF 是一個開源 .NET 庫，用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫，它徹底改變了我們生成 PDF 文檔的方 ...
  • 彈幕樹洞項目功能新增篇
    項目地址 項目後端地址： https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址： ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址： http://tree ...
  • 第27篇 sqlserver2022詳細安裝步驟
    話不多說，直接開乾 一.下載 1.官方鏈接下載： https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe，運行開始下載SQL server； 二. ...
  • .NET 開源高性能 MQTT 類庫
    前言 隨著物聯網（IoT）技術的迅猛發展，MQTT（消息隊列遙測傳輸）協議憑藉其輕量級和高效性，已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫，為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog文檔翻譯系列（六） - 可用的接收器、增強器、格式化輸出
    Serilog支持多種接收器用於日誌存儲，增強器用於添加屬性，LogContext管理動態屬性，支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項，適用於不同需求。 ...
  • 警惕 Visual Studio 屬性求值副作用導致邏輯不符合預期
    目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據，爬取信息時需要模擬瀏覽器行為，否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下： 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • [使用目前最新版]HybridCLR6.9.0+YooAsset2.2.4實現純C# Unity熱更新方案 (一)
    1.前言 什麼是熱更新 游戲或者軟體更新時，無需重新下載客戶端進行安裝，而是在應用程式啟動的情況下，在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR，Xlua，ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles，Addressable， ...
  • 在 ASP.NET Core Web API 中使用操作篩選器統一處理通用操作
    本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺，其實像阿裡雲，騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後，它會送 ...
  • 第28篇 如何.net中實現高效可靠數據同步api
    通過以下方式可以高效，並保證數據同步的可靠性 1.API設計 使用RESTful設計，確保API端點明確，並使用適當的HTTP方法（如POST用於創建，PUT用於更新）。 設計清晰的請求和響應模型，以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類