[Spring] RestTemplate, UriComponentsBuilder

RestTemplate

 

• Spring에서 지원하는 객체로 간편하게 Rest 방식 API를 호출할 수 있는 Spring 내장 클래스입니다.
• Spring 3.0부터 지원되었고, json, xml 응답을 모두 받을 수 있습니다.
  Rest API 서비스를 요청 후 응답 받을 수 있도록 설계되어있으며 HTTP 프로토콜의 메소드(ex. GET, POST, DELETE, PUT)들에 적합한 여러 메소드들을 제공합니다.
• Spring Framework 5부터는  WebClient 라는 새로운 HTTP 클라이언트를 도입하여 기존의 동기식 API를 제공할 뿐 만 아니라 효율적인 비차단 및 비동기 접근 방식을 지원하여, Spring 5.0 이후 부터는 RestTemplate는 deprecated 되었습니다. (WebClient 사용 지향)

 

 

RestTemplate의 특징

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

 

 

RestTemplate 메서드

 

 

 

Api 호출 클래스 종류

 

• RestTemplate
  • Spring 3부터 지원 되었고 REST API 호출이후 응답을 받을 때까지 기다리는 동기방식입니다
• AsyncRestTemplate
  • Spring 4에 추가된 비동기 RestTemplate입니다
  • Spring 5.0에서는 deprecated 되었습니다
• WebClient
  • Spring 5에 추가된 논블럭, 리엑티브 웹 클리이언트로 동기, 비동기 방식을 지원합니다.

 

 

RestTemplate 사용 방법

 

0. 결과값을 담을 객체를 생성합니다.

1. 타임아웃 설정시 HttpComponentsClientHttpRequestFactory 객체를 생성합니다.

2. RestTemplate 객체를 생성합니다.

3. header 설정을 위해 HttpHeader 클래스를 생성한 후 HttpEntity 객체에 넣어줍니다.

4. 요청 URL을 정의해줍니다.

5. exchange() 메소드로 api를 호출합니다.

6. 요청한 결과를 HashMap에 추가합니다.

 

 

 

UriComponents

 

• URI를 구성하는 Components들을 효과적으로 다룰 수 있도록 하는 클래스
• URI에 대한 정보를 각 구성요소별로 분리하여 변수에 저장하여 가지고 있는 URI 구성요소의 집합
• URI를 구성하는 컴포넌트
  •  Scheme
  • UserInfo
  • Host
  • Port
  • Path
  • Query
  • Fragment

 

UriComponentsBuilder

 

• UriComponents 를 Build할 수 있도록 도와주는 클래스
• 여러 개의 파라미터들을 연결하여 URL 형태로 만들어 주는 기능을 가지고 있다.
• 즉 Controller단에서 addAttribute로 하나 하나 속성을 지정해주지 않아도 이 class를 이용하면 손쉽고 간단하게 파라미터들을 전달할 수 있습니다.

 

 

예제 코드

//요청하는 검색 uri 생성
public SearchLocalRes searchLocal(SearchLocalReq searchLocalReq){
    URI uri = UriComponentsBuilder.fromUriString(naverLocalSearchUrl)
            .queryParams(searchLocalReq.toMultiValueMap())
            .build()
            .encode()
            .toUri();

    HttpHeaders headers = new HttpHeaders();
    headers.set("X-Naver-Client-Id", naverClientId);
    headers.set("X-Naver-Client-Secret", naverClientSecret);
    headers.setContentType(MediaType.APPLICATION_JSON);

    // 이 header를 entity 에 담기
    HttpEntity httpEntity = new HttpEntity<>(headers);

    //responseType 설정
    // ParameterizedTypeReference: 제네릭 타입을 인식하고 전달한다.
    // 자세하게는 RestTemplate의 응답 타입을 지정할 때 제네릭 정보를 정확하게 알아야 할 필요가 있다.
    // ParameterizedTypeReference에 <SearchLocalRes> 정보를 줘서 익명 자식 클래스를 만든다.
    // (참고로 ParameterizedTypeReference는 abstract 클래스라 직접 생성이 불가능하다)
    // 이 정보를 바탕으로 API의 응답값을 <SearchLocalRes> 타입으로 변환해서 받을 수 있는 것이다.
   var responseType = new ParameterizedTypeReference<SearchLocalRes>(){};

    //restTemplate 통해서 요청값 받기
    ResponseEntity<SearchLocalRes> responseEntity = new RestTemplate().exchange(
            uri,
            HttpMethod.GET,
            httpEntity,
            responseType
    );
    // ResponseEntity 타입으로 리턴받으면 좋은점은 상태코드, 헤더정보 등도 조회가 가능하다.

    // getBody를 통해서 결과를 return
    return responseEntity.getBody();

 

 

 

 

 

 

참조https://juntcom.tistory.com/141

https://blog.naver.com/PostView.naver?blogId=aservmz&logNo=222322019981