Spring Cloud Gateway로 API 관문 열기: 기본 개념부터 프로젝트 실습까지

마이크로서비스 아키텍처에서 API Gateway는 매우 중요한 역할을 합니다. 각각의 마이크로서비스가 개별적으로 동작하지만, 클라이언트 입장에서는 하나의 통합된 인터페이스를 통해 여러 서비스를 호출할 수 있어야 합니다. 이를 가능하게 해주는 것이 바로 API Gateway입니다. 이번 블로그에서는 API Gateway의 기본 개념을 설명하고, Spring Cloud Gateway를 활용한 간단한 프로젝트를 통해 API Gateway를 쉽게 구현하는 방법을 소개하겠습니다.

API Gateway란?

API Gateway는 클라이언트의 요청을 받아 적절한 마이크로서비스로 라우팅해주는 역할을 하는 서버입니다. 단순히 요청을 전달하는 것뿐만 아니라, 인증 및 인가, 로깅, 모니터링, 요청/응답 변환 등의 다양한 기능을 제공할 수 있습니다. 다음은 API Gateway가 제공하는 주요 기능들입니다:

• 라우팅 (Routing): 클라이언트의 요청을 적절한 마이크로서비스로 전달합니다.
• 로드 밸런싱 (Load Balancing): 여러 서비스 인스턴스 중에서 요청을 분산시킵니다.
• 인증 및 인가 (Authentication and Authorization): 사용자의 인증 및 권한을 확인하여 적절한 서비스에 접근할 수 있도록 합니다.
• 모니터링 및 로깅 (Monitoring and Logging): 트래픽을 모니터링하고, 로그를 기록하여 분석할 수 있도록 합니다.
• 요청/응답 변환 (Request/Response Transformation): 요청이나 응답의 형식을 변환하여 클라이언트와 서비스 간의 호환성을 높입니다.

Spring Cloud Gateway란?

Spring Cloud Gateway는 Spring 생태계에서 제공하는 API Gateway 솔루션으로, 고성능, 확장성, 사용의 용이성을 갖춘 비동기 API Gateway입니다. Spring Cloud Gateway는 Spring WebFlux를 기반으로 하며, 기존의 Spring MVC 기반 솔루션보다 더 나은 성능을 제공합니다. 다음은 Spring Cloud Gateway의 주요 특징입니다:

• 비동기 논블로킹 아키텍처: Spring WebFlux를 기반으로 하여 고성능의 비동기 API Gateway를 제공합니다.
• 라우팅 설정의 유연성: YAML이나 Java 코드로 쉽게 라우팅 규칙을 설정할 수 있습니다.
• 필터 사용의 편리함: 요청과 응답을 전처리/후처리하는 다양한 필터를 제공합니다.
• Spring 생태계와의 통합: Spring Security, Spring Boot Actuator 등과 쉽게 통합할 수 있습니다.

반응형

Spring Cloud Gateway 프로젝트 구현하기

이제 실제로 Spring Cloud Gateway를 사용하여 간단한 API Gateway를 구축해보겠습니다.

1. 프로젝트 설정

먼저, Spring Initializr를 사용하여 Spring Boot 프로젝트를 생성합니다. spring-cloud-starter-gateway 의존성을 추가해야 합니다.

Gradle 설정 예시

dependencies {
    implementation 'org.springframework.boot:spring-boot-starter-webflux'
    implementation 'org.springframework.cloud:spring-cloud-starter-gateway'
    implementation 'org.springframework.boot:spring-boot-starter-actuator'
}

2. 라우팅 설정

application.yml 파일에서 라우팅을 설정합니다. 예를 들어, "/api/service1/**" 경로로 들어오는 요청을 로컬에 있는 http://localhost:8081 서비스로 라우팅한다고 가정하겠습니다.

spring:
  cloud:
    gateway:
      routes:
        - id: service1-route
          uri: http://localhost:8081
          predicates:
            - Path=/api/service1/**
          filters:
            - StripPrefix=2

위 설정에서 predicates는 요청을 특정 경로로 필터링하며, filters는 요청 경로의 일부를 제거하는 등 다양한 처리를 할 수 있게 합니다.

3. 필터 추가하기

Spring Cloud Gateway는 다양한 필터를 제공합니다. 예를 들어, 요청에 대해 로그를 남기는 필터를 추가할 수 있습니다.

spring:
  cloud:
    gateway:
      routes:
        - id: service1-route
          uri: http://localhost:8081
          predicates:
            - Path=/api/service1/**
          filters:
            - StripPrefix=2
            - AddRequestHeader=X-Request-Id, 12345

여기서는 AddRequestHeader 필터를 사용하여 요청 헤더에 X-Request-Id 값을 추가했습니다.

4. 간단한 서비스 구현

이제 /api/service1/** 경로로 들어오는 요청을 처리할 간단한 마이크로서비스를 하나 만들어 보겠습니다. 이 서비스는 예를 들어 8081 포트에서 실행되는 간단한 Spring Boot 애플리케이션이 될 수 있습니다.

@RestController
@RequestMapping("/service1")
public class Service1Controller {

    @GetMapping("/greet")
    public String greet() {
        return "Hello from Service 1";
    }
}

이제 http://localhost:8080/api/service1/greet로 요청을 보내면, Spring Cloud Gateway가 이를 http://localhost:8081/service1/greet로 라우팅하고, "Hello from Service 1" 응답을 받을 수 있습니다.

728x90

Spring Cloud Gateway는 마이크로서비스 아키텍처에서 API Gateway로 활용하기에 매우 적합한 솔루션입니다. 비동기 논블로킹 아키텍처와 유연한 라우팅, 다양한 필터 기능을 제공하여 복잡한 요청 처리 요구 사항을 쉽게 구현할 수 있습니다. 이번 블로그에서는 Spring Cloud Gateway의 기본 개념과 함께 간단한 프로젝트를 통해 실습해보았습니다. 이를 통해 여러분도 손쉽게 API Gateway를 구축하고, 마이크로서비스를 효율적으로 관리할 수 있을 것입니다.