組成

HttpClient 5 的系統(tǒng)架構(gòu)主要由以下幾個部分組成：

1. HttpCore：核心包，包含了 HTTP 協(xié)議的核心抽象和實現(xiàn)，定義了 HTTP 客戶端和服務(wù)端的基本組件，例如請求消息、響應(yīng)消息、傳輸層等。

2. HttpClient：高級 API，封裝了 HttpCore 包中的核心抽象，提供了一組簡單易用的 API，以便于客戶端應(yīng)用程序發(fā)送 HTTP 請求。

3. HttpAsyncClient：異步 API，是基于 HttpCore 和 HttpClient 構(gòu)建的異步 HTTP 客戶端，可以通過異步方式實現(xiàn) HTTP 請求。

4. HttpClient 和 HttpAsyncClient 都可以通過擴(kuò)展進(jìn)行定制和優(yōu)化，可以添加攔截器、設(shè)置連接管理器、Cookie 管理器、認(rèn)證器等。

請求代碼

GET請求代碼

String resultContent = null;String url = "http://127.0.0.1:8081/get";HttpGet httpGet = new HttpGet(url);//通過工廠獲取CloseableHttpClient httpClient = HttpClients.createDefault();//請求CloseableHttpResponse response = httpClient.execute(httpGet);// Get status codeSystem.out.println(response.getVersion()); // HTTP/1.1System.out.println(response.getCode()); // 200System.out.println(response.getReasonPhrase()); // OKHttpEntity entity = response.getEntity();// Get response informationresultContent = EntityUtils.toString(entity); System.out.println(resultContent);

代碼分析

創(chuàng)建實例

Apache HttpClient提供了一個工廠類來返回HttpClient實例

但實際上都是通過HttpClientBuilder去創(chuàng)建的，

Apache HttpClient通過構(gòu)建者模式加上策略模式實現(xiàn)非常靈活的配置，以實現(xiàn)各種不同的業(yè)務(wù)場景

通過看build()的代碼，創(chuàng)建HttpClient主要分為兩步

? ?public static CloseableHttpClient createDefault() { ? ? ? ?return HttpClientBuilder.create().build(); ? ?}

第一步是初始化配置

里邊很多策略模式的使用，可以實現(xiàn)相關(guān)的類來拓展自己的需求，可以通過HttpClient的set方法把新的策略設(shè)置進(jìn)去，其他配置也可以通過RequestConfig設(shè)置好

ConnectionKeepAliveStrategy keepAliveStrategyCopy = this.keepAliveStrategy;if (keepAliveStrategyCopy == null) { ? ?keepAliveStrategyCopy = DefaultConnectionKeepAliveStrategy.INSTANCE; }AuthenticationStrategy targetAuthStrategyCopy = this.targetAuthStrategy;if (targetAuthStrategyCopy == null) { ? ?targetAuthStrategyCopy = DefaultAuthenticationStrategy.INSTANCE; }AuthenticationStrategy proxyAuthStrategyCopy = this.proxyAuthStrategy;if (proxyAuthStrategyCopy == null) { ? ?proxyAuthStrategyCopy = DefaultAuthenticationStrategy.INSTANCE; }

在這里會初始化包括連接管理器、請求重試處理器、請求執(zhí)行器、重定向策略、認(rèn)證策略、代理、SSL/TLS等配置

第二步是創(chuàng)建處理器鏈

通過組合多個處理器來構(gòu)建成處理器鏈處理請求

需要注意的是這里的添加順序的方法，添加最終的執(zhí)行處理器調(diào)用的是addLast()

處理器鏈中的每個處理器都有不同的功能，例如請求預(yù)處理、重試、身份驗證、請求發(fā)送、響應(yīng)解析等等。在每個處理器的處理過程中，可以對請求或響應(yīng)進(jìn)行修改或擴(kuò)展，以滿足不同的需求

最后再把初始化好的參數(shù)傳遞給InternalHttpClient返回一個HttpClient實例

發(fā)起請求

接下來看看請求方法

CloseableHttpResponse response = httpClient.execute(httpGet);

主要請求方法在InternalHttpClient#doExecute中

主要分為三步，第一步是將各種配置填充到上下文中HttpContext

第二步，執(zhí)行剛剛封裝執(zhí)行鏈

//execChain就是上一步封裝好的執(zhí)行鏈final ClassicHttpResponse response = this.execChain.execute(ClassicRequestBuilder.copy(request).build(), scope);

執(zhí)行?execute?方法，執(zhí)行鏈中的處理器被依次調(diào)用，每個元素都可以執(zhí)行一些預(yù)處理、后處理、重試等邏輯

第三步，請求結(jié)束后，將結(jié)果轉(zhuǎn)換為CloseableHttpResponse返回

自定義攔截器和處理器

接下來試試加一下自定義的攔截器和處理器

攔截器和處理器的實現(xiàn)是不一樣的，處理器的實現(xiàn)是ExecChainHandler，攔截器是HttpResponseInterceptor和HttpRequestInterceptor

//執(zhí)行鏈處理器class MyCustomInterceptor implements ExecChainHandler { ? ?@Override ? ?public ClassicHttpResponse execute(ClassicHttpRequest request, ExecChain.Scope scope, ExecChain chain) throws IOException, HttpException { ? ? ? ?System.out.println("MyCustomInterceptor-------------"); ? ? ? ?//調(diào)用下一個鏈 ? ? ? ?return chain.proceed(request,scope); ? ?} }//響應(yīng)攔截器class MyCustomResponseInterceptor implements HttpResponseInterceptor { ? ?@Override ? ?public void process(HttpResponse response, EntityDetails entity, HttpContext context) throws HttpException, IOException { ? ? ? ?System.out.println("MyCustomResponseInterceptor-------------"); ? ?} }//請求攔截器class MyCustomRequestInterceptor implements HttpRequestInterceptor { ? ?@Override ? ?public void process(HttpRequest request, EntityDetails entity, HttpContext context) throws HttpException, IOException { ? ? ? ?System.out.println("MyCustomRequestInterceptor-------------"); ? ?} }

然后加入到攔截鏈中，custom()方法返回HttpClientBuilder來支持自定義

CloseableHttpClient httpClient = HttpClients.custom() .addExecInterceptorLast("myCustomInterceptor", new MyCustomInterceptor()) .addRequestInterceptorFirst(new MyCustomRequestInterceptor()) .addResponseInterceptorLast(new MyCustomResponseInterceptor()) .build();

注意看日志就有輸出了

攔截器和處理器都是用于攔截請求和響應(yīng)的中間件，但它們在功能上有些不同：

1. 攔截器：在請求發(fā)送前或響應(yīng)返回后對請求或響應(yīng)進(jìn)行修改，例如添加、刪除、修改請求頭或響應(yīng)頭、修改請求體等。攔截器的主要作用是攔截請求和響應(yīng)，對它們進(jìn)行一些操作，并將它們傳遞給下一個攔截器或處理器

2. 處理器：用于執(zhí)行實際的請求和響應(yīng)處理，例如建立連接、發(fā)送請求、解析響應(yīng)等。處理器通常是在整個請求-響應(yīng)流程中的最后一環(huán)，負(fù)責(zé)將最終的響應(yīng)結(jié)果返回給調(diào)用方

總之，攔截器和處理器都是用于處理請求和響應(yīng)的中間件，但它們的職責(zé)和功能略有不同

異步請求

異步請求的HttpAsyncClient通過HttpAsyncClients工廠返回

主要的流程和同步請求差不多，包括初始化配置和初始化執(zhí)行鏈，主要差異在執(zhí)行請求那里

因為是異步執(zhí)行，需要開啟異步請求的執(zhí)行器線程池，通過httpClient.start();方法來設(shè)置異步線程的狀態(tài)，否則異步請求將無法執(zhí)行

@Overridepublic final void start() { ? ?if (status.compareAndSet(Status.READY, Status.RUNNING)) { ? ? ? ?executorService.execute(ioReactor::start); ? ?} }

如果沒有開啟，會拋出異常

if (!isRunning()) { ? ?throw new CancellationException("Request execution cancelled"); }

因為是異步請求，所以請求方法需要提供回調(diào)方法，主要實現(xiàn)三個方法，執(zhí)行完成、失敗和取消

//創(chuàng)建urlSimpleHttpRequest get = SimpleHttpRequest.create("GET", url); Future<SimpleHttpResponse> future = httpClient.execute(get, //異步回調(diào) ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? new FutureCallback<SimpleHttpResponse>() { ? ?@Override ? ?public void completed(SimpleHttpResponse result) { ? ? ? ?System.out.println("completed---------------"); ? ?} ? ?@Override ? ?public void failed(Exception ex) { ? ? ? ?System.out.println("failed---------------"); ? ?} ? ?@Override ? ?public void cancelled() { ? ? ? ?System.out.println("cancelled---------------"); ? ?} });SimpleHttpResponse response = future.get();

通過future.get()來獲取異步結(jié)果，接下來看看底層是怎么實現(xiàn)的

//請求execute(SimpleRequestProducer.create(request), SimpleResponseConsumer.create(), context, callback);

異步請求會創(chuàng)建SimpleRequestProducer和SimpleResponseConsumer來處理請求和響應(yīng)，execute()也支持我們自己傳進(jìn)去

最終的請求和數(shù)據(jù)的接收都是依賴管道，過程有點像NIO

當(dāng)請求時，會調(diào)用requestProducer.produce(channel);把請求數(shù)據(jù)寫入channel中，在響應(yīng)時，responseConsumer從channel中取得數(shù)據(jù)

源碼的整一塊請求代碼都是通過幾個匿名函數(shù)的寫法完成的，看的有點繞

發(fā)起請求，匿名函數(shù)段代表的是RequestChannel的請求方法

//requestProducer的sendRequest方法void sendRequest(RequestChannel channel, HttpContext context)

因為RequestChannel類是一個函數(shù)式接口，所以可以通過這種方式調(diào)用

public interface RequestChannel { //請求方法也是叫sendRequest ? ?void sendRequest(HttpRequest request, EntityDetails entityDetails, HttpContext context) throws HttpException, IOException; }

生產(chǎn)和消費數(shù)據(jù)的代碼都在那一刻函數(shù)段中，具體的實現(xiàn)細(xì)節(jié)可以看一下那一段源碼，最終requestProducer也是委托RequestChannel來發(fā)起請求

消費完后通過一層一層的回調(diào)，最終到達(dá)最上邊自己實現(xiàn)的三個方法上

異步的HttpClient也可以自定義攔截器喝處理器，實現(xiàn)方式和上邊的一樣，處理異步處理器的實現(xiàn)不同

CloseableHttpClient httpClient = HttpClients.custom() ? ? ? ? ? ? ? ?.setDefaultRequestConfig(config) ? ? ? ? ? ? ? ?.addExecInterceptorLast("myCustomInterceptor", new MyCustomInterceptor()) ? ? ? ? ? ? ? ?.addRequestInterceptorFirst(new MyCustomRequestInterceptor()) ? ? ? ? ? ? ? ?.addResponseInterceptorLast(new MyCustomResponseInterceptor()) ? ? ? ? ? ? ? ?.build();

使用示例

創(chuàng)建HttpClient

如果是同步的就使用HttpClients工廠，異步的使用HttpAsyncClients

//返回默認(rèn)的CloseableHttpClient httpClient = HttpClients.createDefault();

如果想實現(xiàn)自定義配置，可以使用HttpClients.custom()方法

基本的配置被封裝在RequestConfig類中

RequestConfig config = RequestConfig.custom() ? ? ? ? ? ?.setConnectionRequestTimeout(3L, TimeUnit.SECONDS) ? ? ? ? ? ?.setResponseTimeout(3L, TimeUnit.SECONDS) ? ? ? ? ? ?.setDefaultKeepAlive(10L , TimeUnit.SECONDS) ? ? ? ? ? ?.build();

如果還不滿足，可以還可以去實現(xiàn)這些策略類

使用自定義配置創(chuàng)建httpClient

CloseableHttpClient httpClient = HttpClients.custom() ? ? ? ? ? ?.setDefaultRequestConfig(config) ? ? ? ? ? ?.addExecInterceptorLast("myCustomInterceptor", new MyCustomInterceptor()) ? ? ? ? ? ?.addRequestInterceptorFirst(new MyCustomRequestInterceptor()) ? ? ? ? ? ?.addResponseInterceptorLast(new MyCustomResponseInterceptor()) ? ? ? ? ? ?.build();

GET方法請求

String url = "http://127.0.0.1:8081/get"; List<NameValuePair> nvps = new ArrayList<>();// GET 請求參數(shù)nvps.add(new BasicNameValuePair("username", "test")); nvps.add(new BasicNameValuePair("password", "password"));//將參數(shù)填充道url中URI uri = new URIBuilder(new URI(url)) ? ? ? ?.addParameters(nvps) ? ? ? ?.build();//創(chuàng)建get請求對象HttpGet httpGet = new HttpGet(uri);//發(fā)起請求CloseableHttpResponse response = httpClient.execute(httpGet);// Get status codeSystem.out.println(response.getVersion()); // HTTP/1.1System.out.println(response.getCode()); // 200HttpEntity entity = response.getEntity();// Get response informationString resultContent = EntityUtils.toString(entity); System.out.println(resultContent);

POST請求

這次將參數(shù)寫到HttpEntity里

String url = "http://127.0.0.1:8081/post"; List<NameValuePair> nvps = new ArrayList<>();// GET 請求參數(shù)nvps.add(new BasicNameValuePair("username", "test")); nvps.add(new BasicNameValuePair("password", "password"));UrlEncodedFormEntity formEntity = new UrlEncodedFormEntity(nvps, StandardCharsets.UTF_8);HttpPost httpPost = new HttpPost(url); httpPost.setEntity(formEntity);CloseableHttpClient httpClient = HttpClients.createDefault();CloseableHttpResponse response = httpClient.execute(httpPost);// Get status codeSystem.out.println(response.getVersion()); // HTTP/1.1System.out.println(response.getCode()); // 200HttpEntity entity = response.getEntity();// Get response informationString resultContent = EntityUtils.toString(entity); System.out.println(resultContent);

和GET請求基本一致，除了用的是HttpPost，參數(shù)可以像GET一樣填充到url中，也可以使用HttpEntity填充到請求體里

Json請求

String json = "{" ? ? ? ?+ " ? ?\"username\": \"test\"," ? ? ? ?+ " ? ?\"password\": \"password\"" ? ? ? ?+ "}";StringEntity entity = new StringEntity(json, ContentType.APPLICATION_JSON);HttpPost post = new HttpPost("http://127.0.0.1:8081/postJson"); post.setEntity(entity);CloseableHttpClient client = HttpClients.createDefault();CloseableHttpResponse response = client.execute(post);// Get status codeSystem.out.println(response.getCode()); // 200// Get response informationString resultContent = EntityUtils.toString(response.getEntity()); System.out.println(resultContent);

總結(jié)

和HttpURLConnection相比，做了很多封裝，功能也強(qiáng)大了很多，例如連接池、緩存、重試機(jī)制、線程池等等，并且對于請求參數(shù)的設(shè)置更加靈活，還封裝了異步請求、HTTPS等、自定義攔截器和處理器等

請求是使用了處理鏈的方式發(fā)起的，可以對請求和響應(yīng)進(jìn)行一系列處理，好處是可以將這些處理器封裝成一個公共的類庫，然后通過自己組合來滿足自己的需求，還可以在請求和響應(yīng)的不同階段進(jìn)行攔截和修改，例如添加請求頭、修改請求參數(shù)、解密響應(yīng)數(shù)據(jù)等，不需要在一個大類里寫很多代碼了，已免代碼臃腫

性能方面使用了連接池技術(shù)，可以有效地復(fù)用連接，提高性能

不得不說是apache的項目，源碼使用了包括構(gòu)建者模式、策略模式、責(zé)任鏈模式等設(shè)計模式對整個httpClient進(jìn)行了封裝，學(xué)習(xí)到了