Introducción

En esta breve guía, vamos a explorar cómo configurar un bean de Spring RestTemplate. La capacidad de realizar solicitudes HTTP es fundamental para cualquier aplicación que necesita interactuar con servicios externos. Spring proporciona la clase RestTemplate, que simplifica la comunicación HTTP y hace que la integración con servicios REST sea mucho más fluida.

Vamos a comenzar discutiendo los tres tipos principales de configuración:

• Usando el RestTemplateBuilder por defecto
• Usando un RestTemplateCustomizer
• Creando nuestro propio RestTemplateBuilder

Para poder probar esto fácilmente, siga la guía sobre cómo configurar una simple aplicación Spring Boot.

Configuración Usando el RestTemplateBuilder por Defecto

Para configurar un RestTemplate de esta manera, necesitamos inyectar el bean RestTemplateBuilder por defecto proporcionado por Spring Boot en nuestras clases. Esta es la forma más sencilla de usar RestTemplate.

private RestTemplate restTemplate;

@Autowired
public HelloController(RestTemplateBuilder builder) {
    this.restTemplate = builder.build();
}

El bean RestTemplate creado con este método tiene su alcance limitado a la clase en la que lo construimos. Esto significa que cada instancia de HelloController tendrá su propia instancia de RestTemplate, lo que puede ser deseable en ciertas circunstancias.

Ejemplo de Uso

Aquí hay un ejemplo de cómo se puede usar el restTemplate inyectado para hacer una solicitud GET sencilla:

public String getDataFromApi() {
    String url = "https://api.example.com/data";
    return this.restTemplate.getForObject(url, String.class);
}

Este método realiza una solicitud GET a la URL especificada y devuelve la respuesta como una cadena.

Configuración Usando un RestTemplateCustomizer

Con este enfoque, podemos crear una personalización aditiva a nivel de aplicación. Esto es un poco más complicado, ya que necesitamos crear una clase que implemente RestTemplateCustomizer y definirla como un bean.

public class CustomRestTemplateCustomizer implements RestTemplateCustomizer {
    @Override
    public void customize(RestTemplate restTemplate) {
        restTemplate.getInterceptors().add(new CustomClientHttpRequestInterceptor());
    }
}

El interceptor CustomClientHttpRequestInterceptor se encarga de registrar detalles básicos de la solicitud:

public class CustomClientHttpRequestInterceptor implements ClientHttpRequestInterceptor {
    private static Logger LOGGER = LoggerFactory
      .getLogger(CustomClientHttpRequestInterceptor.class);

    @Override
    public ClientHttpResponse intercept(
      HttpRequest request, byte[] body, 
      ClientHttpRequestExecution execution) throws IOException {
 
        logRequestDetails(request);
        return execution.execute(request, body);
    }
    
    private void logRequestDetails(HttpRequest request) {
        LOGGER.info("Headers: {}", request.getHeaders());
        LOGGER.info("Request Method: {}", request.getMethod());
        LOGGER.info("Request URI: {}", request.getURI());
    }
}

Ahora, definimos CustomRestTemplateCustomizer como un bean en una clase de configuración o en nuestra clase de aplicación Spring Boot:

@Bean
public CustomRestTemplateCustomizer customRestTemplateCustomizer() {
    return new CustomRestTemplateCustomizer();
}

Con esta configuración, cada RestTemplate que utilizaremos en nuestra aplicación tendrá el interceptor personalizado establecido en él. Esto es útil para realizar un seguimiento de las solicitudes HTTP realizadas por la aplicación, facilitando la depuración y el monitoreo.

Ejemplo de Uso

Aquí hay un ejemplo de cómo usar el interceptor:

public void makeApiCall() {
    String url = "https://api.example.com/data";
    ResponseEntity response = this.restTemplate.getForEntity(url, String.class);
}

Cada vez que realices una llamada a la API con este RestTemplate, los detalles de la solicitud se registrarán automáticamente.

Configuración Creando Nuestro Propio RestTemplateBuilder

Este es el enfoque más extremo para personalizar un RestTemplate. Desactiva la auto-configuración predeterminada de RestTemplateBuilder, por lo que necesitamos definirlo nosotros mismos:

@Bean
@DependsOn(value = {"customRestTemplateCustomizer"})
public RestTemplateBuilder restTemplateBuilder() {
    return new RestTemplateBuilder(customRestTemplateCustomizer());
}

Después de esto, podemos inyectar el constructor personalizado en nuestras clases de la misma manera que lo haríamos con un RestTemplateBuilder por defecto y crear un RestTemplate como de costumbre:

private RestTemplate restTemplate;

@Autowired
public HelloController(RestTemplateBuilder builder) {
    this.restTemplate = builder.build();
}

Ejemplo de Uso

Con esta configuración, el uso de restTemplate es el mismo, pero ahora tiene todas las configuraciones adicionales que hemos decidido aplicar. Aquí hay un ejemplo de cómo realizar una solicitud POST:

public ResponseEntity postDataToApi(SomeRequestBody body) {
    String url = "https://api.example.com/data";
    return this.restTemplate.postForEntity(url, body, String.class);
}

Conclusión

Hemos explorado varias maneras de configurar un RestTemplate en una aplicación Spring. Desde usar la construcción por defecto hasta crear un RestTemplateCustomizer e incluso crear nuestro propio RestTemplateBuilder, hay diversas opciones dependiendo de las necesidades específicas de su aplicación.

Consejos Prácticos

• Utilizar RestTemplateBuilder siempre que sea posible: Esto permite una configuración más simple y menos prone a errores.
• Inyectar interceptores: Hacer uso de interceptores es una buena práctica para gestionar las solicitudes de manera centralizada, facilitando el seguimiento y el manejo de las respuestas.
• Documentar las configuraciones personalizadas: Cualquier personalización debe ser claramente documentada para que los futuros desarrolladores que mantengan el código entiendan las razones detrás de las elecciones de diseño.

A medida que construyas más servicios, experimentar con estas configuraciones te ayudará a optimizar y personalizar tus interacciones con APIs externas de manera efectiva. Mantente al día con las mejoras del framework Spring y sigue mejorando tu dominio sobre la programación en Java.