[Spring Boot] RestClient를 활용한 HTTP 요청

 

목차

 

RestClient란?

Spring Framework 6.1 M2에서 새롭게 도입된 RestClient는 RestTemplate를 대체하는 동기식 HTTP 클라이언트입니다. 이 클라이언트는 HTTP 라이브러리에 대한 추상화를 제공하여 Java 객체를 HTTP 요청으로 쉽게 변환하고, HTTP 응답에서 객체를 생성할 수 있게 합니다. 또한, 가독성이 높은 API를 통해 간편하고 직관적인 사용성을 제공합니다.

 

주요 클래스와 메서드

• RestClient : HTTP 클라이언트를 생성하고 설정합니다.
  • create() : 기본 설정으로 초기화된 새로운 RestClient 인스턴스를 생성합니다.
  • builder() : 사용자 정의 설정을 통해 RestClient를 구성할 수 있는 빌더를 반환합니다.
  • get() : HTTP GET 요청을 시작합니다.
  • post() : HTTP POST 요청을 시작합니다.
  • put() : HTTP PUT 요청을 시작합니다.
  • patch() : HTTP PATCH 요청을 시작합니다.
  • delete() : HTTP DELETE 요청을 시작합니다.
  • head() : HTTP HEAD 요청을 시작합니다.
  • options() : HTTP OPTIONS 요청을 시작합니다.
  • uri() : 요청할 URI를 설정합니다. 각 HTTP 메서드와 함께 사용됩니다.
  • headers() : 요청에 사용할 HTTP 헤더들을 설정할 수 있습니다.
  • body() : 요청 본문을 설정할 수 있습니다. POST, PUT, PATCH 등의 요청에서 주로 사용됩니다.
  • retrieve() : 설정된 요청을 실행하고, 응답을 처리할 수 있는 RestClient.ResponseSpec 객체를 반환합니다.
  • toEntity() : RestClient.ResponseSpec에서 사용되는 메서드로, 응답을 지정한 타입의 엔티티로 변환하여 반환합니다.

 

RestClient 사용 예제

Spring Boot를 사용하면 Gradle 빌드 파일에 별도로 RestClient 의존성을 추가하지 않고도 HTTP 요청을 보낼 수 있습니다. 이는 Spring Boot의 자동 구성(auto-config) 기능 덕분에 필요한 라이브러리를 자동으로 추가하고 구성해주기 때문입니다. 다만, 구체적인 설정(예: 타임아웃 값 조정 등)이 필요한 경우에는 직접 설정을 추가해야 합니다.

추가적인 설정이 필요한 경우, ClientHttpRequestFactorySettings를 사용하여 연결 타임아웃(withConnectTimeout)과 읽기 타임아웃( withReadTimeout)을 각각 5초로 설정한 후, 이를 스프링 빈으로 등록할 수 있습니다. 이렇게 하려면 먼저 Gradle 빌드 파일에 아래와 같이 spring-boot-starter-web 의존성을 추가해야 합니다.

 

1. RestClient 설정

build.gradle

dependencies {
    implementation 'org.springframework.boot:spring-boot-starter-web'
}

 

RestClientConfig.java

@Configuration
public class RestClientConfig {

  /**
   * RestClient 빈을 생성
   *
   * @return RestClient 객체
   */
  @Bean
  public RestClient restClient() {
    return RestClient.builder()
        .requestFactory(customRequestFactory())
        .build();
  }

  /**
   * ClientHttpRequestFactory를 생성
   *
   * @return ClientHttpRequestFactory
   */
  ClientHttpRequestFactory customRequestFactory() {
    ClientHttpRequestFactorySettings settings = ClientHttpRequestFactorySettings.DEFAULTS
        .withConnectTimeout(Duration.ofSeconds(5))  // 연결 타임아웃을 5초로 설정
        .withReadTimeout(Duration.ofSeconds(5)); // 읽기 타임아웃을 5초로 설정
    return ClientHttpRequestFactories.get(settings);
  }
}

 

2. HTTP 요청을 위한 유틸리티 클래스

HttpUtil 클래스는 RestClient을 활용하여 다양한 HTTP 메서드(GET, POST, PUT, DELETE)를 사용하여 HTTP 요청을 보내고, 서버로부터 응답을 받아 이를 DTO 객체로 반환하는 유틸리티 클래스입니다.

HttpUtil.java

import lombok.AllArgsConstructor;
import org.springframework.http.MediaType;
import org.springframework.http.ResponseEntity;
import org.springframework.stereotype.Component;
import org.springframework.util.MultiValueMap;
import org.springframework.web.client.RestClient;

/**
 * RestClient를 활용한 HTTP 요청(GET, POST, PUT, DELETE)을 위한 유틸리티 클래스
 */

@AllArgsConstructor
@Component
public class HttpUtil {

  private final RestClient restClient;

  /**
   * GET 요청을 보내고 응답을 객체로 반환
   *
   * @param targetUrl    요청을 보낼 URL
   * @param headers      요청 헤더 정보
   * @param responseType 응답을 매핑할 클래스 타입
   * @return 응답 객체
   */
  public <T> ResponseEntity<T> sendGet(String targetUrl, MultiValueMap<String, String> headers,
      Class<T> responseType) {
    return restClient.get()
        .uri(targetUrl)
        .accept(MediaType.APPLICATION_JSON)
        .headers(httpHeaders -> httpHeaders.addAll(headers))
        .retrieve()
        .toEntity(responseType);
  }

  /**
   * POST 요청을 보내고 응답을 객체로 반환
   *
   * @param targetUrl    요청을 보낼 URL
   * @param headers      요청 헤더 정보
   * @param body         요청 본문 객체
   * @param responseType 응답을 매핑할 클래스 타입
   * @return 응답 객체
   */
  public <T> ResponseEntity<T> sendPost(String targetUrl, MultiValueMap<String, String> headers,
      Object body, Class<T> responseType) {
    return restClient.post()
        .uri(targetUrl)
        .contentType(MediaType.APPLICATION_JSON)
        .headers(httpHeaders -> httpHeaders.addAll(headers))
        .body(body)
        .retrieve()
        .toEntity(responseType);
  }

  /**
   * PUT 요청을 보내고 응답을 객체로 반환
   *
   * @param targetUrl    요청을 보낼 URL
   * @param headers      요청 헤더 정보
   * @param body         요청 본문 객체
   * @param responseType 응답을 매핑할 클래스 타입
   * @return 응답 객체
   */
  public <T> ResponseEntity<T> sendPut(String targetUrl, MultiValueMap<String, String> headers,
      Object body, Class<T> responseType) {
    return restClient.put()
        .uri(targetUrl)
        .contentType(MediaType.APPLICATION_JSON)
        .headers(httpHeaders -> httpHeaders.addAll(headers))
        .body(body)
        .retrieve()
        .toEntity(responseType);
  }

  /**
   * DELETE 요청을 보내고 응답을 객체로 반환
   *
   * @param targetUrl    요청을 보낼 URL
   * @param headers      요청 헤더 정보
   * @param responseType 응답을 매핑할 클래스 타입
   * @return 응답 객체
   */
  public <T> ResponseEntity<T> sendDelete(String targetUrl, MultiValueMap<String, String> headers,
      Class<T> responseType) {
    return restClient.delete()
        .uri(targetUrl)
        .headers(httpHeaders -> httpHeaders.addAll(headers))
        .retrieve()
        .toEntity(responseType);
  }
}

 

3. 단위 테스트 작성

HttpUtil 클래스를 테스트하여 HTTP 요청(GET, POST, PUT, DELETE)이 정상적으로 동작하는지 확인합니다.

 

3_1. GET 요청 테스트

GET 요청을 보내고, 응답의 ID가 요청한 ID와 같은지 확인합니다.

@DisplayName("GET 요청: ID를 기준으로 포스트 조회 후 응답 ID 확인")
@Test
public void testGetRequest() throws Exception {

  // Given
  MultiValueMap<String, String> headers = new LinkedMultiValueMap<>();
  headers.add("key1", "value1");
  headers.add("key1", "value2");
  headers.add("key2", "value1");

  // When
  ResponseEntity<PostDTO> response = httpUtil.sendGet(TEST_GET_URL, headers, PostDTO.class);
  log.debug("response: {}", objectMapper.writeValueAsString(response.getBody()));

  // Then
  assertAll(
          () -> assertNotNull(response),
          () -> assertNotNull(response.getBody()),
          () -> assertEquals(1, response.getBody().getId())
  );
}

 

3_2. POST 요청 테스트

POST 요청을 보내고, 응답의 title과 body가 요청한 값과 같은지 확인합니다.

@DisplayName("POST 요청: 포스트 저장 후 응답의 title과 body 확인")
  @Test
  public void testPostRequest() throws Exception {

    // Given
    MultiValueMap<String, String> headers = new LinkedMultiValueMap<>();
    headers.add("key1", "value1");
    headers.add("key1", "value2");
    headers.add("key2", "value1");

    PostDTO postData = PostDTO.builder()
        .title("foo")
        .body("bar")
        .userId(1)
        .build();

    // When
    ResponseEntity<PostDTO> response = httpUtil.sendPost(TEST_POST_URL, headers,
        postData, PostDTO.class);
    log.debug("response: {}", objectMapper.writeValueAsString(response.getBody()));

    // Then
    assertAll(
        () -> assertNotNull(response),
        () -> assertNotNull(response.getBody()),
        () -> assertEquals("foo", response.getBody().getTitle()),
        () -> assertEquals("bar", response.getBody().getBody())
    );
  }

 

3_3. PUT 요청 테스트

PUT 요청을 보내고, 응답의 title과 body가 요청한 값과 같은지 확인합니다.

@DisplayName("PUT 요청: 포스트 수정 후 응답의 title과 body 확인")
  @Test
  public void testPutRequest() throws Exception {

    // Given
    MultiValueMap<String, String> headers = new LinkedMultiValueMap<>();
    headers.add("key1", "value1");
    headers.add("key1", "value2");
    headers.add("key2", "value1");

    PostDTO putData = PostDTO.builder()
        .id(1)
        .title("foo")
        .body("bar")
        .userId(1)
        .build();

    // When
    ResponseEntity<PostDTO> response = httpUtil.sendPut(TEST_PUT_URL, headers,
        putData, PostDTO.class);
    log.debug("response: {}", objectMapper.writeValueAsString(response.getBody()));

    // Then
    assertAll(
        () -> assertNotNull(response),
        () -> assertNotNull(response.getBody()),
        () -> assertEquals("foo", response.getBody().getTitle()),
        () -> assertEquals("bar", response.getBody().getBody())
    );
  }

 

3_4. DELETE 요청 테스트

DELETE 요청을 보내고, 응답이 빈 값인지 확인합니다.

@DisplayName("DELETE 요청: 포스트 삭제 후 응답이 빈 값인지 확인")
  @Test
  public void testDeleteRequest() throws Exception {

    // Given
    MultiValueMap<String, String> headers = new LinkedMultiValueMap<>();
    headers.add("key1", "value1");
    headers.add("key1", "value2");
    headers.add("key2", "value1");

    // When
    ResponseEntity<PostDTO> response = httpUtil.sendDelete(TEST_DELETE_URL, headers, PostDTO.class);
    log.debug("response: {}", objectMapper.writeValueAsString(response.getBody()));

    // Then
    assertAll(
        () -> assertNotNull(response),
        () -> assertNotNull(response.getBody()),
        () -> assertEquals(null, response.getBody().getTitle()),
        () -> assertEquals(null, response.getBody().getBody())
    );
  }

 

참고

• Spring 공식 문서 - REST Clients
• A Guide to RestClient in Spring Boot

 

자세한 소스 코드는 Github Repository를 참조하세요.

 

관련 글

[Spring Boot] RestTemplate를 활용한 HTTP 요청

[Spring Boot] RestClient, HttpInterface를 활용한 HTTP 요청

[Spring Boot] Apache HttpClient 5 기반 RestClient 구성하기