[Spring] RestTemplate

RestTemplate란?

• Spring에서 지원하는 객체로 간편하게 Rest 방식 API를 호출할 수 있는 Spring 내장 클래스
• Spring 3.0부터 지원되었고, json, xml 응답을 모두 받을 수 있다.
• Rest API 서비스를 요청 후 응답 받을 수 있도록 설계되어있으며 HTTP 프로토콜의 메소드(ex. GET, POST, DELETE, PUT)들에 적합한 여러 메소드들을 제공한다.

 

 

RestTemplate의 특징

 

• Spring 3.0 부터 지원하는 Spring의 HTTP 통신 템플릿
•  HTTP 요청 후 JSON, XML, String 과 같은 응답을 받을 수 있는 템플릿
•  Blocking I/O 기반의 동기방식을 사용하는 템플릿
•  RESTful 형식에 맞추어진 템플릿
•  Header, Content-Tpye등을 설정하여 외부 API 호출
•  Server to Server 통신에 사용
  

 

 

API 호출 클래스 종류

 

• RestTemplate
  • Spring 3부터 지원 되었고 REST API 호출이후 응답을 받을 때까지 기다리는 동기방식
• WebClient
  • Spring 5에 추가된 논블럭, 리엑티브 웹 클리이언트로 동기, 비동기 방식을 지원한다.
• RestTempalte 과 WebClient의 차이
  • Non-Blocking과 비동기화 가능 여부
  • 스프링 4.0에서 RestTemplate의 비동기 문제를 해결하기 위해 AsyncRestTemplate을 잠깐 사용하긴 했지만, 현재 deprecated 된 상태이므로 WebClient의 사용을 권장한다.
  • Non-Blocking?
    시스템을 호출한 직후에 프로그램으로 제어가 다시 돌아와서 시스템 호출의 종료를 기다리지 않고 다음 동작을 진행한다. 호출한 시스템의 동작을 기다리지 않고 동시에 다른 작업을 진행할 수 있어서 작업의 속도가 빨라진다는 장점이 있다.

 

 

 

의존성 설정

 

기본 스프링 부트 의존성을 추가하면 RestTemplate 관련 의존성은 자동으로 추가된다

implementation 'org.springframework.boot:spring-boot-starter-web'

 

 

RestTemplate 메서드

 

 

 

요청 URI 설정 방법

 

• String 변수 사용,  URI 객체 사용, UriComponents 객체 사용

 

package com.example.dockerphamarcyproject.api.service;

import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Service;
import org.springframework.web.util.UriComponentsBuilder;

import java.net.URI;

@Slf4j
@Service
public class KakaoUriBuilderService {//uri를 만드는 서비스

    private static final String KAKAO_LOCAL_SEARCH_ADDRESS_URL = "https://dapi.kakao.com/v2/local/search/address.json";

    private static final String KAKAO_LOCAL_CATEGORY_SEARCH_URL = "https://dapi.kakao.com/v2/local/search/category.json";

    public URI buildUriByAddressSearch(String address) {
        //URI를 구성하는 Components들을 효과적으로 다룰 수 있도록 하는 클래스
        UriComponentsBuilder uriBuilder = UriComponentsBuilder.fromHttpUrl(KAKAO_LOCAL_SEARCH_ADDRESS_URL);
        uriBuilder.queryParam("query", address);

        URI uri = uriBuilder.build().encode().toUri();
        log.info("[KakaoAddressSearchService buildUriByAddressSearch] address: {}, uri: {}", address, uri);

        return uri;
    }
}

 

 

 

RestTemplate 사용 순서

 

1. 결과값을 담을 객체를 생성한다.
2. 타임아웃 설정시 HttpComponentsClientHttpRequestFactory 객체를 생성한다.
3. RestTemplate 객체를 생성한다.
4. header 설정을 위해 HttpHeader 클래스를 생성한 후 HttpEntity 객체에 넣는다.
5. 요청 URL을 정의한다.
6. exchange() 메소드로 api를 호출한다.
7. 요청한 결과를 HashMap에 추가한다.

 

package com.example.dockerphamarcyproject.api.service;

import com.example.dockerphamarcyproject.api.dto.KakaoApiResponseDto;
import lombok.RequiredArgsConstructor;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.http.HttpEntity;
import org.springframework.http.HttpHeaders;
import org.springframework.http.HttpMethod;
import org.springframework.retry.annotation.Backoff;
import org.springframework.retry.annotation.Recover;
import org.springframework.retry.annotation.Retryable;
import org.springframework.stereotype.Service;
import org.springframework.util.ObjectUtils;
import org.springframework.web.client.RestTemplate;

import java.net.URI;


@Slf4j
@Service
@RequiredArgsConstructor
public class KakaoAddressSearchService {// 실제로 api를 호출해서 응답값을 잘 받아오는지 확인

    private final RestTemplate restTemplate; // 의존성 주입
    private final KakaoUriBuilderService kakaoUriBuilderService;

    @Value("${kakao.rest.api.key}")
    private String kakaoRestApiKey;

    @Retryable(
            value = {RuntimeException.class},
            maxAttempts = 2,
            backoff =  @Backoff(delay = 2000)
    )
    public KakaoApiResponseDto requestAddressSearch(String address) {
        //고객이 문자 기반 주소로 요청하게 되면 이 메서드가 위치 기반 데이터(KakaoApiResponseDto)로 반환함

        if(ObjectUtils.isEmpty(address)) return null;

        URI uri = kakaoUriBuilderService.buildUriByAddressSearch(address); //실제 카카오 uri를 반환한다.

        HttpHeaders headers = new HttpHeaders();
        headers.set(HttpHeaders.AUTHORIZATION, "KakaoAK " + kakaoRestApiKey);

        // HttpEntity = HTTP요청또는 응답에 해당하는 HttpHeader와 HttpBody를 포함하는 클래스
        // HttpEntity 클래스를 상속받아 구현한 클래스가 RequestEntity, ResponseEntity 클래스이다.
        HttpEntity httpEntity = new HttpEntity<>(headers);

    // restTemplate.exchange(): 지정된 HTTP 메서드를 URL에 대해 실행하며, Responsebody와 연결되는 객체를 포함한 responseEntity를 반환한다.
        return restTemplate.exchange(uri, HttpMethod.GET, httpEntity, KakaoApiResponseDto.class).getBody();//body만 필요해서 body return
        // exchange(uri, 메서드 방식, httpEntity, 전달받은 클래스)
    }

    //재처리를 모두 다 실패했을 경우 처리방법 정의
    //주의해야할점은 원래 메서드의 return 타입을 맞춰줘야한다.
    @Recover
    public KakaoApiResponseDto recover(RuntimeException e, String address){
        log.error("All the retries failed. address : {}, error : {}", address, e.getMessage());
        return null;
    }

}

 

출처

https://blog.naver.com/hj_kim97/222295259904

https://tecoble.techcourse.co.kr/post/2021-07-25-resttemplate-webclient/