RestTemplate 이란, 메소드, 사용예시

RestTemplate 이란?

간편하게 REST 방식의 API를 호출할 수 있는 Spring 내장 클래스입니다.
Spring 3.0부터 지원하며, Spring 5.0 이후부터는 WebClient를 사용합니다.
RESTful 원칙을 지키며, HTTP의 여러 메서드를 제공합니다.
JSON, String, XML 모두 응답받습니다.
Blocking I/O 기반의 동기 방식을 사용합니다.
Header + Content-Type을 설정해 외부와 통신이 가능합니다.

RestTemplate 메서드

메서드	HTTP	설명
getForObject	GET	주어진 URL 주소로 GET 메서드로 객체로 결과를 반환
getForEntity	GET	주어진 URL 주소로 GET 메서드로 객체로 결과를 ResponseEntity로 반환
postForLocation	POST	POST 요청을 보내고 결과로 헤더에 저장된 URI를 결과로 반환
postForObject	POST	POST 요청을 보내고 객체로 결과를 반환
postForEntity	POST	POST 요청을 보내고 결과로 ResponseEntity로 반환
delete	DELETE	주어진 URL 주소로 DELETE 메서드 실행
headForHeaders	HEADER	헤더의 모든 정보를 얻을 수 있으며 HTTP HEAD 메서드 사용
put	PUT	주어진 URL 주소로 PUT 메서드 실행
patchForObject	PATCH	주어진 URL 주소로 PATCH 메서드 실행
optionsForAllow	OPTIONS	주어진 URL 주소에서 지원하는 HTTP 메서드 조회
exchange	ANY	HTTP 헤더를 새로 만들 수 있고 어떤 HTTP 메서드도 사용 가능
execute	ANY	Request/Response 콜백 수정 가능

RestTemplate 사용 예시

Java

String path = "/restApi/test";
String param = "userId";

HttpComponentsClientHttpRequestFactory factory = new HttpComponentsClientHttpRequestFactory();
factory.setConnectTimeout(3000); // 타임아웃 설정 3초
factory.setReadTimeout(3000); // 타임아웃 설정 3초

UriComponentsBuilder builder = UriComponentsBuilder.fromUriString("http//127.0.0.1:8080");
builder.path(path);
builder.queryParam(param, param);

UriComponents uriComponents = builder.build().encode();

HttpHeaders httpHeaders = new HttpHeaders();
httpHeaders.add("Content-Type", "application/json");
httpHeaders.add("Accept", "*/*");
HttpEntity<MultiValueMap<String, Object>> requestEntity = new HttpEntity(httpHeaders);

UserDTO userDto = null;
try {
    RestTemplate restTemplate = new RestTemplate(factory);
    ResponseEntity<MinorPurchasableTO> responseEntity = restTemplate.exchange(uriComponents.toUri(), HttpMethod.PUT, requestEntity,UserDTO.class);
    HttpStatus httpStatus =  responseEntity.getStatusCode();
    if(HttpStatus.OK.equals(httpStatus)) {
        userDto = new UserDTO(httpStatus.value());
    }
}catch (HttpClientErrorException e){
    log.error("{}", "error...");
} catch (RuntimeException re){
    log.error("{}", "error...");
}
return userDto;

후기

오늘은 Spring에서 많이 사용하는 REST API 호출 방법에 대해 적어보았습니다. 글을 쓰다 보니 문득, 예전 면접에서 REST API 연동 경험을 물어봤을 때 당황했던 기억이 떠올랐습니다. 물론 통과하긴 했지만, 나름대로 정리해두는 것도 좋을 것 같아 작성하게 되었습니다.

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

https://backtony.github.io/spring/2021-07-12-spring-basic-8/

https://jjunn93.com/37

RestTemplate 이란, 메소드, 사용예시

RestTemplate 이란?

RestTemplate 메서드

RestTemplate 사용 예시

후기

댓글