ApacheHttpClient-インターセプター
インターセプターは、要求または応答を妨害または変更するのに役立つインターセプターです。プロトコルインターセプターは一般に、特定のヘッダーまたは関連するヘッダーのグループに作用します。HttpClientライブラリはインターセプターのサポートを提供します。
インターセプターをリクエストする
ザ・ HttpRequestInterceptorインターフェイスはリクエストインターセプターを表します。このインターフェースには、リクエストをインターセプトするためにコードのチャンクを記述する必要があるプロセスと呼ばれるメソッドが含まれています。
クライアント側では、このメソッドはリクエストをサーバーに送信する前に検証/処理し、サーバー側では、このメソッドはリクエストの本文を評価する前に実行されます。
リクエストインターセプターの作成
以下の手順に従って、リクエストインターセプターを作成できます。
Step 1 - Create an object of HttpRequestInterceptor
抽象メソッドプロセスを実装して、HttpRequestInterceptorインターフェイスのオブジェクトを作成します。
HttpRequestInterceptor requestInterceptor = new HttpRequestInterceptor() {@Override
public void process(HttpRequest request, HttpContext context) throws
HttpException, IOException {
//Method implementation . . . . .
};Step 2 - Instantiate CloseableHttpClient object
カスタムを作成する CloseableHttpClient 以下に示すように、上で作成したインターセプターをオブジェクトに追加します。
//Creating a CloseableHttpClient object
CloseableHttpClient httpclient =
HttpClients.custom().addInterceptorFirst(requestInterceptor).build();このオブジェクトを使用すると、通常どおりリクエストの実行を実行できます。
例
次の例は、リクエストインターセプターの使用法を示しています。この例では、HTTP GETリクエストオブジェクトを作成し、それにsample-header、demoheader、test-headerの3つのヘッダーを追加しました。
の中に processor()インターセプターのメソッドでは、送信されたリクエストのヘッダーを確認しています。それらのヘッダーのいずれかがsample-header、それを削除して、その特定のリクエストのヘッダーのリストを表示しようとしています。
import java.io.IOException;
import org.apache.http.Header;
import org.apache.http.HttpException;
import org.apache.http.HttpRequest;
import org.apache.http.HttpRequestInterceptor;
import org.apache.http.HttpResponse;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.message.BasicHeader;
import org.apache.http.protocol.HttpContext;
public class InterceptorsExample {
public static void main(String args[]) throws Exception{
//Creating an HttpRequestInterceptor
HttpRequestInterceptor requestInterceptor = new HttpRequestInterceptor() {
@Override
public void process(HttpRequest request, HttpContext context) throws
HttpException, IOException {
if(request.containsHeader("sample-header")) {
System.out.println("Contains header sample-header, removing it..");
request.removeHeaders("sample-header");
}
//Printing remaining list of headers
Header[] headers= request.getAllHeaders();
for (int i = 0; i<headers.length;i++) {
System.out.println(headers[i].getName());
}
}
};
//Creating a CloseableHttpClient object
CloseableHttpClient httpclient =
HttpClients.custom().addInterceptorFirst(requestInterceptor).build();
//Creating a request object
HttpGet httpget1 = new HttpGet("https://www.tutorialspoint.com/");
//Setting the header to it
httpget1.setHeader(new BasicHeader("sample-header","My first header"));
httpget1.setHeader(new BasicHeader("demo-header","My second header"));
httpget1.setHeader(new BasicHeader("test-header","My third header"));
//Executing the request
HttpResponse httpresponse = httpclient.execute(httpget1);
//Printing the status line
System.out.println(httpresponse.getStatusLine());
}
}出力
上記のプログラムを実行すると、次の出力が生成されます-
Contains header sample-header, removing it..
demo-header
test-header
HTTP/1.1 200 OK応答インターセプター
ザ・ HttpResponseInterceptorインターフェイスは、応答インターセプターを表します。このインターフェースには、process()。このメソッドでは、応答をインターセプトするコードのチャンクを記述する必要があります。
サーバー側では、このメソッドは応答をクライアントに送信する前に検証/処理し、クライアント側では、このメソッドは応答の本文を評価する前に実行されます。
応答インターセプターの作成
以下の手順に従って、応答インターセプターを作成できます。
Step 1 - Create an object of HttpResponseInterceptor
のオブジェクトを作成します HttpResponseInterceptor その抽象メソッドを実装することによるインターフェース process。
HttpResponseInterceptor responseInterceptor = new HttpResponseInterceptor() {
@Override
public void process(HttpResponse response, HttpContext context) throws HttpException, IOException {
//Method implementation . . . . . . . .
}
};ステップ2：CloseableHttpClientオブジェクトをインスタンス化する
カスタムを作成する CloseableHttpClient 以下に示すように、上で作成したインターセプターをオブジェクトに追加します。
//Creating a CloseableHttpClient object
CloseableHttpClient httpclient =
HttpClients.custom().addInterceptorFirst(responseInterceptor).build();このオブジェクトを使用すると、通常どおりリクエストの実行を実行できます。
例
次の例は、応答インターセプターの使用法を示しています。この例では、サンプルヘッダー、デモヘッダー、テストヘッダーの3つのヘッダーをプロセッサの応答に追加しました。
リクエストを実行してレスポンスを取得した後、を使用してレスポンスのすべてのヘッダーの名前を出力しました。 getAllHeaders() 方法。
また、出力では、リスト内の3つのヘッダーの名前を確認できます。
import java.io.IOException;
import org.apache.http.Header;
import org.apache.http.HttpException;
import org.apache.http.HttpResponse;
import org.apache.http.HttpResponseInterceptor;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.protocol.HttpContext;
public class ResponseInterceptorsExample {
public static void main(String args[]) throws Exception{
//Creating an HttpRequestInterceptor
HttpResponseInterceptor responseInterceptor = new HttpResponseInterceptor() {
@Override
public void process(HttpResponse response, HttpContext context) throws
HttpException, IOException {
System.out.println("Adding header sample_header, demo-header, test_header to the response");
response.setHeader("sample-header", "My first header");
response.setHeader("demo-header", "My second header");
response.setHeader("test-header", "My third header");
}
};
//Creating a CloseableHttpClient object
CloseableHttpClient httpclient = HttpClients.custom().addInterceptorFirst(responseInterceptor).build();
//Creating a request object
HttpGet httpget1 = new HttpGet("https://www.tutorialspoint.com/");
//Executing the request
HttpResponse httpresponse = httpclient.execute(httpget1);
//Printing remaining list of headers
Header[] headers = httpresponse.getAllHeaders();
for (int i = 0; i<headers.length;i++) {
System.out.println(headers[i].getName());
}
}
}出力
上記のプログラムを実行すると、次の結果が生成されます。
On executing the above program generates the following output.
Adding header sample_header, demo-header, test_header to the response
Accept-Ranges
Access-Control-Allow-Headers
Access-Control-Allow-Origin
Cache-Control
Content-Type
Date
Expires
Last-Modified
Server
Vary
X-Cache
sample-header
demo-header
test-header