Учебники

Apache HttpClient — перехватчики

Перехватчики — это те, которые помогают блокировать или изменять запросы или ответы. Протокол-перехватчики обычно действуют на определенный заголовок или группу связанных заголовков. Библиотека HttpClient обеспечивает поддержку перехватчиков.

Запрос перехватчика

Интерфейс HttpRequestInterceptor представляет перехватчики запросов. Этот интерфейс содержит метод, известный как процесс, в котором вам нужно написать кусок кода для перехвата запросов.

На стороне клиента этот метод проверяет / обрабатывает запросы перед их отправкой на сервер, а на стороне сервера этот метод выполняется перед оценкой тела запроса.

Создание запроса-перехватчика

Вы можете создать перехватчик запроса, выполнив шаги, указанные ниже.

Шаг 1 — Создание объекта HttpRequestInterceptor

Создайте объект интерфейса HttpRequestInterceptor, реализовав его абстрактный метод process.

HttpRequestInterceptor requestInterceptor = new HttpRequestInterceptor() {

@Override
 public void process(HttpRequest request, HttpContext context) throws
HttpException, IOException {
   //Method implementation . . . . .
};

Шаг 2. Создание объекта CloseableHttpClient

Создайте пользовательский объект CloseableHttpClient , добавив к нему созданный выше перехватчик, как показано ниже —

//Creating a CloseableHttpClient object
CloseableHttpClient httpclient =
HttpClients. custom() .addInterceptorFirst(requestInterceptor).build();

Используя этот объект, вы можете выполнять запросы как обычно.

пример

Следующий пример демонстрирует использование перехватчиков запросов. В этом примере мы создали объект запроса HTTP GET и добавили к нему три заголовка: sample-header, demoheader и test-header.

В методе 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 () . В этом методе вам нужно написать кусок кода для перехвата ответов.

На стороне сервера этот метод проверяет / обрабатывает ответ перед отправкой его клиенту, а на стороне клиента этот метод выполняется перед оценкой тела ответа.

Создание ответного перехватчика

Вы можете создать перехватчик ответа, выполнив следующие шаги:

Шаг 1 — Создание объекта HttpResponseInterceptor

Создайте объект интерфейса HttpResponseInterceptor , реализовав его абстрактный метод процесса .

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();

Используя этот объект, вы можете выполнять запросы как обычно.

пример

В следующем примере демонстрируется использование перехватчиков ответа. В этом примере мы добавили три ответа: образец заголовка, демо-заголовок и тестовый заголовок к ответу в процессоре.

После выполнения запроса и получения ответа мы распечатали имена всех заголовков ответа, используя метод getAllHeaders () .

И в выводе вы можете наблюдать имена трех заголовков в списке.

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

Выход

При выполнении вышеупомянутая программа генерирует следующий результат —