[Spring] 🌱 RestTemplate

🌱 RestTemplate

RestTemplate 이란?

지금까지 해오던 간단한 개발들은 Client, 브라우저로부터 요청을 받는 서버의 입장에서 개발을 했었습니다. 그러나 소셜 로그인, 결제, 전화번호 인증 등 라이브러리 사용만으로는 구현이 어려운 기능들이 많이 있습니다.

이러한 경우 기존의 클라이언트에게 요청을 받는 서버의 입장이었지만, 기존 서버가 클라이언트 입장에서 다른 서버의 API에 요청을 보내야 합니다.

Spring에서는 이러한 요청을 간편하게 할 수 있도록 도와주는 🌱 RestTemplate 기능을 제공하고 있습니다.

RestTemplate는 스프링 3.0부터 지원되었고, json, xml 모두 응답 받을 수 있습니다. 또한 HTTP 의 메소드(GET, POST, PATCH, DELETE)를 요청 가능하게 도와주고, 요청에 실어 보낼 header, body나 query들도 설정할 수 있도록 메소드를 제공합니다.

RestTemplate 동작 원리

1. 어플리케이션 내부(클라이언트 입장의 서버) 에서 RestTemplate를 생성하고, URI, HTTP 헤더, body등을 담아 요청을 보냅니다.

2. RestTemplate는 HttpMEssageConverter를 사용하여 requestEntity를 요청메세지로 변환합니다.

3. RestTemplate 는 ClientHttpRequestFactory 로 부터 ClientHttpRequest를 가져와 요청을 보냅니다.

4. ClientHttpRequest 는 요청메세지를 만들어 HTTP를 통해 서버(서버 입장의 서버)에 요청합니다.

5. ResponseTemplate 는 ResponseErrorHandler로 오류를 처리합니다.

6. ClientHttpResponse에서 응답 데이터를 가져와 오류가 있으면 처리합니다.

7. RestTemplate는 HttpMessageConverter를 이용해 응답 메세지를 java object로 변환합니다.

8. 어플리케이션에 반환 됩니다.

---

RestTemplate 의존관계 주입

생성자 주입을 통해 RestTemplate를 주입받으려고 하면 아래와 같은 오류 메세지를 확인할 수 있습니다.

⛔️ Could not autowire. No beans of 'RestTemplate' type found.

이렇게 의존관계 주입이 일어나지 않는 이유는 RestTemplate는 RestTemplateBuilder의 .build() 메소드를 통해 받아올 수 있기 때문입니다.

따라서 위와같이 Builder를 먼저 주입받은 후 RestTemplate를 호출하여 의존관계 주입을 할 수 있습니다.

---

🌱 RestTemplate 요청 보내기

Get, Post, Patch, Delete요청은 메소드의 이름에 따라 원하는 요청을 보낼 수 있습니다.

URI를 생성하여 인자로 전달해주고, 필요에 따라 body, header, 반환받을 ClassType등을 추가로 전달해 줍니다.

URI 생성하기

RestTemplate에 담을 URI는 다음과 같이 생성할 수 있습니다.

URI끝에 붙는 ?key=value 형식의 QueryParameter는 queryParam("key","value") 의형식으로 추가 가능하고,

URI의 {id} 같은 PathVariable은 expand()를 통해 지정할 수 있습니다.

RestTemplate HTTP 요청 예시

body부분에는 HTTP Request의 Body부분에 담아서 보내고싶은 객체를 인자로 전달하면 RestTemplate내부에서 HTTP body에 변환하여 담아줍니다.

💡 exchange는 requestEntity에 HTTP메소드를 담아 원하는 요청을 보낼 수 있습니다.

exchange

exchange 같은 경우 RequestEntity를 인자로 전달해야 한다는 부분이 조금 다릅니다. 위에서 봤던 getForEntity 와 같이 어떤 요청을 보낼 것이라고 명시되어 있지 않기 때문에, GET요청을 보낼지 POST 요청을 보낼 지 따로 설정을 해 주어야 합니다. 이러한 메소드 형식을 RequestEntity 에 담아서 전달함으로써 정할 수 있습니다.

위와 같이 .post, .get 등을 통해 어떠한 요청을 보낼 것인지 정하고, .header를 통해 헤더에 토큰 값 등을 실어 보내는 것도 가능하고, .body를 통해 어떠한 내용을 담아 보낼 것인지 지정할 수 있습니다.

그리고 이러한 RequestEntity 객체를 exchange의 인자로 전달해 원하는 요청을 보낼 수 있습니다.

---

🌱 RestTemplate 응답 처리하기

요청을 올바르게 보냈다면 그에대한 응답이 지정했던 Type에 맞게반환값에 담겨 넘어오게 됩니다. (String.class으로 지정하면 ResponsEntity<String> 으로 반환받게 됌)

반환받은 ResponseEntity에서 응답으로 넘어온 HttpStatus 코드와, body를 받아올 수 있습니다.

body 값을 원하는 형식의 클래스로 변환할 수 있어 바로 변환해 해당 값을 Client(브라우저) 에게 전달 할 수도 있겠지만,

보통 받아오는 응답은 아래와 같이 Json 내부에 Json이 중첩되어 반환되는 경우가 많아 이러한 경우는 String.class로 응답을 받은 후 JSONObject 와 JSONArray 를 사용하여 원하는 형식으로 처리가 가능합니다.

{
"items":[
		{"title":"Mac","price":3888000},
		{"title":"iPad","price":1230000},
		{"title":"iPhone","price":1550000},
		{"title":"Watch","price":450000},
		{"title":"AirPods","price":350000}
	]
}

JSONObject 와 JSONArray 사용하여 응답 처리

1. 문자열 정보를 JSONObject로 바꾸기
   

2. JSONObject에서 items 배열 꺼내기
   

3. enhanced-for문으로 하나하나 Dto로 변환하기
   

4. Dto 생성자 내부에서 JSONObject의 값 꺼내어 생성하기
   

---

참고

• https://sjh836.tistory.com/141