LocalDate 포맷 오류로 시작된 OpenFeign 의 Auto Configuration 탐색

개요

OpenFeign을 사용해 admin 서버와 core 서버 간에 HTTP 통신을 하던 중, 문제가 발생했습니다.

• admin 서버에서 LocalDate 타입을 yyyy-MM-dd 포맷으로 요청을 보냈습니다.
• 그러나 core 서버에서는 LocalDate 포맷이 yyyy-MM-dd 를 기대했지만, yy. M. d. 으로 와서 포맷 변환에 실패하는 에러 로그가 발생했습니다.

이 문제는 우아한형제들 기술 블로그에서 제시한 방식으로 간단히 해결할 수 있습니다:

@Bean
public FeignFormatterRegistrar localDateFeignFormatterRegister() {
    return registry -> {
        DateTimeFormatterRegistrar registrar = new DateTimeFormatterRegistrar();
        registrar.setUseIsoFormat(true);
        registrar.registerFormatters(registry);
    };
}

 

하지만 저는 왜 이런 코드가 필요한지, 즉 어떤 과정을 통해 포맷이 깨졌는지 그 내부 구조를 파악해보고 싶었습니다.

그 과정을 아래에 소개합니다.

 

1. 디버거로 원인 찾기

먼저 @FeignClient로 요청을 보내는 쪽에 브레이크포인트를 걸고, LocalDate가 언제 yyyy-MM-dd → yy. M. d. 형식으로 바뀌는지를 추적했습니다.

디버깅을 통해 SpringMvcContract 클래스 내부에서 포맷이 변형되는 과정을 확인할 수 있었습니다.

SpringMvcContract  의 getExpander

 

더 깊이 들어가 보니, 최종적으로는 DateTimeFormatterBuilder$CompositePrinterParser 클래스에서 yyyy-MM-dd 형식이 yy. M. d.로 변경되는 것을 확인할 수 있었습니다.

SpringMvcContract 콜스택

@FeignClients 어노테이션의 기본 동작이 왜 이렇게 되었는지 확인하고자 합니다.

 

2. @EnableFeignClients  

먼저, 어떤 @FeignClients 가 동작할 수 있게 하는 @EnableFeignClients 를 확인합니다.

여기서 FeignClientsRegistrar 클래스가 동작하여, @EnableFeignClients에 명시된 value, basePackages, defaultConfiguration, clients 값을 읽고 이를 기반으로 필요한 Bean들을 등록합니다.

 

이 과정에서 @EnableFeignClients 의 defaultConfiguration 는 defaults 로 FeignClientsConfiguration 을 사용한다고 합니다.

@EnableFeignClients 의 defaultConfiguration()

 

3. FeignClientsConfiguration

FeignClientsConfiguration을 살펴보면, 앞서 디버깅 중 보았던 SpringMvcContract 클래스가 Bean으로 등록되는 것을 확인할 수 있습니다.

* SpringMvcContract는 @FeignClient에서 사용하는 @RequestMapping, @GetMapping, @RequestParam 등의 어노테이션을 Spring MVC 방식으로 해석하도록 도와주는 클래스입니다.

 

SpringMvcContract 는 feignContract라는 이름으로 등록되며, @ConditionalOnMissingBean을 통해 Contract 타입의 Bean이 미리 등록되어 있지 않은 경우 기본 구현체로 SpringMvcContract가 사용됩니다.

 

4. 포맷터 등록 구조 이해하기

SpringMvcContract Bean이 생성될 때는 feignConversionService라는 Bean이 함께 주입되는데,
이 feignConversionService는 내부적으로 feignFormatterRegistrars 리스트를 반복문으로 순회하며 포맷터를 등록합니다.

 

이때 사용되는 feignFormatterRegistrars는 FeignClientsConfiguration의 멤버 변수이며, 초기에는 아무 포맷터도 등록되지 않은 빈 ArrayList로 초기화되어 있습니다.

 

그리고, 아래 사진의 빨간 줄에서 FormattingConversionService 는 FormatterRegistry 라는 인터페이스를 구현하고 있기에

빨간줄은 간단하게 이렇게 표시할 수 있습니다. 

registrar.registerFormatters(registry);

 

여기서 registrar는 포맷터를 보유한 객체이고, registry는 이 포맷터들을 저장하고 관리하는 역할을 합니다.

 

쉽게 비유하자면

registrar : LocalDate를 yyyy-MM-dd 로 포맷하고 싶어!
registry : 좋아! 그 포맷 내가 기억해서 필요할 때 사용할께!

 

이처럼 registrar와 registry의 관계는 N : 1 로, 여러 개의 registrar가 존재할 수 있고, 이들은 하나의 registry에 차례로 포맷터를 등록하게 됩니다.
즉, feignFormatterRegistrars(registrar)라는 리스트에 들어 있는 여러 포맷터가 하나의 FormattingConversionService (registry)에 모두 등록되는 구조입니다.

 

이제 이 구조를 이해했더니, 할 일이 명확해졌습니다. FeignFormatterRegistrar를 정의해서 원하는 타입(LocalDate)의 포맷을 생성하고, registry 에 등록해주는 것이었고, 그렇게 해서 등장하는 코드가 바로 처음에 봤던 코드 였습니다.

@Bean
public FeignFormatterRegistrar localDateFeignFormatterRegister() {
    return registry -> {
        DateTimeFormatterRegistrar registrar = new DateTimeFormatterRegistrar();
        registrar.setUseIsoFormat(true);
        registrar.registerFormatters(registry);
    };
}

람다식에서 registry는 FormatterRegistry 인터페이스이고, 구현체로 FormattingConversionService 입니다.

 

지금까지 개요에 해당하는 설명이었고, 추가로 OpenFeign 내부 코드를 보며 알게 된 것들을 공유합니다.

 

번외 1. OpenFeign의 기본 Client 인 Default 객체

OpenFeign에서 특별한 설정 없이 사용하는 기본 HTTP Client는 Client.Default 이며, 내부적으fh HttpURLConnection을 사용합니다.

HttpURLConnection은 java.net 패키지에서 기본으로 제공하는 표준 클래스이며 HTTP 커넥션 관련 기능들을 제공합니다. 그리고, HttpURLConnection 는 구현 과정에서 sun.net.www.http.HttpClient를 사용합니다.

 

즉, Client 인터페이스의 구현체인 Default 객체는 HttpURLConnection을 사용하여 HTTP 통신을 수행하고 있습니다.

 

번외 2. 다른 Http Client 를 사용할 순 없을까? FeignAutoConfiguration 를 확인하기

OpenFeign 공식 문서에서는 OkHttpClient or Http2Client or Apache HttpClient5 사용하려면 의존성과 yml 파일에 설정값을 true 해주면 Feign의 기본 클라이언트를 바꿀 수 있다는 이야기입니다.

To use OkHttpClient-backed Feign clients and Http2Client Feign clients, make sure that the client you want to use is on the classpath and set spring.cloud.openfeign.okhttp.enabled or spring.cloud.openfeign.http2client.enabled to true respectively.

 

예를 들어, OkHttpClient를 사용하고 싶다면 다음과 같이 설정하면 됩니다.

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

# yml
spring.cloud.openfeign.okhttp.enabled=true

 

이렇게 설정하면, org.springframework.cloud.openfeign 패키지에 위치한 FeignAutoConfiguration 클래스가 위에서 설정한 spring.cloud.openfeign.okhttp.enabled 값을 읽어와 OkHttpClient를 Feign의 기본 클라이언트로 구성해 줍니다.

FeignAutoConfiguration 가 yml 설정값을 읽어 OkHttpClient 로 클라이언트를 변경

 

그리고, FeignAutoConfiguration은 OkHttpClient뿐만 아니라 HttpClient 5와 같은 다른 Client 구현체도 지원한다는 것입니다. 특히 HttpClient 5의 경우에는 yml에 명시적인 enabled 설정을 true로 하지 않아도 matchIfMissing = true 설정을 통해 의존성만 존재하면 해당 클라이언트를 활성화합니다.(Spring Cloud 2023.0.3 버전 기준입니다) 

 

마치며

이번에 내부 코드를 하나하나 따라가며 느낀 점이 있습니다. 예전엔 @Enable~, @ConditionalOn~, @ConditionalOnMissingBean, 혹은 AutoConfiguration 에서 라이브러릴 찾지 못하는지 잘 이해하지 못했습니다.

그런데 토비의 스프링부트 강의를 들으며, 이러한 어노테이션이 무엇을 위해 존재하는지, 네이밍은 왜 그렇게 되었는지, META-INF 의 .imports 파일을 읽어 후보군들을 ImportSelector 로 필터링하는 등을 이해하였고, 이 덕분에 Feign의 코드를 따라갈 수 있지 않았나 생각합니다.

 

내부 코드를 읽는 것은 불가피하다고 생각하기에 앞으로도 이런 과정을 통해 이해의 깊이를 더해주고, 문제 해결 능력을 향상 시키고 싶습니다. 마지막으로 토스 페이먼츠에서 Feign의 Default를 HttpClient 5로 변경하는 사례를 담은 글인 'Feign 코드 분석과 서버 성능 개선' 을 추가로 읽으면 좋을 것 같아 링크를 첨부개하며 마무리 하겠습니다.

 

 

참고

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

- https://github.com/OpenFeign/feign

- https://mvnrepository.com/artifact/io.github.openfeign/feign-okhttp

- https://square.github.io/okhttp/