Feign Client에서 커스텀 어노테이션 사용시 주의사항

✔️ 문제상황

Feign Client 인터페이스 메서드에 @RequestHeader("X-User-Id) 대신 사용할 수 있는 커스텀 어노테이션을 생성하여,

@CurrentUserId 를 통해 파라미터로 사용할 경우 아래와 같은 에러가 발생하여 빌드가 실패했다. 

Method has too many Body parameters

 

아래 코드와 같이 커스텀 어노테이션을 사용해서 헤더를 전달하게 되면, 커스텀 어노테이션이 무시되면서 userId까지 @RequestBody로 인식이 되어 문제가 생긴 것이다. (Body 파라미터가 2개 이상이 됨)

@FeignClient(name = "order-service")
public interface OrderFeignClient {

    @PostMapping
    OrderCreateResponse createOrder(
    	@CurrentUserId Long userId,
        @RequestBody OrderCreateRequest request);
}

 

✔️ 원인 

Feign Client는 Spring ArgumentResolver를 지원하지 않기때문에,

@CurrentUserId 와 같이 커스텀한 리졸버 기반 어노테이션이 작동하지 않는다.

또한 Feign Client로 하나의 RequestBody만 전달 할 수 있기 때문에 에러가 날 수 밖에 없는 상황이 된 것이다.

 

✔️ 해결 방법

Feign Client에서는 @RequestHeader 를 직접 명시하여 사용한다. 

@FeignClient(name = "order-service")
public interface OrderFeignClient {

    @PostMapping
    OrderCreateResponse createOrder(
    	@RequestHeader("X-User-Id") Long userId,
        @RequestBody OrderCreateRequest request);
}

 

또한 커스텀 어노테이션은 Controller Class에서 받아올때만 사용한다. 

 

✨ 결론 

Feign Client는 ArgumentResolver를 모르기때문에, Header OR parameter 는 직접 선언해서 써야한다.