Feign Client 를 활용하여 외부통신 연동하기

📌 들어가며

백엔드 API 개발을 하다보면 외부 서비스와 연동해야 하는 일이 많이 생깁니다. 특히 현재 주문/결제 도메인팀에 있다보니 더더욱 비즈니스 로직에서 외부통신을 해야하는 경우가 많이 생기는 것 같습니다. 이번 포스팅에서는 외부통신을 도와주는 많은 라이브러리들(HttpClient, WebClient) 중 Feign Client 에 대해 알아보고자 합니다. 

 

---

📌 Feign Client 

Feign Client란 Netflix에서 개발한 Http Client입니다.

(HttpClient는 Http 요청을 간편하게 만들어서 보낼 수 있도록 돕는 객체)

처음에는 Netflix에서 자체적으로 개발을 진행(Spring Cloud Netflix Feign)했지만 현재는 오픈소스 프로젝트인  OpenFeign으로 전환했으며 SpringCloud 프레임워크의 Spring Cloud OpenFeign에 통합되었습니다.

 

이러한 Feign Client의 사용하게 되는 이유를 그 특징과 함께 알아보면

• SpringMvc에서 제공되는 어노테이션을 그대로 사용할 수 있습니다. (Spring Cloud의 starter-openfeign을 사용할 경우)
• RestTemplate 보다 간편하게 사용할 수 있으며(interface 와 annotation만 선언하면 구현체가 생김) 가독성이 좋습니다.
• 동기적으로 작동하기 때문에 외부 서비스의 응답이 비즈니스 로직에 포함되어 반드시 응답을 받아야 API를 성공 처리 할 수 있는 경우 사용하기에 적합합니다.

---

📌 Feign Client  시작하기

우선 Spring Cloud 관련 패키지들의 버전에 맞는 의존성 자동 설정을 위해 spring-cloud-dependencies 를 등록하고 openfeign dependency도 추가해줍니다.

ext {
	// [2021-07-16] Dependency management for Spring Cloud AWS.
	springCloudVersion = '2021.0.5'
	// spring cloud version (Spring Boot 2.7.x compatibility)
	springCloudAwsVersion = '2.4.2'
}

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


dependencies {
    //########## OpenFeign ##########//
    implementation 'org.springframework.cloud:spring-cloud-starter-openfeign'
    implementation group: 'com.squareup.okhttp3', name: 'okhttp', version: '4.10.0'
    testImplementation 'org.springframework.cloud:spring-cloud-contract-wiremock'
}

 

스프링 부트 버전에 맞는 spring-cloud 버전을 사용해야 하므로 자신의 스프링부트 버전에 맞는 depnedency 설정을 해줍니다.

https://spring.io/projects/spring-cloud

Spring | Home

각자의 프로젝트에 정확하게 맞는 버전 정보를 얻고자 한다면 위의 링크를 참고 부탁드립니다.

build.gradle을 수정하여 라이브러리를 다운 받았다면 OpenFeign 관련 컴포넌트 스캔을 위해

Application에 @EnableFeignClients 를 붙여줍니다.

 

@EnableFeignClients()
@ServletComponentScan
@SpringBootApplication
public class SearchApplication {

	public static void main(String[] args) {
		SpringApplication.run(SearchApplication.class, args);
	}

}

 

그 다음 FeignClient 를 통해 요청할 외부통신 스펙에 맞게 interface를 생성하면 됩니다.

@FeignClient(name = "SearchNaverFeignClient", url = ENDPOINT_NAVER_URL)
public interface SearchNaverFeignClient {

  /**
   *
   * @param naverClientId
   * @param naverClientSecret
   * @param query
   * @param display
   * @param start
   * @param sort
   * @return
   */
  @GetMapping("/v1/search/blog.json")
  NaverResultDto getSearchResult(
      @RequestHeader(NAVER_CLIENT_ID) String naverClientId,
      @RequestHeader(NAVER_CLIENT_SECRET) String naverClientSecret,
      @RequestParam("query") String query,
      @RequestParam("display") Integer display,
      @RequestParam("start") Integer start,
      @RequestParam("sort") String sort);

}

 

EndPoint url을 application.yaml 파일에서 가져와 적용하는 것도 가능합니다.

external:
user-service:
  host: 'https://user.me'

@FeignClient(name = "userClient", url = "${external.user-service.host}")

 

또한 feignClient의 장점 중 하나로 Client에 커스텀 Configuration을 적용할 수 있습니다.

예를들어 해당 외부 서비스에 API 를 호출할 때 무조건 공통으로 들어가야하는 header가 있거나

공통 Response가 있어서 필요한 필드만 decode해오거나 등의 행위들을 할 수 있습니다.

 

ex) 해당 client에서 api 호출 할 때마다 header에 값 넣기

  public class HumanFeignClientConfig {
      @Bean
      public RequestInterceptor requestInterceptor() throws InterruptedException {
          return requestTemplate -> requestTemplate.header("header-name", "header-value");
      }
  }

이를 feignClient interface에 적용하기

  @FeignClient(name = "humanClient", url = "${external.human-service.host}", configuration = HumanFeignClientConfig.class)
  public interface HumanClient {

      @GetMapping(value = "/human/list")
      List<HumanInfo> getHumans(@RequestParam("name") String name);
  }

 

이외에도 다양한 설정법이 있습니다. (Decoder, Encoder, Logger 등)

📌 Feign Client  readTimeout connectionTimeout

readTimeout 과 connectionTimeout은 외부 통신 연동 시

가장 신경써야 하는 필수적인 설정 부분이라고 할 수 있습니다.

 

FeignClient에서는 이를 간단하게 설정할 수 있습니다.

default로 모든 FeingClient interface에 공통적으로 적용하거나

아래와 같이 특정 feignClient interface 마다 값을 다르게 적용할 수 있습니다.

feign:
  httpclient:
    enabled: true
    maxConnections: 1000
    maxConnectionsPerRoute: 1000
  client:
    config:
      default:
        retry-period: 500
        retry-max-period: 1000
        max-attempts: 3
        connectTimeout: 3000
        readTimeout: 30000
      inicis:
        retry-period: 500
        retry-max-period: 1000
        max-attempts: 1 #(실제 시도 + 재시도 횟수이므로 재시도 없음)
      naver:
        retry-period: 500
        retry-max-period: 1000
        max-attempts: 2

 

CustomRetryer 생성 하여 readTimeout 발생 시에는 retry 하지 않고

connectionTimeout 발생 시에만 retry 하도록 하겠습니다.

public interface CustomRetry extends Retryer {

    @Slf4j
    class CustomRetryer implements CustomRetry {
        private final int readTimeoutRetries;
        private final int connectTimeoutRetries;

        private int attempt;

        public CustomRetryer(int readTimeoutRetries, int connectTimeoutRetries) {
            this.readTimeoutRetries = readTimeoutRetries;
            this.connectTimeoutRetries = connectTimeoutRetries;
        }

        @Override
        public void continueOrPropagate(RetryableException e) {
            if (e.getCause() instanceof IOException && e.getMessage().toLowerCase(Locale.ROOT).contains("read")) {
                log.error("Read timed out occurred. count: {}", attempt);
                throw new ApiException(ResponseCode.READ_TIMEOUT);
            } else if (e.getCause() instanceof IOException && e.getMessage().toLowerCase(Locale.ROOT).contains("connect")) {
                log.error("Connect timed out occurred. init: {}", attempt);
                if (attempt++ < connectTimeoutRetries) {
                    log.error("Connect timed out occurred. Retry count: {}", attempt);
                    return;
                }
            }
            throw e;
        }

        public Retryer clone() {
            return new CustomRetryer(readTimeoutRetries, connectTimeoutRetries);
        }
    }
}

 

 

@Slf4j
@Configuration
public class FeignConfig {

    @Value("${feign.client.config.max-attempts}")
    private int maxAttempts;

    /**
     * Debug log level
     */
    @Bean
    Logger.Level feignLoggerLevel(){
        return Logger.Level.FULL;
    }

    @Bean
    public RequestInterceptor requestInterceptor(){
        return requestTemplate -> {
            requestTemplate.header(HttpHeaders.CONTENT_TYPE, MediaType.APPLICATION_JSON_VALUE);
            requestTemplate.header(HttpHeaders.ACCEPT, MediaType.APPLICATION_JSON_VALUE);
        };
    }

   
    /**
     * retry 설정
     */
    @Bean
    public Retryer retryer(){
        return new CustomRetry.CustomRetryer(MAX_READ_TIMEOUT_TRY_COUNT, maxAttempts);
    }

}

 

이 외에도 FeingClient 사용을 위한 다양한 설정 방법들에 대해서는 기회가 되는대로 정리하여 포스팅하도록 하겠습니다.

 

 

참고:

https://isntyet.github.io/java/feign-client-%EC%82%AC%EC%9A%A9%ED%95%B4%EB%B3%B4%EA%B8%B0/

https://mangkyu.tistory.com/279

https://forkyy.tistory.com/10