집념의 feign.httpclient 관련 삽질😥 기록기

feign

• Feign은 오픈소스 웹 서비스 클라이언트입니다. (like RestTemlate..)
  • HTTP 통신을 위해 사용한다고 생각하시면 쉽습니다.
• 다른 라이브러리와 다른 Feign의 장점은 api 호출 설정을 간소화하여 interface 선언만으로 API 호출을 할 수 있습니다(선언적 웹 서비스 클라이언트)
• Feign은 Netflix가 처음 만들었지만, 이후 Netflix가 feign을 사용하지 않기로 결정하게 되면서 현재는 OpenFeign으로 관리되고 있습니다.

 

문제의 시작

• 환경 : spring-cloud-openfeign 2.2.9
• Spring Boot 환경에서 application.yml 파일에 feign 관련 설정을 작성해 feign의 설정값들을 세팅할 수 있습니다. (다른 방법도 있음)
• 현재 재직중인 회사 가이드를 살펴보며 feign 관련 설정을 하던중, 궁금증이 생겨났습니다.
• feign: client: config: default: connectTimeout: 5000 readTimeout: 15000 loggerLevel: FULL httpclient: connection-timeout: 5000 # feign.client.config.default.connectTimeout과 feign.httpclient.connection-timeout의 차이는 무엇일까...
• feign.client.config.default.connectTimeout과 feign.httpclient.connection-timeout의 차이는 무엇일까...
• 구글링을 해보았지만 명확히 다른 점을 설명한 글은 찾아볼 수 없었습니다 ㅠ

 

feign.httpclient

https://docs.spring.io/spring-cloud-openfeign/docs/2.2.9.RELEASE/reference/html/#spring-cloud-feign-overriding-defaults

The OkHttpClient and ApacheHttpClient and ApacheHC5 feign clients can be used by setting 
`feign.okhttp.enabled` 
or `feign.httpclient.enabled`
or `feign.httpclient.hc5.enabled` to `true`, 
respectively, and having them on the classpath.

OkHttpClient 및 ApacheHttpClient 및 ApacheHC5 feign 클라이언트는 각각 feign.okhttp.enabled 또는 feign.httpclient.enabled 또는 feign.httpclient.hc5.enabled를 true로 설정하고 클래스 패스에 있으면 사용할 수 있습니다.

• spring-cloud-openfeign 공식문서를 통해, httpclient → ApacheHttpClient 관련 속성이라고 추측할 수 있었습니다.

https://techblog.woowahan.com/2657/

• 그리고 apache http client를 사용하려면 feign.httpclient.enabled 처리랑 의존성 추가가 필요하다는 것도 같이 확인 할 수 있었습니다.
  • 참고 : feign가 지원하는 http client는 default, apache http client, ok http client 등이 있음.

 

여기서 문제!

feign:
client:
  config:
    default:
      connectTimeout: 5000
      readTimeout: 15000
      loggerLevel: FULL
httpclient:
  connection-timeout: 5000 # feign.client.config.default.connectTimeout과 feign.httpclient.connection-timeout의 차이는 무엇일까...

• 아까 참고했다던, 회사 가이드에는 enabled 설정에 대한 이야기와 의존성 추가에 대한 이야기도 찾아 볼 수 없었는데요! 그래서 저는 다시 혼란에 빠지게 되었습니다...
• 과연.. 어떤 글이 맞는것인가...
• 그래서 직접 소스를 까보기로 했습니다!
  • 이유 : 현재 제가 사용하는 feign 버전이 낮은 버전이라.. 최신 버전과의 설정 차이가 있을 수 있다고 생각해 구글링한 페이지들을 믿지 못하게 되었습니다 ㅠㅠ (feign이 버전업이 되면서 바뀐 부분이 은근 많더라구요 🤣)

 

FeignAutoConfiguration.java

• 수많은 디버깅과 구글링을 통해 feign이 client 객체를 생성하는 코드를 발견했습니다.
• 아래 코드가 바로 그 코드입니다!

    @Configuration(
        proxyBeanMethods = false
    )
    @ConditionalOnClass({ApacheHttpClient.class})
    @ConditionalOnMissingClass({"com.netflix.loadbalancer.ILoadBalancer"})
    @ConditionalOnMissingBean({org.apache.http.impl.client.CloseableHttpClient.class})
    @ConditionalOnProperty(
        value = {"feign.httpclient.enabled"},
        matchIfMissing = true
    )
    @Conditional({HttpClient5DisabledConditions.class})
    protected static class HttpClientFeignConfiguration {

        protected HttpClientFeignConfiguration() {
        }

        // 생략

        @Bean
        @ConditionalOnMissingBean({Client.class})
        public Client feignClient(HttpClient httpClient) {
            return new ApacheHttpClient(httpClient); // ApacheHttpClient로 Client 객체 생성!
         }

    }

• @ConditionalOnClass({ApacheHttpClient.class}): ApacheHttpClient 클래스 파일이 있을때만 설정 파일 작동
• @ConditionalOnProperty( value = {"feign.httpclient.enabled"}, matchIfMissing = true ) : 값이 false가 아닌 경우 제외하고 모든 경우에 @Configuration 설정파일 적용됨 (feign.httpclient.enabled 설정 값 없어도 됨)
• @ConditionalOnMissingBean({Client.class}) : Client 타입의 빈이 없는 경우 빈 생성
• 빠른 결론 : 적용하려면, ApacheHttpClient 의존성 추가만 하면 됨

 

실험

그래도 혹시 몰라서 실험을 진행했습니다 😂

1. 의존성 추가

// pom.xml
<dependency>
   <groupId>io.github.openfeign</groupId>
   <artifactId>feign-httpclient</artifactId>
</dependency>

// application.yml
# 아무설정도 하지 않음 

• 결과 : ApacheHttpClient로 Client 생성 됨

2. 의존성 추가 && feign.httpclient.enabled=false

// pom.xml
<dependency>
   <groupId>io.github.openfeign</groupId>
   <artifactId>feign-httpclient</artifactId>
</dependency>

// application.yml
feign:
  httpclient:
    enabled: false

• 결과 : ApacheHttpClient로 Client 생성 안됨
• 이유
  • https://docs.spring.io/spring-boot/docs/current/api/org/springframework/boot/autoconfigure/condition/ConditionalOnProperty.html#matchIfMissing
  • 공식 문서 내 표를 보면 havingValue 어노테이션을 안달면(havingValue="") false만 아니면 모두 yes 취급 되는걸 알 수 있음

3. 의존성 추가 && feign.httpclient.enabled=아무값이나

<dependency>
   <groupId>io.github.openfeign</groupId>
   <artifactId>feign-httpclient</artifactId>
</dependency>

// application.yml

feign:
  httpclient:
    enabled: true

--

<dependency>
   <groupId>io.github.openfeign</groupId>
   <artifactId>feign-httpclient</artifactId>
</dependency>

// application.yml

feign:
  httpclient:
    enabled: 'hi'

• 결과 : ApacheHttpClient로 Client 생성 됨

4. 의존성 추가 && feign.httpclient.enabled=off

// pom.xml
<dependency>
   <groupId>io.github.openfeign</groupId>
   <artifactId>feign-httpclient</artifactId>
</dependency>

// application.yml
feign:
  httpclient:
    enabled: off

• 결과 : ApacheHttpClient로 Client 생성 안됨
• 이유
  • boolean값 관련해서 off가 false와 같은 값으로 취급됨
    • https://github.com/spring-projects/spring-boot/wiki/Spring-Boot-2.2-Release-Notes
    • YAML configuration can now use on or off for boolean types.
  • https://perlpunk.github.io/yaml-test-schema/schemas.html
  • https://youtrack.jetbrains.com/issue/IDEA-223980/Spring-Boot-on-or-off-can-be-used-as-boolean-values-in-application.yml-since-v.-2.2.0

 

결론

• feign에서 http client로 apache http client를 사용하려면, 의존성 추가만 해주면 됩니다.
  • feign.httpclient.enable=true 처리는 생략해도 됩니다
    • @ConditionalOnProperty( value = {"feign.httpclient.enabled"}, matchIfMissing = true )
    • feign.httpclient.enabled 값을 false으로 명시하지 않는다면 모든 경우에 client 객체가 apache http client로 생성되게 됩니다.
• 개인적인 회고
  • 이처럼 글마다 설명이 다르다면.. 혼란에 빠져 찜찜한 마음과 함께 코드를 다 까보게 되는데요..
  • 글에는 작성하진 않았지만.. 이번 경우에는 openfeign의 코드가 믿기지 않아, 더 혼란한 마음으로 openfeign의 코드를 로컬에 받아 직접 까보기도 했습니다. 
    • @ConditionalOnProperty( value = {"feign.httpclient.enabled"}, matchIfMissing = true )
      • 이 부분에서 havingValue가 true로 적혀져 있지 않는 부분이 왜 이렇게 개발하게 된건지 이해가 안됐습니다.
    • 혹시 제가 찾아보지 못한 영역에서 feign.httpclient.enabled 값을 또 확인해서 사용하는 영역이 있는지 확인하고 싶어 open feign 개발 당시 커밋 내역을 확인해보기도 했습니다. 저처럼 궁금증하신 분들이 있으실까봐 첨부합니다.
      
      • https://github.com/spring-cloud/spring-cloud-openfeign/tree/2.2.x
      • https://github.com/spring-cloud/spring-cloud-openfeign/commit/a6b94a38fe5778970a122cf21c94d7159c1ce1dc
  • 이처럼 계속 찜찜한 부분이 있어, 정말 다양한 방법으로 찾아보았는데요.. 다른 분들은 이런 혼란에 빠지지 않길 바라며 글을 마칩니다!