[Spring Boot] Spring Boot에서 Feign 클라이언트 사용하기(@FeignClient 사용 가이드)

Spring Boot에서 Feign 클라이언트 사용하기

Spring Boot

 

Spring Boot와 Spring Cloud는 마이크로서비스 아키텍처의 구축과 관리를 간소화하고, 서비스 간의 통신을 효율적으로 처리하는 데 필수적인 다양한 도구를 제공한다.

@FeignClient는 이러한 도구 중 하나로, 마이크로서비스 간의 HTTP 기반 통신을 추상화하여 개발자가 원격 서비스를 쉽게 호출할 수 있도록 지원한다. Feign 클라이언트를 사용하면 복잡한 HTTP 클라이언트 코드를 작성할 필요 없이, 인터페이스 기반의 메서드 호출로 원격 서비스와의 통신을 구현할 수 있다.

이는 마이크로서비스 아키텍처에서 서비스를 분리하고 각각 독립적으로 개발 및 배포하는 방식에 잘 부합한다. @FeignClient 어노테이션을 사용하면, 개발자는 단순히 인터페이스에 어노테이션을 추가하고, Feign이 제공하는 몇 가지 간단한 설정만으로 원격 서비스의 RESTful API를 마치 로컬 서비스를 호출하듯 사용할 수 있다.

Feign은 선언한 인터페이스를 동적 프록시로 구현하여, 메서드 호출 시 내부적으로 HTTP 요청을 구성하고 실행한다. 이러한 프록시 메커니즘은 코드의 가독성을 높이고 유지 보수를 용이하게 한다.

 

1. 의존성 설정

• 프로젝트에 필요한 Feign 클라이언트 의존성을 Gradle을 사용하여 추가한다.
• 버전은 최신을 확인하여 사용한다.

// Feign 클라이언트 의존성 추가
implementation 'org.springframework.cloud:spring-cloud-starter-openfeign'

 

 

2. Feign 클라이언트 활성화

• @EnableFeignClients 어노테이션을 사용하여 애플리케이션에 Feign 클라이언트 기능을 활성화한다.

@SpringBootApplication
@EnableFeignClients // Feign 클라이언트를 활성화하는 어노테이션
public class SampleApplication {
    public static void main(String[] args) {
        SpringApplication.run(SampleApplication.class, args);
    }
}

 

 

3. 외부 서비스 URL 설정 (선택 사항)

• application.yml 파일에 외부 서비스 URL을 설정한다.
• 이는 추후 인터페이스에서 사용된다. (4번 항목)

external:
    api:
        url: http://www.externalapi.com:9000  # 외부 서비스의 IP 주소

 

• "선택 사항"이라고 표현한 이유는 Feign 클라이언트의 URL을 설정하는 방법은 다양하기 때문이다.
• 첫 번째는 위 내용처럼 외부 파일에 URL을 정의를 하고 @Value 또는 @ConfigurationProperties를 사용하여 주입할 수 있고,
• 두 번째 방법으로는 아래와 같이 @FeignClient 어노테이션 내에서 직접 URL을 지정할 수 있다.

@FeignClient(name = "externalClient", url = "http://www.externalapi.com:9000")
public interface ExternalClient {
    // ...
}

 

 

4. Feign 클라이언트 인터페이스 정의

• @FeignClient 어노테이션을 사용하여 원격 서버의 API를 호출하는 클라이언트 인터페이스를 정의한다.

@FeignClient(name = "externalClient", url = "${external.api.url}")
public interface ExternalClient {

    @RequestMapping(method = RequestMethod.POST, value = "/mapping")
    Map<String, Object> search(@RequestBody Map<String, Object> body);

}

 

 

5. Feign 클라이언트 사용 예시

•  Feign 클라이언트 인터페이스를 사용하여 외부 서비스의 API를 호출한다.

Map<String, Object> response = externalClient.search(requestBody);

 

 

 

6. @RestController와 @FeignClient에서 @RequestMapping 차이점

• RestController에서의 @RequestMapping
  • Spring @RestController 클래스에서 @RequestMapping을 사용하면 HTTP 요청을 해당 컨트롤러 내의 특정 핸들러 메서드에 매핑하는 데 사용된다.
  • 정의된 메서드에서 처리해야 하는 HTTP 메서드(GET, POST, PUT, DELETE 등)와 URL 경로를 정의한다.

@RestController
@RequestMapping("/api")
public class MyController {
    
    @RequestMapping(method = RequestMethod.GET, value = "/hello")
    public String hello() {
        return "Hello, world!";
    }
}

 

• FeignClient에서의 @RequestMapping
  • Feign Client 인터페이스에서 @RequestMapping을 사용할 때 Feign Client가 실제 HTTP 요청을 할 때 사용해야 하는 대상 URL 및 HTTP 메서드를 선언하는 데 사용된다.
  • @RestController와 같이 들어오는 HTTP 요청을 처리하지 않는다.

 

💡 따라서 모두 @RequestMapping이라고 부르지만 용도와 목적이 다르다.
RestController의 경우 들어오는 HTTP 요청을 처리하는 반면 Feign 클라이언트 인터페이스에서는 나가는 HTTP 요청의 대상 끝점을 정의한다.

 

 

 

프록시가 뭔지 궁금하다면 아래 링크를 참고하세요!

[JAVA] Java와 Spring, JPA에서의 프록시 객체 이해하기

[JAVA] Java와 Spring, JPA에서의 프록시 객체 이해하기