SpringBoot에서 FeignClient 간단하게 적용하기

 

외부 API에 연결하는 기능을 WebClient -> RestClient 로 변경하는 것에 이어서 FeignClient 로 변경하게 되었다

이번 리팩토링에는 별 이유는 없다. 직접 적용해보면 각 기술의 특징을 더 잘 체감할 수 있지 않을까해서..

 

FeingClient 적용 방법

1. OpenFeign 의존성 추가

< build.gradle >

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

    implementation 'org.springframework.cloud:spring-cloud-starter-openfeign'

FeingClient를 사용하려면 Spring Cloud 의존성도 함게 추가해야 한다.

Spring Boot 버전에 맞는 Spring Cloud 버전을 확인하고 추가해준다. 버전 확인

현재 프로젝트의 boot 버전은 '3.4.2' 이므로 cloud는 '2024.0.0'으로 추가했다.

 

❓ dependencyManagement와 dependencies 의 차이

• dependencyManagement는 실제로 의존성을 프로젝트에 추가하는 것이 아닌 의존성 버전을 관리하는 플랫폼이나 BOM(Bill of Materials)을 import 한다.
• dependnecies는 프로젝트에 실제로 의존성을 추가한다. 버전을 명시하지 않으면 dependencyManagement에서 정의된 버전이 사용된다.
• 즉, 위에서 dependencyManagement에 넣은 Spring cloud가 dependencies의 openfeign 버전을 관리한다.
• Spring Cloud 24.0.0 에는 다양한 라이브러리들이 있는데 이 라이브러리들의 최적의 호환 버전을 한 번에 관리할 수 있는 것이다. 각각의 라이브러리마다 버전을 관리하지 않아도 된다.

 

2. OpenFeign 설정

2-1. OpenFeign을 사용하려면 메인 클래스에 @EnableFeignClients 어노테이션을 달아주어야 한다.

현재 우리 프로젝트는 설정 파일을 분리해둔 구조이기 때문에 global 도메인에 설정 파일을 분리했다.

그리고 메인 클래스에 @EnableFeignClients 를 적용하면 @WebMvctest나 @DataJpaTest로 진행하는 테스트때도 동일하게 적용되기 때문에 테스트가 더 무거워질 수도 있다.

@Configuration
@EnableFeignClients("com.ioteam.order_management_platform")
public class OpenFeignConfig {
}

@EnableFeignClients 에는 인터페이스를 생성할 위치를 적어주면 된다.  나는 프로젝트의 확장성을 고려해서 도메인 직전의 패키지로 설정했다.

이렇게하면 Springdl 해당 패키지와 그 하위 패키지에서 @FeignClient 어노테이션이 붙은 인터페이스를 찾아 구현체를 생성한다.

만약 경로를 설정하지 않으면 @EnableFeignClients 가 선언된 클래스의 패키지만 스캔 대상이 된다.

 

2-2. FeignClient 인터페이스 구현

@FeignClient(name = "GeminiAiService", url = "${gemini.api.url}")
public interface GeminiAiService {

	@PostMapping("/")
	GeminiResponseDto requestGemini(@RequestParam("key") String apiKey, @RequestBody
	GeminiRequestDto requestBody);
}

어노테이션으로  @FeignClient 를 붙여주고, name과 url을 작성했다.

• name 속성 : 필수 속성으로 FeignClient의 고유 식별자 역할을 한다.
  • 서비스 디스커버리를 사용할 경우 호출할 서비스 이름으로 사용된다.
• url 속성 : FeignClient가 HTTP 요청을 보낼 url을 지정한다.
  • url 속성이 지정되면, 서비스 디스커버리를 사용하지 않고 이 url로 직접 요청을 보낸다.

 

자세한 내용은 Spring Cloud 공식 문서를 참고하면 된다.

 

요청을 보내는 메서드는 Spring에서 사용하던 것과 같다.

restClient를 사용했을 땐 json 형태를 만들기 위해 Map으로 보낼 데이터를 생성했는데 feignClient는 DTO 형태로 보낼 수 있을 것 같다고 팀원분이 알려주셔서 DTO로 보냈다. 잘 된다. 굳

retry나 fallback 옵션도 추가할 수 있는데 추후에 추가해봐야겠다.

 

 

참고

https://docs.spring.io/spring-cloud-openfeign/docs/current/reference/html/#netflix-feign-starter

Spring Cloud OpenFeign

https://khdscor.tistory.com/128

OpenFeign을 통한 외부 API (With Spring Boot)