Spring에서 사용하는 RestTemplate , OkHttp, REST API 예제 사이트

 

1️⃣ RestTemplate란? 

스프링에서 제공하는 것으로 http 통신에 유용하게 쓸 수 있는 템플릿이다. 

REST API를 호출할 수 있는 Spring 내장 클래스로  REST API 호출이후 응답받을 때 까지 기다리는 동기방식이다. 

 

OkHttp란? 

REST API, HTTP 통신을 간편하게 사용할 수 있도록 만들어진 자바 라이브러리이다. 

Okhttp 라이브러리를 사용하면 REST api, Http 기반의 요청, 응답을 처리할 수 있다. 

 

//okhttp
implementation 'com.squareup.okhttp3:okhttp:4.9.3'

-> build.gradle에 추가해주고 refresh 해준다. 

 

-> Spring boot는 RestTemplate + Okhttp 연결풀을 사용해서 메시지를 보낸다. 

Okhttp 설정을 위한 OkhttpConfiguration  참고 사이트 

https://programmer.help/blogs/springboot-uses-resttemplate-okhttp-connection-pool-to-send-http-messages.html

 

RestTemplate 설정 파일 

-> restTemplate.setErrorHandller에서  return false로 해줘야 4xx, 5xx 에러를 직접 처리할 수 있다. 

 

2️⃣ RestTemplate 메서드 

GET 

- getForObject() :  주어진 URL 주소로 HTTP GET 메서드로 객체의 결과를 반환 받는다. 

- getForEntity() : 주어진 URL 주소로 HTTP GET 메서드로 결과는 ResponseEntity로 반환받는다. 

 

POST

- postForObject() : POST로 요청을 보내고 객체로 결과를 반환 받는다.

- postForEntity() : POST로 요청을 보내고 결과로 ResponseEntity로 반환 받는다. 

 

exchange() : HTTP 헤더를 새로 만들수도 있고 어떤 HTTP 메서드도 사용 가능하다. 

 

 

❗ 

참고로 REST API 예제를 실행하기 위해 예제 사이트를 찾았다! 

https://jsonplaceholder.typicode.com/

JSONPlaceholder - Free Fake REST API

이 사이트에서 GET, POST 등의 요청을 해서 테스트해볼 예정이다. 

 

 

3️⃣ GET 메서드 

 

- getForObject() 

: 주어진 URL 주소로 HTTP GET 메서드로 객체의 결과를 반환 받는다. 

실행 결과

(TestVo로의 매핑은 jackson-databind가 해준다. )

 

 

- getForEntity()

: 주어진 URL 주소로 HTTP GET 메서드로 결과는 ResponseEntity로 반환받는다. 

이 장점은 응답을 ResponseEntity 객체로 반환 받아서 getForObject()와는 달리 HTTP 응답에 대한 추가 정보를 담고 있어 get 요청에 대한 응답 코드, 실제 데이터 등을 확인할 수 있다. 

그리고 ResponseEntity<T> 지네릭 타입에 따라서 응답을 String이나 Object 객체로 받을 수 있다.

 

- exchange() 

: HTTP 헤더를 새로 만들수도 있고 어떤 HTTP 메서드도 사용 가능하다. 

 

 

 

4️⃣ POST 메서드 

 

- postForObject()

: POST로 요청을 보내고 객체로 결과를 반환 받는다.

실행 결과

 

 

- postForEntity()

:  POST로 요청을 보내고 결과로 ResponseEntity로 반환 받는다.

-> header 정보를 포함해서 보낼 수도 있다. 

 

 

- exchange()

: HTTP 헤더를 새로 만들수도 있고 어떤 HTTP 메서드도 사용 가능하다.