[Spring] OpenFeign 사용해보기

💡 OpenFeign이란?

Netflix에 의해 처음 만들어진 Declarative(선언적인) HTTP Client 도구로써, 외부 API 호출을 쉽게할 수 있도록 도와준다. Open Feign은 인터페이스에 어노테이션들만 붙여주면 구현이 된다. 이러한 방식은 Spring Data JPA와 유사하며, 상당히 편리하게 개발을 할 수 있도록 도와준다.

라이브러리 추가

ext {
    set('springCloudVersion', "2023.0.1")
}

dependencyManagement {
    imports {
        mavenBom "org.springframework.cloud:spring-cloud-dependencies:${springCloudVersion}"
    }
}

dependencies {
    ...
    implementation 'org.springframework.cloud:spring-cloud-starter-openfeign'
    ...
}

** 참고 https://spring.io/projects/spring-cloud#overview

현재 프로젝트 버전이 3.2.5여서 2023.0.x 버전을 사용했고, 그 중에서도 제일 최신 버전으로 작성해줬다!

OpenFeign 설정

메인 클래스에 @EnableFeignClients 를 붙여주면 된다.

이렇게 하면 @FeignClient 가 붙은 인터페이스를 자동으로 찾는다.

하지만 나는 별도의 Config 파일을 만들어서 설정해줬다.

package com.todayeat.backend._common.config;

import org.springframework.cloud.openfeign.EnableFeignClients;
import org.springframework.context.annotation.Configuration;

@Configuration
@EnableFeignClients("com.---.---")
public class OpenFeignConfig {

별도의 파일을 만들어 설정해줄 때는 인터페이스들의 위치를 지정해줘야 한다.

나는 @EnableFeignClients 를 붙여서 패키지로 지정해줬다.

클라이언트 구현

// 예시1

import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.http.HttpHeaders;
import org.springframework.http.MediaType;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestHeader;

@FeignClient(name = "KakaoRequestClient", url = "https://kapi.kakao.com")
public interface KakaoRequestClient {

    @PostMapping(value = "/v1/user/unlink", consumes = MediaType.APPLICATION_FORM_URLENCODED_VALUE)
    void unlink(@RequestHeader(HttpHeaders.AUTHORIZATION) String accessToken);
}

// 예시2

import com.todayeat.backend.order.api.dto.request.CancelPaymentRequest;
import com.todayeat.backend.order.api.dto.response.CancelPaymentResponse;
import com.todayeat.backend.order.api.dto.response.GetPaymentResponse;
import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.http.HttpHeaders;
import org.springframework.http.MediaType;
import org.springframework.web.bind.annotation.*;

@FeignClient(name = "IamportRequestClient", url = "https://api.portone.io")
public interface IamportRequestClient {

    @GetMapping(value = "/payments/{paymentId}", consumes = MediaType.APPLICATION_JSON_VALUE)
    GetPaymentResponse getPayment(@RequestHeader(HttpHeaders.AUTHORIZATION) String apiSecret,
                                  @PathVariable String paymentId,
                                  @RequestParam String storeId);

    @PostMapping(value = "/payments/{paymentId}/cancel", consumes = MediaType.APPLICATION_JSON_VALUE)
    CancelPaymentResponse cancelPayment(@RequestHeader(HttpHeaders.AUTHORIZATION) String apiSecret,
                                        @PathVariable String paymentId,
                                        @RequestBody CancelPaymentRequest request);
}

API 호출을 수행할 클라이언트는 인터페이스로 작성한 후, @FeignClient 를 붙여주면 된다.

기존의 컨트롤러와 굉장히 유사하게 작성이 가능하다!

서비스에서 해당 메서드를 호출하기만 하면 되기 때문에 편리하게 API 호출을 할 수 있다.

호출 예시

import com.todayeat.backend._common.oauth2.api.KakaoRequestClient;
import com.todayeat.backend._common.oauth2.dto.response.OAuth2Provider;
import com.todayeat.backend._common.oauth2.dto.response.OAuth2UserResponse;
import lombok.RequiredArgsConstructor;
import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Service;

@Slf4j
@Service
@RequiredArgsConstructor
public class OAuth2UnlinkService {

    private final KakaoRequestClient kakaoRequestClient;

    public void kakaoUnlink(String accessToken) {

        log.info("[OAuth2UnlinkService.kakaoUnlink]");
        kakaoRequestClient.unlink("Bearer " + accessToken);
    }
}

위의 예시1에서 작성한 클라이언트에 대한 호출 예시이다.

카카오 회원 탈퇴를 진행하였고, 반환값은 해당 로직에 불필요한 정보라고 판단하여 void로 받았다.

너무너무너무 간단하다. 끝!

예외 처리

private void cancelPayment(String paymentId) {

    try {
        iamportRequestClient.cancelPayment(
                PORTONE_PREFIX + IAMPORT_API_SECRET_V2,
                paymentId,
                CancelPaymentRequest.of("invalid value"));
    } catch (Exception e) {
        log.error("[OrderService.cancelPayment] paymentId {} error : {}", paymentId, e.getMessage());
        throw new BusinessException(ORDER_CANCEL_FAIL);
    }
}

HTTP 요청이 성공할 때는 객체가 성공적으로 매핑되지만,

그 외에는 모든 요청이 FeignException으로 처리된다.

// feign.FeignException#clientErrorStatus

switch (status) {
  case 400:
    return new BadRequest(message, request, body);
  case 401:
    return new Unauthorized(message, request, body);
  case 403:
    return new Forbidden(message, request, body);
  case 404:
    return new NotFound(message, request, body);
  case 405:
    return new MethodNotAllowed(message, request, body);
  case 406:
    return new NotAcceptable(message, request, body);
  case 409:
    return new Conflict(message, request, body);
  case 410:
    return new Gone(message, request, body);
  case 415:
    return new UnsupportedMediaType(message, request, body);
  case 429:
    return new TooManyRequests(message, request, body);
  case 422:
    return new UnprocessableEntity(message, request, body);
  default:
    return new FeignClientException(status, message, request, body);
}

// feign.FeignException#serverErrorStatus

switch (status) {
  case 500:
    return new InternalServerError(message, request, body);
  case 501:
    return new NotImplemented(message, request, body);
  case 502:
    return new BadGateway(message, request, body);
  case 503:
    return new ServiceUnavailable(message, request, body);
  case 504:
    return new GatewayTimeout(message, request, body);
  default:
    return new FeignServerException(status, message, request, body);
}

상태 코드가 400번대일 때는 FeignClientException이고, 500번대일 때는 FeignServerException이다.

따라서 해당 요청의 예외도 일반적인 예외와 똑같이 처리해주면 된다. 나는 try~catch 문으로 처리하였다.

보통은 ErrorDecoder를 많이 사용하는 것 같았다. 이 부분은 조금 더 알아봐야 할 것 같다!