[MSA] chapter 3_Spring Cloud gateway 설정

📌 개인적인 공간으로 공부를 기록하고 복습하기 위해 사용하는 블로그입니다.
정확하지 않은 정보가 있을 수 있으니 참고바랍니다 :😸
[틀린 내용은 댓글로 남겨주시면 복받으실거에요]

인프런 Dowon Lee님의 Spring Cloud로 개발하는 마이크로서비스 애플리케이션(MSA) 강의를 듣고 정리한 필기입니다.😊
Spring Cloud로 개발하는 마이크로서비스 애플리케이션(MSA) 강의 들으러 가기👩‍🏫

gateway 실습 1 : application.yml에서 설정

1. build.gradle

   spring-cloud-starter-gateway는 Gateway 기능을 제공하며, WebFlux를 통해 Netty 서버에서 비동기 처리를 지원한다.

    plugins {
    	id 'org.springframework.boot' version '2.7.0'
    	id 'io.spring.dependency-management' version '1.0.13.RELEASE'
    	id 'java'
    }
    ext {
    	set('springCloudVersion', "2021.0.3")
    }
    dependencies {
    	implementation 'org.springframework.boot:spring-boot-starter-webflux'
    	implementation 'org.springframework.boot:spring-boot-starter-data-redis'
    	implementation 'org.springframework.cloud:spring-cloud-starter-gateway'
    	compileOnly 'org.projectlombok:lombok'
    	annotationProcessor 'org.projectlombok:lombok'
    }
       
    dependencyManagement {
    	imports {
    		mavenBom "org.springframework.cloud:spring-cloud-dependencies:${springCloudVersion}"
    	}
    }
   

2. application.yml

   Gateway 설정 파일에서 Gateway의 포트, Eureka와의 연동, 그리고 각 라우트(route)를 정의한다.

    server:
      port: 8000  # API Gateway는 8000 포트에서 실행
       
    eureka:
      client:
        register-with-eureka: true
        fetch-registry: true
        service-url:
          defaultZone: http://127.0.0.1:8761/eureka  # Eureka 서버 URL 설정
       
    spring:
      application:
        name: api-gateway
      cloud:
        gateway:
          routes:
            - id: auth-api
              uri: http://localhost:8081
              predicates:
                - path=/auth-api/**
            - id: core-api
              uri: http://localhost:8082
              predicates:
                - path=/core-api/**
   

   • Eureka 설정: Gateway가 Eureka 서버와 통신하여 각 마이크로서비스의 위치를 가져올 수 있도록 설정한다.
   • Route 설정:
     • /auth-api/** 경로로 들어오는 요청은 http://localhost:8081에 배치된 auth-api로 라우팅된다.
     • /core-api/** 경로로 들어오는 요청은 http://localhost:8082에 배치된 core-api로 라우팅된다.

   이로써 Gateway는 /auth-api/** 및 /core-api/** 경로의 요청을 각각의 마이크로서비스로 분배할 수 있게 된다.

3. Netty 실행 되는 것을 확인할 수 있음

   

   기존의 톰캣 서버가 아닌 Netty 서버가 Spring Cloud Gateway에서 작동하는 것을 확인할 수 있다. 이는 Spring WebFlux가 비동기 환경을 지원하기 위해 Netty 서버를 사용하기 때문이며, Spring Cloud Gateway는 이러한 비동기 처리에 최적화되어 있다.

4. 근데 404?가 나옴

   왜냐면 http://localhost:8082/core-api/** 이렇게 요청이 가기때문이다.

   하지만 실제 서비스는 아래 주석과 같이 localhost:8082/documents 로 되어있다. 그래서 따로 처리해주어야 한다.

• Spring Cloud Gateway의 필터를 사용하여 경로를 재설정하거나 프리필터를 통해 경로를 /documents로 변경하는 방식으로 해결할 수 있다. 이를 통해 Gateway가 요청 경로를 올바르게 매핑할 수 있도록 설정할 수 있다.

• 404 나온 에러를 해결하기 위해서 yml에서 수정하거나 java code로 필터를 설정할 수 있다.

      routes:
            - id: core-api
              uri: http://localhost:8082   # 실제 core-api 서비스 URL
              predicates:
                - Path=/core-api/**
              filters:
                - RewritePath=/core-api/(?<segment>.*), /documents/${segment}  # 경로 변경 필터
  

yml에서 수정하는 방법 외에 java code로 필터를 설정할 수 있는데 아래와 같다.

gateway 실습 1 : java code 로 설정 (Spring Cloud Gateway와 필터 구성 요소)

Spring Cloud Gateway는 마이크로서비스 아키텍처에서 클라이언트의 요청을 각 마이크로서비스로 라우팅하는 역할을 한다. 이 과정에서 요청을 전처리하거나 후처리할 수 있는 필터 기능을 제공해, 요청의 흐름을 유연하게 제어할 수 있다.

주요 필터 구성 요소

• 프레디케이트(Predicate): 클라이언트 요청이 특정 조건을 만족하는지 판단하는 역할을 하며, 조건에 따라 요청을 라우팅할지 여부를 결정한다. 예를 들어, URL 경로나 헤더 값에 따라 다른 서비스로 라우팅할 수 있다.
• 프리필터(Pre-Filter): 요청이 각 마이크로서비스로 전달되기 전에 실행되는 필터로, 요청 헤더 추가나 요청 데이터 수정 등의 작업을 수행한다.
• 포스트필터(Post-Filter): 요청이 마이크로서비스에서 처리된 후에 실행되는 필터로, 응답 헤더 추가나 응답 데이터 수정 등의 작업을 수행한다.

요청 정보가 들어오게 되면 그게 어떤 것인지 판단하는 게 프리티케이트고 프리필터는 어떤작업이 일어나기 사전 필터, 어떤 처리가 끝난 다음에 호출되는 포스트필터가 나눠진다.

코드 예시를 통한 Spring Cloud Gateway 설정

Spring Cloud Gateway에서 경로와 필터를 설정하는 코드로, 각 마이크로서비스로의 요청을 특정 경로에 따라 라우팅한다. 예를 들어, /auth-api/** 경로로 들어온 요청은 auth-api 서비스로, /core-api/** 경로로 들어온 요청은 core-api 서비스로 라우팅된다.

@Configuration
public class RouteLocatorConfig {
  @Bean
  public RouteLocator routeLocator(RouteLocatorBuilder builder, JwtFilter jwtFilter) {
      return builder.routes()
          .route("auth-api", r -> r.path("/auth-api/**")
                          .filters(f -> f.addRequestHeader("first-request", "first-request-header")
                                         .addResponseHeader("first-response", "first-response-header"))
                          .uri("http://localhost:8081/"))
          .route("core-api", r -> r.path("/core-api/**")
                          .filters(f -> f.addRequestHeader("second-request", "second-request-header")
                                         .addResponseHeader("second-response", "second-response-header"))
                          .uri("http://localhost:8082/"))
          .build();
  }
}

1. 필터 설정
   • addRequestHeader: 클라이언트가 보낸 요청에 헤더를 추가한다. 예를 들어, “first-request” 헤더를 “first-request-header” 값으로 추가하여 프리필터에서 처리할 수 있다.
   • addResponseHeader: 요청 처리가 완료된 후 응답에 헤더를 추가한다. 예를 들어, “first-response” 헤더를 응답에 포함해 포스트필터에서 클라이언트에게 반환할 수 있다.
2. 라우팅 흐름
   1. 클라이언트 요청: 클라이언트는 API Gateway를 통해 /auth-api/** 또는 /core-api/** 경로로 요청을 보낸다.
   2. Spring Cloud Gateway 처리: Gateway는 경로에 따라 요청을 라우팅하고, 필터를 적용해 헤더를 추가한다.
   3. 퍼스트 서비스와 세컨드 서비스: 각각의 경로에 따라 8081 포트에서 동작하는 auth-api와 8082 포트에서 동작하는 core-api 서비스로 요청이 전달된다.
   4. 응답 반환: 각 서비스에서 요청을 처리한 후 응답을 반환하며, 포스트필터를 통해 응답 헤더가 추가된다.

---

테스트 및 작동 과정

• 테스트 포트: Gateway가 8000 포트에서 작동하며, 클라이언트는 이 포트를 통해 요청을 보낸다. 예를 들어, http://localhost:8000/auth-api/...로 요청을 보내면, Spring Cloud Gateway가 요청을 8081 포트의 auth-api로 라우팅한다.
• 헤더 확인: Spring Cloud Gateway에서 추가한 요청 및 응답 헤더 값(first-request-header 및 first-response-header 등)을 퍼스트 서비스와 세컨드 서비스에서 확인하고, 처리 후 응답으로 반환할 수 있다.

---

요약👩‍🏫

Spring Cloud Gateway는 클라이언트 요청을 특정 마이크로서비스로 라우팅하며, 프리필터와 포스트필터를 통해 요청 및 응답을 유연하게 관리할 수 있다. 이를 통해 API Gateway는 라우팅 외에도, 보안, 로깅, 응답 캐싱 등 다양한 기능을 수행하며, MSA 환경에서의 유연한 서비스 통신을 지원한다.

MSA 카테고리 내 다른 글 보러가기