WebClient와 RestTemplate 그리고 RestClient

 

외부API와 연동할 때 사용하는 RestTemplate과 WebClient 간에 어떤 차이가 있을지 찾아보고, 어떤 기술을 프로젝트에 사용할지 고민해봤습니다.

 

Webflux ?

비동기(Async), 논블로킹(Non-blocking) 방식의 리액티브 프로그래밍을 지원하는 스프링 프레임워크의 모듈입니다.

 

WebClient

Spring WebFlux에서 제공하는 HTTP 요청을 보내기 위해 사용하는 인터페이스입니다.

 

RestTemplate ?

블로킹(Blocking) 기반의 동기 방식의 Spring MVC의 HTTP 클라이언트입니다.

그렇기 때문에 스레드가 다 차있는 경우 Queue에서 대기를 하게되어 요청이 많아지게 되면 병목 현상이 나타날 수 있습니다. 이는 서비스 성능 저하로 연결될 것입니다.

 

WebClient VS RestTemplate 비교해보기

하나의 비즈니스 로직 내에서 단일 API 요청만 이루어지는 상황 (요청 수가 적은 상황)에서는 RestTemplate과 WebClient의 차이가 미미합니다.

현재 프로젝트에서는 많은 수의 요청을 보내지는 않지만 아래와 같은 이유로 결론을 내리게 되었습니다.

• WebClient 코드는 가독성이 좋습니다.
• RestTemplate은 현재 유지관리 모드에 있으며 Spring에서 WebClient를 권장하고 있습니다.
• 서비스 확장성과 MSA 전환을 고려하여 설계하기로 했으므로 추후에 대규모 요청에 사용할 것을 대비하여 webClient 를 채택하였습니다.
  • 추후 reactive web 으로 전환된다면, 해당 클라이언트에서 비동기, 논블로킹 방식으로 간단히 변경이 가능할 것입니다.

 

RestTemplate 예시 코드

RestTemplate restTemplate = new RestTemplate();
HttpHeaders headers = new HttpHeaders();
headers.put(HttpHeaders.ACCEPT, Collections.singletonList(MediaType.APPLICATION_JSON_VALUE));
HttpEntity<String> entity = new HttpEntity<>(headers);

String result = restTemplate.exchange("https://example.com", HttpMethod.GET, entity, String.class).getBody();

*출처: https://poalim.tistory.com/59*

 

WebClient 코드

GeminiResponseDto aiAnswer = webClient.post()
    .uri(geminiApiUrl + geminiApiKey)
    .header("Content-Type", "application/json")
    .bodyValue(requestBody)
    .retrieve()
    .bodyToMono(GeminiResponseDto.class)
    .block();

 

RestClient의 등장

WebClient는 앞서 말한 장점을 가지고 있지만, Spring MVC 개발 환경에는 맞지 않습니다. 환경에 맞게 사용해주기 위해서는 .block() 으로 동기 처리를 해주어야 했습니다.

또한, WebFlux 라이브러리를 사용하기 위한 spring-webflux 의존성 추가가 필요합니다.

 

RestClient

RestClient는 동기식 HTTP Client입니다.

webflux에 비해 뒤늦게 발견하여 리팩토링을 진행했습니다.

webflux보다 Spring MVC 개발 환경에 적합합니다. webFlux와 달리 의존성을 넣지 않아도 됩니다.

 

RestClient 코드

ResponseEntity<GeminiResponseDto> aiAnswer = restClient.post()
                .uri(geminiApiUrl + geminiApiKey)
                .contentType(APPLICATION_JSON)
                .body(requestBody)
                .retrieve()
                .toEntity(GeminiResponseDto.class);

 

참고: https://docs.spring.io/spring-framework/reference/integration/rest-clients.html