[SpringBoot] Spring Cloud OpenFeign 생성하기

🌟 INDEX

• Spring Cloud OpenFeign 사용하기
• OpenFeign 주요 특징
• Spring Boot 버전 별 Spring Cloud OpenFeign 호환성
• OpenFeign 적용하기
• 개발 환경

---

Spring Cloud OpenFeign 

OpenFeign은 Java 기반의 HTTP 클라이언트를 작성하기 위한 선언적 웹 서비스 클라이언트입니다. Spring Cloud의 일부로 제공되며, RESTful API 와의 통신을 간소화하는 데 도움을 줍니다.

 

OpenFeign은 인터페이스 기반의 프로그래밍을 지원하여, API 호출을 쉽게 구현할 수 있도록 합니다.

---

OpenFeign 주요 특징

1. 선언적 API 호출:
   • OpenFeign을 사용하면 인터페이스와 애너테이션을 통해 HTTP 요청을 선언적으로 정의할 수 있습니다. 이를 통해 코드가 간결해지고 가독성이 높아집니다.
2. 자동화된 HTTP 요청:
   • OpenFeign은 HTTP 메서드(GET, POST, PUT, DELETE 등)를 인터페이스 메서드에 매핑하여, 복잡한 HTTP 요청을 자동으로 처리합니다.
3. 통합과 확장성:
   • Spring Cloud와 통합되어, Eureka와 같은 서비스 등록 및 발견 기능과 함께 사용할 수 있습니다.
   • 필터, 오류 처리기, 인코더 및 디코더 등을 통해 기능을 확장할 수 있습니다.
4. 유연한 구성:
   • 다양한 구성 옵션을 제공하여, 타임아웃, 리트라이 정책, 로깅 등을 설정할 수 있습니다.
5. REST API 문서화:
   • OpenFeign은 Swagger와 같은 도구와 통합하여 API 문서를 자동으로 생성할 수 있습니다.

---

Spring Boot 버전 별 Spring Cloud OpenFeign 호환성

버전별 호환성은 아래와 같습니다.

1. Spring Boot 2.1.x
   • Spring Cloud 2.1.x (OpenFeign 2.1.x)
   • Spring Cloud 2.2.x (OpenFeign 2.2.x)
2. Spring Boot 2.2.x
   • Spring Cloud 2.2.x (OpenFeign 2.2.x)
   • Spring Cloud 2.3.x (OpenFeign 2.3.x)
3. Spring Boot 2.3.x
   • Spring Cloud 2.3.x (OpenFeign 2.3.x)
   • Spring Cloud 2.4.x (OpenFeign 2.4.x)
4. Spring Boot 2.4.x
   • Spring Cloud 2020.0.x (OpenFeign 3.0.x)
   • Spring Cloud 2021.x (OpenFeign 3.1.x)
5. Spring Boot 2.5.x
   • Spring Cloud 2020.0.x (OpenFeign 3.0.x)
   • Spring Cloud 2021.x (OpenFeign 3.1.x)
6. Spring Boot 2.6.x
   • Spring Cloud 2021.x (OpenFeign 3.1.x)
7. Spring Boot 3.x
   
   • Spring Cloud 2022.x (OpenFeign 4.x)

https://spring.io/projects/spring-cloud#overview

Spring Cloud

Spring Cloud 홈페이지에서 각 릴리즈 별 호환성 정보를 확인할 수 있습니다. 

 

https://mvnrepository.com/artifact/org.springframework.cloud/spring-cloud-starter-openfeign

메이븐 레포지토리 홈페이지에서 버전에 맞는 의존성을 추가할 수 있습니다.

---

OpenFeign 적용하기

의존성 추가

// https://mvnrepository.com/artifact/org.springframework.cloud/spring-cloud-starter-openfeign
implementation group: 'org.springframework.cloud', name: 'spring-cloud-starter-openfeign', version: '4.0.0'

 

저는 Gradle 을 사용하고 있어, build.gradle 파일에 의존성을 추가해 주었습니다.

Spring Boot 3.2.2 버전을 사용하고 있어 OpenFeign 4.0 버전의 의존성을 추가해 주었습니다.

---

OpenFeign 활성화 (@EnableFeignClients 어노테이션 추가)

 

import org.springframework.cloud.openfeign.EnableFeignClients;

@EnableFeignClients
@SpringBootApplication
public class LiyoApplication {

	public static void main(String[] args) {
		SpringApplication.run(LiyoApplication.class, args);
	}

}

main 클래스에 @EnableFeignClients 어노테이션을 추가해 줍니다.

의존성 추가 후 JAVA Clean 혹은 재빌드 하지 않으면 import 가 제대로 되지 않을 수 있습니다.

빨간 줄이 뜨고 어노테이션 추가 및 import 오류가 발생한다면 자바 클린 진행해 주세요.

---

환경 설정 ( url 세팅 )

application.property 혹은 application.yml 파일에 환경 설정 정보를 세팅합니다.

spring:
  cloud:
    openfeign:
      client:
        config:
          liyoServiceClient:    # 클라이언트 이름
            url: http://liyo-service-url.com
          anotherLiyoServiceClient:
            url: http://anotherLiyo-service-url.com

 

기본적인 url 부터 필요에 따라 Timeout, loggerLevel  등 다양한 설정을 추가할 수 있습니다.

---

FeignClient 구현하기

인터페이스에 @FeignClient 어노테이션을 붙여 API 를 연결하기 위한 인터페이스를 생성해 줍니다.

 

저는 liyoService 와 anotherLiyoService 총 2개의 API 를 세팅해주었으므로, 2 개의 FeignCilent 파일을 생성해 줄 겁니다.

 

client 폴더를 생성하여, FeignClient 파일을 생성해 주었습니다.

이미지에는 Service 라고 되어있지만, 실제 Service 클래스를 생성할 때 이름이 겹쳐 실제 코드에는 Client 를 붙여주었습니다.

 

package com.liyo.exemple.client;

import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;

import com.liyo.exemple.dto.fireSafety.LiyoServiceResponse;

@FeignClient(name = "liyoServiceClient", url = "${spring.cloud.openfeign.client.config.liyoServiceClient.url}")
public interface LiyoServiceClient {

    @GetMapping("/some-endpoint/{id}") // 실제 엔드포인트에 맞게 수정
    LiyoServiceResponse getLiyoServiceData(@PathVariable("id") String id);
}

 

동일한 양식으로 클라이언트 개수만큼 생성해 주면 됩니다.

 

 

---

응답 DTO 클래스 생성하기

package com.liyo.example.dto.fireSafety;

public class LiyoServiceResponse {

}

 

각 API의 응답을 받을 DTO 클래스를 생성해 줍니다.

---

FeignConfig 생성하기

Feign 클라이언트의 설정을 지정할 수 있는 Config 클래스를 생성합니다. 

 

해당 Config 가 적용되는 FeginClient 에 공통으로 로깅이나 타임아웃 설정 등을 추가할 수 있습니다.

 

package com.liyo.example.config;

import feign.Logger;
import feign.RequestInterceptor;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class FeginConfig {

    @Bean
    Logger.Level feignLoggerLevel() {
        return Logger.Level.FULL; // 모든 요청과 응답을 로깅
    }

    @Bean
    public RequestInterceptor requestInterceptor() {
        return requestTemplate -> {
            requestTemplate.header("Content-Type", "application/json");
            requestTemplate.header("Accept", "application/json");
        };
    }

}

 

RequestInterceptor

- 공통으로 사용하는 header를 설정합니다.

 

Log설정

 - NONE : 로깅하지 않습니다.(DEFAULT) 

 - BASIC : Request Method와 URL, Reponse 상태 코드 및 실행 시간을 로깅합니다.

 - HEADERS : Request, Response Header + BASIC 정보를 로깅합니다,

 - FULL : Request, Response의 Header, Body, 메타데이터를 로깅합니다.

---

Service 클래스에서 사용하기

FeignClient 를 주입받아 사용할 수 있는 서비스 클래스를 만들어줍니다.

 

package com.liyo.example.service;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

import com.ebab.lsdtgl.client.EabFireSafetyClient;
import com.ebab.lsdtgl.dto.fireSafety.FireSafetyResponse;

@Service
public class LiyoService {

    @Autowired
    private LiyoServiceClient liyoServiceClient;

    public LiyoServiceResponse getLiyoServiceData(String id) {
        return liyoServiceClient.getLiyoServiceData(id);
    }
}

---

개발 환경

• Frontend
  • Framework: Vue 3
  • Build Tool: Vite
• Backend
  • Framework: Spring Boot 3.2.2
  • Language: Java
  • Gateway: Spring Cloud Gateway
• Database
  • DBMS: MS SQL Server
  • Container: Docker
• Development Tools
  • IDE: Visual Studio Code (VSCode)