[Spring] OpenFeign을 이용하여 API 통신해보기 (feat. 고양이 사진 검색)

OpenFeign을 이용하여 API 통신해보기 (feat. 고양이 사진 검색)

 

해당 코스의 과제를 수행한 내용입니다.

[Java/Spring]고양이 사진 검색 사이트 API 과제 풀어보기

[Java/Spring]고양이 사진 검색 사이트 API 과제 풀어보기

 

제가 연동할 외부 API는 고양이 사진을 조회하는 The Cat API입니다.

https://thecatapi.com/

The Cat API - Cats as a Service.

 

---

Feign

Feign은 Netflix에 의해 처음 만들어진 declarative(선언적인) web service client이며 웹 서비스 클라이언트를 쉽게 작성할 수 있도록 도와준다.

 

“선언적”이란 annotation의 사용을 의미하며 인터페이스를 작성하고 어노테이션을 선언하기만 하면 외부 API를 쉽게 호출을 할 수 있다는 것이다. 마치 Spring Data JPA에서 실제 쿼리를 작성하지 않고 인터페이스만 지정하면 쿼리 실행 구현체를 만들어주는 것과 유사하다!

 

Spring Cloud가 Open Feign을 스프링 클라우드 생태계로 통합 시키며 Spring MVC 어노테이션을 지원하게 되었다.

 

Spring Cloud OpenFegin

https://cloud.spring.io/spring-cloud-openfeign/reference/html/

Spring Cloud OpenFeign

 

사용해보기

 

의존성 추가(Gradle)

 

Spring Cloud 의존성 추가

plugins {
  id 'java'
  id 'org.springframework.boot' version '3.0.5'
  id 'io.spring.dependency-management' version '1.1.0'
}

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

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

 

OpenFeign 의존성 추가

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

 

 

 

OpenFeign 활성화

 

Main 클래스에 붙여줘도 되지만 별도의 Config 파일을 만들어 줍니다. (참고한 관련 내용입니다. https://mangkyu.tistory.com/243)

@Configuration
@EnableFeignClients("com.search.cat_picture") // 저의 프로젝트 패키지 경로입니다
public class OpenFeignConfig {
}

@EnableFeignClients을 추가하면 지정된 경로 이하의 패키지를 탐색하면서 @FeignClient 어노테이션이 붙은 인터페이스의 구현체를 만들어 줍니다.

 

 

 

구현하기

 

현재 요구 사항에 따라 GET 요청만 필요하기 때문에 아래와 같이 코드를 작성해 보았습니다.

@FeignClient(name = "TheCatImageClient", url = "${THE_CAT_CLIENT_URL}/images")
@Headers("x-api-key: ${THE_CAT_CLIENT_KEY}")
public interface TheCatImageClient {

	@GetMapping(value = "/search")
	List<TheCatSimpleImageResponse> findRandomPictures(@RequestParam("limit") Integer limit);

	@GetMapping(value = "/{imagesId}")
	TheCatImageResponse findCatPictureById(@PathVariable String imagesId);

	@GetMapping(value = "/search")
	List<TheCatSimpleImageResponse> findPicturesByBreed(@RequestParam("breed_ids") String breedId);
}

• 필요한 필드만 받아와 매핑될 수 있게 DTO를 구성합니다.
• The Cat API 요청시 가입할때 제공받은 key를 전달 해줘야하기 때문에 공통 Header를 추가해 줍니다.

 

 

로깅 처리

 

Fegin 로깅은 오직 DEBUG 레벨에서만 동작하며 클라이언트별로 Logger.Level 을 설정할 수 있습니다.

 

• NONE : 로깅하지 않음.(default)
• BASIC : Request Method와 URL 그리고 Reponse 상태 코드와 실행 시간을 로깅
• HEADERS : Request, Response Header 정보와 함께 BASIC 정보를 로깅
• FULL : Request와 Response의 Header, Body 그리고 메타데이터를 로깅

 

로깅은 하는 방법은 application.yml을 이용하거나 Configuratin 설정을 이용해서 설정할 수 있습니다. 저는 Configuratin을 통해 설정하였습니다.

 

 

우선 해당 패키지의 로깅 레벨을 DEBUG level로 설정 (application.yml)

logging:
  level:
    com.search.cat_picture.global.openFeign: DEBUG

 

API 로깅 레벨은 BASIC으로 지정하였습니다.

@Configuration
@EnableFeignClients("com.search.cat_picture")
public class OpenFeignConfig {

	@Bean
	Logger.Level feignLoggerLevel(){
		return Logger.Level.BASIC;
	}
}

 

로그 확인

 

 

 

예외 처리

 

Feign의 기본 에러 처리기인 ErrorDecoder.default 는 항상 FeignException 을 발생시킵니다.

ErrorDecoder를 구현하여 해당 예외들을 사용자 정의할 수 있습니다.

import feign.codec.ErrorDecoder;

public class FeignErrorDecider implements ErrorDecoder {

	@Override
	public Exception decode(String methodKey, Response response) {
		return switch (response.status()) {
			case 400 -> new BadRequestException();
			case 404 -> new ResourceNotFoundException();
			default -> new OpenFeignServerException();
		};
	}
}

새로 던진 예외 모두 제가 만든 Custom Exception입니다. 예외 상황에 대해 개발자가 좀더 수월하게 통제할 수 있도록 사용자 정의 Exception을 구성하였습니다.

 

Configuratin을 통해 구현한 ErrorDecoder 등록.

@Configuration
@EnableFeignClients("com.search.cat_picture")
public class OpenFeignConfig {

	@Bean
	Logger.Level feignLoggerLevel(){ // 로깅
		return Logger.Level.BASIC;
	}

	@Bean
	public FeignErrorDecider commonFeignErrorDecoder() { // 예외 처리
		return new FeignErrorDecider();
	}
}

 

 

 

소스코드

 

https://github.com/youngjijang/cat_picture_search

GitHub - youngjijang/cat_picture_search: OpenFeign을 이용한 API 연동 실습

 

 

마무리

OpenFeign의 사용법은 그리 어렵지 않다고 생각합니다. 프로젝트를 진행할때 외부 API를 사용하게 된다면, 어떤식으로 해당 API에 대한 의존성을 줄일 수 있을까 고민하게 되는데 OpenFeign을 사용하는 것만으로도 API를 갈아끼우기가 훨씬 수월해졌으니 유지보수 측면에서도 분명 장점이 있어보이네요.

후에 다른 방식으로도 외부 API를 연동해보고 비교하는 글을 써봐도 재미있을 것 같습니다. 어쨌든 OpenFeign을 경험해보고 싶거나 현업자의 코드리뷰를 받아보고 싶으시다면 해당 코스를 추천합니다. 재미있었어요. 😇

 

 

 

 

Reference.

https://www.baeldung.com/spring-cloud-openfeign