[Spring] Feign Client란?

프로젝트를 진행하다 Spring 서버에서 외부 API와 통신하는 서버 to 서버 통신을 하게되는 경우가 발생합니다.

이러한 경우에 사용할 수 있는 Feign Client에 대해 알아보겠습니다.

 

Feign Client 란?

Feign Client를 한마디로 정리하자면 Netflix에서 개발된 Http Client Binder입니다. Spring Boot 환경에서 다른 서버의 Api를 호출하기 위해 사용하게 됩니다.

 

아래와 같이 단순하기 때문에 비즈니스 로직에 더 집중할 수 있게 도와줍니다.

장점

• HTTP API를 균일하게 바인딩하여 복잡성을 줄임
• RestTemplate방식과 WebClient방식보다 단순
• 웹 서비스 클라이언트를 쉽게 작성할 수 있음
  • Interface를 작성하고 Annotaion을 선언하면 끝
  • Jpa가 실제 쿼리를 작성하지 않고 Interface만 지정하여 쿼리 실행 구현체를 자동으로 만드는것과 유사함

이러한 장점들로 인해 비즈니스 로직에 더 집중할 수 있게 도와줍니다.

 

OkHttp

• Feign에서 제공하는 Http Client 중 1개
  • 비동기 / Non-Blocking 사용하기 위해 설정
  • 기본 설정은 HttpUrlConnection
• Rest Api, Http 통신을 간편하게 구현할 수 있도록 다양한 기능을 제공해주는 라이브러리
• HTTP 요청과 응답을 생성하고 처리하는 기본 기능을 제공
  • 헤더, 바디 등의 세부 사항을 수동으로 제어할 수 있음
  • 요청 및 응답에 대한 세밀한 제어가 가능
• Java와 같은 JVM 기반 시스템에서 동작

---

Feign Client 예시 코드

실제 Feign Client를 활용해 외부 API를 호출하는 로직을 작성해보겠습니다. 테스트를 위해선 Json 무료 가상 Rest API 서버인 JSONPlaceholder를 사용하겠습니다. 

 

• GET https://jsonplaceholder.typicode.com/users/1

 

https://jsonplaceholder.typicode.com/

JSONPlaceholder - Free Fake REST API

 

우선 build.gradle파일을 통해 Dependency를 설정해야합니다.

의존성

ext {
	set('springCloudVersion', "2021.0.5")
}

dependencies {
	implementation 'org.springframework.cloud:spring-cloud-starter-openfeign'
    	implementation 'io.github.openfeign:feign-okhttp'
}

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

 

예시 코드

Client Interface와 FallbackFacory Class를 생성합니다.

 

FallbackFacory란?

• Feign에서 제공하는 기능 중 하나로, 서비스 간 통신 중에 에러가 발생할 때 대체 동작을 정의하기 위해 사용
• 예외가 발생하면 해당 인터페이스의 백엔드 구현 대신 FallbackFactory에 정의된 메소드 호출

package com.example.demofeign.api.test.feign;

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

import java.util.Map;

@FeignClient(name = "testApi", url = "https://jsonplaceholder.typicode.com", fallbackFactory = ApiClientFallbackFactory.class)
public interface ApiClient {

    @GetMapping(value = "/users/{userNo}", consumes = MediaType.APPLICATION_JSON_VALUE, produces = MediaType.APPLICATION_JSON_VALUE)
    Map getTestData(@PathVariable String userNo);
}

package com.example.demofeign.api.test.feign;

import lombok.extern.slf4j.Slf4j;
import org.springframework.cloud.openfeign.FallbackFactory;
import org.springframework.stereotype.Component;

import java.util.Map;

@Slf4j
@Component
public class ApiClientFallbackFactory implements FallbackFactory<ApiClient> {
    @Override
    public ApiClient create(Throwable cause) {
        return new ApiClient() {
            @Override
            public Map getTestData(String userNo) {
                log.error("testData Fallback reason was: " + cause.getMessage(), cause);
                return null;
            }
        };
    }
}

 

다음으로 ApiClient를 호출하는 TestService를 생성합니다.

package com.example.demofeign.api.test.service;

import com.example.demofeign.api.test.feign.ApiClient;
import com.example.demofeign.api.test.model.response.ApiResponse;
import com.fasterxml.jackson.databind.ObjectMapper;
import lombok.RequiredArgsConstructor;
import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Service;

import java.util.Map;

@Slf4j
@Service
@RequiredArgsConstructor
public class TestService {

    private final ApiClient apiClient;
    private final ObjectMapper objectMapper;

    public ApiResponse getTestData(String userNo) {
        Map testData = apiClient.getTestData(userNo);
        ApiResponse apiResponse = objectMapper.convertValue(testData, ApiResponse.class);
        log.info("TestData: {}", apiResponse);
        return apiResponse;
    }
}

 

마지막으로 TestService를 호출 테스트해볼 TestController를 생성합니다.

package com.example.demofeign.api.test.controller;

import com.example.demofeign.api.test.model.response.ApiResponse;
import com.example.demofeign.api.test.service.TestService;
import lombok.RequiredArgsConstructor;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RequiredArgsConstructor
@RestController
@RequestMapping("/api")
public class TestController {
    private final TestService testService;

    @GetMapping("/test/{userNo}")
    public ResponseEntity<ApiResponse> test(@PathVariable String userNo) {
        return ResponseEntity.ok(testService.getTestData(userNo));
    }
}

 

 

Postman으로 호출결과를 확인하면, 위에 링크와 같이 데이터를 가져온것을 확인할 수 있습니다.

 

해당 예제 소스 링크입니다.

https://github.com/Jisue/Spring-Boot---Feign-Client

GitHub - Jisue/Spring-Boot---Feign-Client: Feign Client를 정리해보자

---

[참고]

https://techblog.woowahan.com/2630/

우아한 feign 적용기 | 우아한형제들 기술블로그

https://kdhyo98.tistory.com/33#google_vignette

[SPRING] feign은 뭘까?