Spring에서 외부 HTTP API와 연동하기

안녕하세요 졸린개발자입니다.

오늘은 Spring에서 외부 HTTP API와 연동하는 법에 대해서 알아보겠습니다.

 

Spring에는 외부의 http API와 통신하기 위해 RestTemplate, WebClient를 지원해줍니다.

 

이때 개발자는 2개중에 하나를 선택해야하는데 Spring에서는 WebClient를 추천합니다

 

RestTemplate 코드의 주석을 보면 다음과 같이 되어있습니다.

NOTE: As of 5.0 this class is in maintenance mode, with only minor requests for changes and bugs to be accepted going forward. Please, consider using the org.springframework.web.reactive.client.WebClient which has a more modern API and supports sync, async, and streaming scenarios.

즉, RestTemplate은 현재 마이너 패치만 될 것이므로 WebClient를 고려해보라는 것입니다.

 

그럼 WebClient를 이용하여 연동하는 법을 알아보겠습니다.

 

 

WebClient 생성

• create()

WebClient webClient = WebClient.create();

WebClient webClient = WebClient.create("url");

 

간단하게 만들때는 create() 함수를 사용해서 생성합니다.

create()함수에서는 url만을 이용하여 만들 수 있습니다.

 

 

• builder

WebClient webClient = WebClient.builder()
                .baseUrl("url")
                .build();

복잡한 설정을 거쳐 만들기 위해 builder()를 활용할 수도 있습니다.

baseUrl, defaultCookie, defaultHeader등, 복잡한 설정을 할 수 있습니다.

 

자세한 설정은 너무 많은 분량이므로, 이 포스트에서는 생략하겠습니다.

 

 

WebClient에 HTTP Method부여하기

WebClient를 생성하였다면, 다음으로 요청을 할 HTTP Method를 부여해야합니다.

HTTP Method를 부여해야 다음 설정을 할 수 있게 API설계가 되어있습니다

WebClient webClient = WebClient.create("https://cat-fact.herokuapp.com/facts");
webClient.get();
webClient.post();
webClient.patch();

 

 

HTTP 요청하고 응답받기

HTTP Method를 부여했으면, uri와 각종 헤더들을 설정하고

retrieve() 메소드로 요청을 보내고 받을 수 있습니다.

WebClient webClient = WebClient.create();
webClient.get()
        .uri("https://cat-fact.herokuapp.com/facts")
        .cookie("test", "test")
        .retrieve();

 

 

받은 응답을 처리하기

요청을 보냈으면, 응답을 받아서 변수에 저장하던, 추가적인 처리를 해야합니다.

WebClient webClient = WebClient.create();
webClient.get()
        .uri("https://cat-fact.herokuapp.com/facts")
        .cookie("test", "test")
        .retrieve()
        .bodyToMono(String.class)
        .subscribe(System.out::println);

 

저는 위의 예제코드에서 body를 Mono로 바꿔, println을 하였습니다.

 

body는 여러 형태로 바꿔 받을 수 있습니다

bodyToMono, bodyToFlux, toEntity, toEntityFlux 등등 받을 수 있습니다.

 

이렇게 body를 받으면, Flux나 Mono의 형태로 받을 수 있습니다.

 

이 이후에는 Reactor와 관련된 내용이니, 생략하겠습니다.

 

 

 

결론

오늘은 WebClient를 생성하고, 받은 응답을 처리하는 것까지 해보았습니다.

 

오늘도 긴글 읽어주셔서 감사합니다.