[Spring Cloud로 개발하는 마이크로서비스] Section 2: API Gateway Service

API Gateway Service

API Gateway는 서비스로 전달되는 모든 API 요청의 관문 역할을 한다. 내부 서버 시스템의 아키텍처를 내부로 숨기고 외부의 요청에 대한 적절한 응답을 한다. 즉, 클라이언트가 내부 구조를 알 필요없이 약속한 형태의 API의 통신하는 것이다.

 

API Gateway의 기능

• 클라이언트의 요청을 일괄적으로 처리
• 서비스 디스커버리
• 전체 시스템의 부하를 분산 시키는 로드 밸런서의 역할
• 동일한 요청에 대한 불필요한 반복 작업을 줄일 수 있는 캐싱
• 시스템 상을 오고가는 요청과 응답에 대한 모니터링
• 시스템 내부에 아키텍처를 숨길 수 있음
• 회로차단기 기능
• 인증 및 인가

Spring Cloud에서 MSA간 통신

- RestTemplate

- Feign Client

 

Netfilx Zuul로 구현

<client - netfilx zull - {service1, service2}>

Spring boot 2.4에서는 Maintenance 상태 (더 이상 지원하지않는 상태)

Spring Cloud Gateway

spring cloud gateway - filter

Request, Response Header에 서비스에 맞는 값 추가.

application.yml 파일로 설정 추가

server:
  port: 8000

eureka:
  client:
    register-with-eureka: false
    fetch-registry: false
    service-url:
      defaultZone: http://localhost:8761/eureka

spring:
  application:
    name: apigateway-service
  cloud:
    gateway:
      routes:
        - id: first-service
          uri: http://localhost:8081/
          predicates:
            - Path=/first-service/**
          filters:
            - AddRequestHeader=first-request, first-request-header2
            - AddResponseHeader=first-response, first-response-header2
        - id: second-service
          uri: http://localhost:8082/
          predicates:
            - Path=/second-service/**
          filters:
            - AddRequestHeader=second-request, second-request-header2
            - AddResponseHeader=second-response, second-response-header2

cloud.gateway.routes 정보에 각각의 서비스의 id, uri정보와 추가적인 path, filter정보를 설정해줄 수 있다.

FilterConfig.java - 자바코드를 이용한 필터추가

@Configuration
public class FilterConfig {
    @Bean
    public RouteLocator gatewayRoutes(RouteLocatorBuilder builder) {
        return builder.routes()
                .route(r -> r.path("/first-service/**") // 라우트 등록
                        .filters(f -> f.addRequestHeader("first-request", "first-request-header")
                                        .addResponseHeader("first-response", "first-response")) // 헤더 필터
                        .uri("http://localhost:8081")) // uri정보
                .route(r -> r.path("/second-service/**") // 라우트 등록
                        .filters(f -> f.addRequestHeader("second-request", "second-request-header")
                                .addResponseHeader("second-response", "second-response")) // 헤더 필터
                        .uri("http://localhost:8082")) // uri정보
                .build();
        // .yml 동작을 자바코드로도 가능
    }
}

RouterLocator를 반환하는 FilterConfig를 스프링 빈에 등록해서 사용할 수 있다.

빌더를 사용하여 .yml과 같이 route정보를 등록하고 필터정보 또한 등록할 수 있다.

CustomFilter - 커스타마이징 필터 추가

@Slf4j
@Component
public class CustomFilter extends AbstractGatewayFilterFactory<CustomFilter.Config> {
    public CustomFilter() {
        super(CustomFilter.Config.class);
    }

    @Override
    public GatewayFilter apply(CustomFilter.Config config) {
        // Custom pre filter. JWT
        return (exchange, chain) -> {
            ServerHttpRequest request = exchange.getRequest();
            ServerHttpResponse response = exchange.getResponse();

            log.info("Custom PRE filter: reqeust id -> {}", request.getId());

            // Custom Post filter
            // 체인에 exchange 적용하고 적용이후에 then 실행
            return chain.filter(exchange).then(Mono.fromRunnable(() -> {
                log.info("Custom PRE filter: response code -> {}", response.getStatusCode());
            }));
        };
    }

    public static class Config {

        // configration 정보가 있다면 이 클래스에 넣어주면된다.
    }
}

AbstractGatewayFilterFactory의 apply() 메서드를 오버라이드하여 요청 전, 후로 원하는 동작이나 필터를 설정할 수 있다.

해당 클래스를 스프링 빈으로 등록하고 등록한 빈을 사용하도록 .yml 파일에서 설정해주면된다.

 

CustomFilter를 적용한 application.yml 파일

server:
  port: 8000

eureka:
  client:
    register-with-eureka: false
    fetch-registry: false
    service-url:
      defaultZone: http://localhost:8761/eureka

spring:
  application:
    name: apigateway-service
  cloud:
    gateway:
      routes:
        - id: first-service
          uri: http://localhost:8081/
          predicates:
            - Path=/first-service/**
          filters:
            - CustomFilter
        - id: second-service
          uri: http://localhost:8082/
          predicates:
            - Path=/second-service/**
          filters:
            - CustomFilter

Custom필터는 라우터마다 지정해줘야만 설정된다.

GlobalFilter 적용하기

CustomFilter는 각각의 라우터마다 지정해줘야 했다. 모든 라우터에 필터를 적용해보자.

@Slf4j
@Component
public class GlobalFilter extends AbstractGatewayFilterFactory<GlobalFilter.Config> {
    public GlobalFilter() {
        super(GlobalFilter.Config.class);
    }

    @Override
    public GatewayFilter apply(GlobalFilter.Config config) {
        // Custom pre filter. JWT
        return (exchange, chain) -> {
            ServerHttpRequest request = exchange.getRequest();
            ServerHttpResponse response = exchange.getResponse();

            log.info("Global filter baseMessage: reqeust id -> {}", config.getBaseMessage());

            if (config.isPreLogger()) {
                log.info("Global Fileter Start: request id -> {}", request.getId());
            }
            // Custom Post filter
            // 체인에 exchange 적용하고 적용이후에 then 실행
            return chain.filter(exchange).then(Mono.fromRunnable(() -> {
                if (config.isPostLogger())
                    log.info("Global filter End: response code -> {}", response.getStatusCode());
            }));
        };
    }

    @Data
    public static class Config {
        // configration 정보가 있다면 이 클래스에 넣어주면된다.
        private String baseMessage;
        private boolean preLogger;
        private boolean postLogger;
    }
}

필터를 만들어주고 .yml파일에 설정정보를 작성해준다.

spring:
  application:
    name: apigateway-service
  cloud:
    gateway:
      default-filters:
        - name: GlobalFilter
          args:
            baseMessage: Spring Cloud Gateway Global Filter
            preLogger: true
            postLogger: true

 

필터적용 후 first-service를 호출해보면 아래 그림과 같이 Global - Custom - 실행 - Custom - Global 순서로 나온다.

 

추가적으로 LoggingFilter를 특정서비스에만 적용하고 싶다면 필터를 등록하고 .yml을 파일을 수정해주면된다.

spring:
  application:
    name: apigateway-service
  cloud:
    gateway:
      default-filters:
        - name: GlobalFilter
          args:
            baseMessage: Spring Cloud Gateway Global Filter
            preLogger: true
            postLogger: true
      routes:
        - id: first-service
          uri: http://localhost:8081/
          predicates:
            - Path=/first-service/**
          filters:
#            - AddRequestHeader=first-request, first-request-header2
#            - AddResponseHeader=first-response, first-response-header2
            - CustomFilter
        - id: second-service
          uri: http://localhost:8082/
          predicates:
            - Path=/second-service/**
          filters:
#            - AddRequestHeader=second-request, second-request-header2
#            - AddResponseHeader=second-response, second-response-header2
            - name: CustomFilter
            - name: LoggingFilter
              args:
                baseMessage: Hi, there
                preLogger: true
                postLogger: true

실행 순서

Spring Cloud Gateway - Eureka 연동

지금까지 서비스를 유레카에 등록하자.

 

각각의 서비스에 유레카 정보를 넣어준다.

eureka:
  client:
    register-with-eureka: true
    fetch-registry: true
    service-url:
      defaultZone: http://localhost:8761/eureka

 

라우트 uri 설정시 uri가 아닌 유레카에 등록된 lb이름으로 설정하도록 한다. 

포트를 지정하지 않으므로 랜덤한 포트가 사용가능하게 되었다.

routes:
        - id: first-service
          uri: lb://MY-FIRST-SERVICE #http://localhost:8081/ 이제 포트를 지정하지 않음

 

클라이언트 요청이 들어오면 유레카에 등록된 서비스를 Discovery하고 해당하는 서비스를 찾아 요청을 보낸다.

Eureka에 등록된 서비스들

로드 밸런스 기능

기존의 first-service와 second-service를 랜덤포트로 실행하도록 변경해보자. 그리고 유레카에는 인스턴스id로 유일한 값을 가지도록 등록하자.

 

변경된 .yml 파일

server:
  port: 0 # random port

spring:
  application:
    name: my-first-service
eureka:
  client:
    fetch-registry: true
    register-with-eureka: true
    service-url:
      defaultZone: http://localhost:8761/eureka
  instance:
    instance-id: ${spring.application.name}:${spring.application.instance.id:${random.value}}

바뀐 서비스의 인스턴스를 두 개 실행하게 되면..

서비스의 인스턴스가 실행될 때 인스턴스id를 만들어 유레카에 등록하게 된다.

 

이제 클라이언트에서 요청이 오면 로드밸런서가 알아서 각각의 인스턴스에 요청을 배분해준다. (로드밸런싱)