HTTP Clients in Spring Boot

먼저, 스프링에서 외부 API를 호출하는 방법에 대해서 하나씩 알아보자.

Java 표준 라이브러리인 HttpURLConnection 은 넘어가자.

기본적인 요청/응답 기능을 제공하지만, 응답 처리가 복잡하며 코드의 가독성이 낮다는 단점으로 잘 사용하지 않는다.

1. RestTemplate

만약 RestTemplate을 사용할 것이라면 아래의 글의 주의사항을 참고하자. https://incheol-jung.gitbook.io/docs/q-and-a/spring/resttemplate

REST Clients :: Spring Frameworkdocs.spring.io

대표적인 Spring의 HTTP Client 중 하나이지만, 다음과 같은 대안을 권장하고 있다.

image

• 동기식 요청: RestClient

• 비동기/스트리밍: WebClient

주요 특징

• 오랫동안 Spring 진영에서 지원되고 있음

• 동기식 Blocking 방식으로 동작

• RESTful 원칙 준수

기본적인 사용법

Bean 등록

@Configuration
public class RestTemplateConfig {
    @Bean
    public RestTemplate restTemplate() {
        return new RestTemplate();
    }
}

요청 예시

@Service
public class ExampleService {
    private final RestTemplate restTemplate;
    
    public String getData() {
        return restTemplate.getForObject(
            "http://example.com/api",
            String.class
        );
    }
}

RestTemplate을 사용하여 외부 API를 호출해야하는 상황일 경우 타임아웃(Timeout), 재시도(retry), 로깅(Logging), 서킷 브레이커 등을 설정하는 방법을 알아두면 좋을 것 같다.

• [Spring] RestTemplate 타임아웃(Timeout), 재시도(Retry), 로깅(Logging) 등 설정하기 [Spring] RestTemplate에

• Resilence4J 서킷 브레이커 적용하는 방법과 예시

2. WebClient

WebClient :: Spring Frameworkdocs.spring.io

Spring WebFlux에 포함된 HTTP 클라이언트로, Non-Blocking I/O를 활용한 리액티브 프로그래밍 모델을 기반으로 한다.

주요 특징

• 비동기/Non-Blocking 방식 지원

• 싱글 스레드 방식으로 동작

• Reactor 기반의 선언적 API 제공

Reactor: JVM 위에서 동작하는 논블로킹 애플리케이션을 만들기 위한 리액티브 라이브러리

기본적인 사용법

Bean 등록

@Configuration
public class WebClientConfig {
    @Bean
    public WebClient webClient() {
        return WebClient.builder()
            .baseUrl("http://api.example.com")
            .defaultHeader(HttpHeaders.CONTENT_TYPE, MediaType.APPLICATION_JSON_VALUE)
            .build();
    }
}

요청 예시

@Service
public class ExampleService {
    private final WebClient webClient;
    
    public Mono<UserResponse> getUser(String userId) {
        return webClient.get()
            .uri("/users/{id}", userId)
            .retrieve()
            .bodyToMono(UserResponse.class);
    }
}

만약 학습이 필요하다면 아래의 공식 레퍼런스를 한글로 번역한 문서를 확인하면 좋을 것 같다.

Spring WebFlux (1)토리맘의 한글라이즈 프로젝트

3. OpenFeign (FeignClient)

Spring Cloud OpenFeigndocs.spring.io

Spring Cloud OpenFeign은 Netflix에서 개발한 선언적 REST 클라이언트로, org.springframework.cloud 패키지에 포함이 되어있다.

주요 특징

• 선언적 REST Client - 인터페이스 + 어노테이션으로 구현 가능

• 동기식 HTTP 통신 방식 (비동기 처리도 가능)

기본적인 사용법

@FeignClient(name = "book-service", url = "${api.book.url}")
public interface BookClient {
    @GetMapping("/api/books")
    List<Book> searchBooks(
        @RequestParam String query,
        @RequestHeader(HttpHeaders.AUTHORIZATION) String authorization
    );
}

위처럼 Spring MVC의 어노테이션 방식으로 동일하게 사용이 가능합니다.

만약, RestTemplate 을 사용한다 했다면 아래와 같은 코드 구조로 호출을 해야한다.

@Component
@RequiredArgsConstructor
public class BookRestTemplate {

    private final RestTemplate restTemplate;
    private final String apiUrl;
    private final String apiKey;

    public List<Book> search(String query) {
        String url = createSearchUrl(query);
        HttpHeaders headers = createHeaders();
        
        HttpEntity<?> entity = new HttpEntity<>(headers);
        
        ResponseEntity<List<Book>> response = restTemplate.exchange(
            url,
            HttpMethod.GET,
            entity,
            new ParameterizedTypeReference<List<Book>>() {}
        );
        return response.getBody();
    }

    private String createSearchUrl(String query) {
        return UriComponentsBuilder.fromUriString(apiUrl)
            .path("/api/books")
            .queryParam("query", query)
            .encode()
            .build()
            .toUriString();
    }

    private HttpHeaders createHeaders() {
        HttpHeaders headers = new HttpHeaders();
        headers.set(HttpHeaders.AUTHORIZATION, "KEY " + apiKey);
        return headers;
    }
}

특징

1. 직관적인 인터페이스 기반으로 설계가 가능하며, 보일러플레이트 코드가 최소화 됩니다.

2. 코드의 가독성 측면에서도 뛰어나다.

3. 확장성을 고려했을 때 Retry, Circuit Breaker 등을 도입하기 편하다.

하지만, 어노테이션과 인터페이스 기반으로 테스트를 통해 확인해야하지만 테스트 도구를 지원하지 않는다는 단점이 존재한다.

읽어볼거리

feign 좀더 나아가기 | 우아한형제들 기술블로그우아한형제들 기술블로그 |

Feign 코드 분석과 서버 성능 개선Toss_service