Apache HttpClient - Interceptores

Interceptadores são aqueles que ajudam a obstruir ou alterar solicitações ou respostas. Os interceptores de protocolo em geral agem sobre um cabeçalho específico ou um grupo de cabeçalhos relacionados. A biblioteca HttpClient fornece suporte para interceptores.

Solicitar interceptor

o HttpRequestInterceptorinterface representa os interceptores de solicitação. Essa interface contém um método conhecido como processo no qual você precisa escrever o pedaço de código para interceptar as solicitações.

No lado do cliente, este método verifica / processa os pedidos antes de enviá-los ao servidor e, no lado do servidor, este método é executado antes de avaliar o corpo do pedido.

Criando interceptor de solicitação

Você pode criar um interceptor de solicitação seguindo as etapas fornecidas abaixo.

Step 1 - Create an object of HttpRequestInterceptor

Crie um objeto da interface HttpRequestInterceptor implementando seu processo de método abstrato.

HttpRequestInterceptor requestInterceptor = new HttpRequestInterceptor() {

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

Step 2 - Instantiate CloseableHttpClient object

Crie um personalizado CloseableHttpClient objeto adicionando o interceptor criado acima a ele, conforme mostrado abaixo -

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

Usando este objeto, você pode realizar as execuções da solicitação normalmente.

Exemplo

O exemplo a seguir demonstra o uso de interceptores de solicitação. Neste exemplo, criamos um objeto de solicitação HTTP GET e adicionamos três cabeçalhos: sample-header, demoheader e test-header a ele.

No processor()método do interceptor, estamos verificando os cabeçalhos da solicitação enviada; se algum desses cabeçalhos forsample-header, estamos tentando removê-lo e exibir a lista de cabeçalhos dessa solicitação específica.

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

Resultado

Ao executar o programa acima, a seguinte saída é gerada -

Contains header sample-header, removing it..
demo-header
test-header
HTTP/1.1 200 OK

Interceptador de resposta

o HttpResponseInterceptorinterface representa os interceptores de resposta. Esta interface contém um método conhecido comoprocess(). Neste método, você precisa escrever o pedaço de código para interceptar as respostas.

No lado do servidor, este método verifica / processa a resposta antes de enviá-la ao cliente, e no lado do cliente, este método é executado antes de avaliar o corpo da resposta.

Criando interceptor de resposta

Você pode criar um interceptor de resposta seguindo as etapas abaixo -

Step 1 - Create an object of HttpResponseInterceptor

Crie um objeto do HttpResponseInterceptor interface implementando seu método abstrato process.

HttpResponseInterceptor responseInterceptor = new HttpResponseInterceptor() {
   @Override
   public void process(HttpResponse response, HttpContext context) throws HttpException, IOException {
      //Method implementation . . . . . . . .
   }
};

Etapa 2: instanciar o objeto CloseableHttpClient

Crie um personalizado CloseableHttpClient objeto adicionando o interceptor criado acima a ele, como mostrado abaixo -

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

Usando este objeto, você pode realizar as execuções da solicitação normalmente.

Exemplo

O exemplo a seguir demonstra o uso de interceptores de resposta. Neste exemplo, adicionamos três cabeçalhos: sample-header, demo-header e test-header à resposta no processador.

Depois de executar a solicitação e obter a resposta, imprimimos os nomes de todos os cabeçalhos da resposta usando o getAllHeaders() método.

E na saída, você pode observar os nomes de três cabeçalhos na lista.

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

Resultado

Ao ser executado, o programa acima gera o seguinte resultado -

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

↰ Previous page Next page ↱