🤔 스프링 클라우드 시리즈!

스프링 클라우드 게이트웨이를 세팅하고 확인해보자

이 글은 해당 글과 이어지는 글입니다. https://velog.io/@borab/Spring-Cloud-Eureka

Spring Cloud Gateway란?

spring cloud gateway는 api gateway이다. api gateway란 Client(vue, react로 된 front-end) 와 back-end(springboot) 를 연동하기 위해 사용하는 것로 spring cloud gateway 말고 Zuul, Zuul2 가 있다.

하지만 Zuul 같은 경우 Blocking 방식으로 비동기를 지원하지 않아 응답을 기다린다는 단점이 있고, Zuul2는 이를 개선하여 non-blocking 방식으로 지원을 했지만 스프링 클라우드의 일부 라이브러리랑 호환이 되지 않았다.

그래서 최근들어서는 spring cloud gateway가 주목을 받기 시작했고 토이 프로젝트에서도 Spring Cloud Gateway를 사용하기로 했다.

Api Gateway

그럼 정확한 api 게이트웨이는 무엇일까?

api gateway는 Application Programing Interface Gateway로 앞서 언급했듯이

• Client와 Springboot(back-end) 서비스를 연동

외에도

• 보안 인증/인가
• 일정량 이상의 요청 제한
• 응답 캐싱
• L/B Routing : 라우팅, 필터링 프록시
• Logging
• Circuit Break

로도 쓰인다.

개인적으로 앤드포인트 라는 단어가 spring cloud gateway 가 지원하는 api gateway 방식을 가장 잘 표현하는 단어라고 생각하는데, 요청을 한 곳을 모아 라운드로빈 방식으로 적합한 서비스에 라우팅해주고, 요청이 많이 올 경우 트래픽을 제한한다. 또한 반복되는 로직은 캐싱처리하거나, 공통으로 이 앤드포인트에 요청이 들어와 로깅처리도 수월하다.

Spring Cloud Gateway 구조

Spring Cloud Gateway 같은 경우

Predicates 와 Filter 구성되어 동작한다.

predicate 영역은 조건을 주어서 해당 경로가 맞는지 확인하고 맞으면 필터로 요청을 전송하고
filter 요청을 수행한다.

Spring cloud gateway 실습하기

기본 base 세팅

1. 모듈에 gateway project를 하나 추가한다

2. build.gradle에 의존성을 추가한다.

https://mvnrepository.com/artifact/org.springframework.cloud/spring-cloud-starter-gateway/3.0.5

  // config
    implementation group: 'org.springframework.cloud', name: 'spring-cloud-starter-config', version: '3.0.5'

    // eureka
    implementation group: 'org.springframework.cloud', name: 'spring-cloud-starter-netflix-eureka-client', version: '3.0.4'

    // gateway
    implementation group: 'org.springframework.cloud', name: 'spring-cloud-starter-gateway', version: '3.0.5'

앞서 멀티모듈로 생성하였기 때문에 최상위 루트 build.gradle에는 롬복 설정도 이쯤추가해준다.

	// lombok
		compileOnly 'org.projectlombok:lombok'
		annotationProcessor 'org.projectlombok:lombok'

3. resources 밑 application.yml와 bootstrap.yml을 생성하고 파일에 다음 내용을 추가한다.

application.yml

server:
  port: 8000


spring:
  main:
    web-application-type: reactive
  cloud:
    gateway:
      routes:
        - id: api-member
          uri: http://localhost:9090
          predicates:
            - Path=/member/**
        - id: api-order
          uri: http://localhost:9091
          predicates:
            - Path=/order/**
        - id: api-product
          uri: http://localhost:9092
          predicates:
            - Path=/product/**




eureka:
  client:
    serviceUrl:
      defaultZone: http://localhost:8761/eureka/
    healthcheck:
      enabled: true

• spring.cloud.gateway.routes 은 스프링 클라우드 게이트웨이가 특정 조건의 요청이 들어 올때 어디로 라우팅할지에 대한 설정이다.
• spring.cloud.gateway.routes.id : 라우팅할 스프링 부트 애플리케이션 명이다.
• spring.cloud.gateway.routes.uri : 라우팅할 주소이다
• spring.cloud.gateway.routes.predicates : 라우팅 조건이다. 이 조건이 들어오면 해당 uri로 요청이 보내진다.

bootstrap.yml

spring:
  application:
    name: api-gateway
  cloud:
    config:
      uri: http://localhost:8888

4. 기존 서비스에 Context Path 설정 집어 넣기

위의 라우팅 설정을 확인 해보면 member 서비스를 호출할때 localhost:9090/member 라는 경로로 가게 세팅되어 있다.

따라서 /member 는 디폴트 설정으로 변하지 않는다

이런 경우에는 server.servlet.context-path 설정을 추가해 서버 포트 처럼 고정으로 지정해주자!

기존에 포트를 설정했던 yml 파일에 다음과 같이 내용을 추가해주었다.

server:
  port: 9090
  servlet:
    context-path: /member

5. gateway 호출

이제 gateway로 지정한 서비스를 호출해보자

gateway는 8000 번으로 띄웠다. 그래서 localhost:8000/member/config/profile 라는 것으로 멤버에 있는 api 를 호출하였다.

잘 작동하는 것을 확인할 수 있다.

다른 서비스에도 같은 설정을 해주고 호출해봤다.

localhost:8000 으로 모든 서비스를 호출할 수 있다.

front 에서 필요한 api를 호출하고 싶으면 spring cloud gateway 라는 공통의 서비스를 호출하여 spring cloud gateway 가 알맞는 곳으로 요청을 보내주고 값을 반환 해준다.

유레카에도 잘 확인된다.

7. Eureka에 맞춰서 route uri 수정

https://cloud.spring.io/spring-cloud-netflix/multi/multi__service_discovery_eureka_clients.html

앞서 유레카는 전화번호부 같은 존재로 spring cloud gateway에서 참고해서 같이 쓰인다. 이번에는 유레카를 연동해보자!.

위에 유레카 사진을 보면 각 서비스의 이름이 나오는데 그것을 lb://{서비스} 라고 변경한다.

spring:
  main:
    web-application-type: reactive
  cloud:
    gateway:
      routes:
        - id: api-member
          uri: lb://API-MEMBER
          predicates:
            - Path=/member/**
        - id: api-order
          uri: lb://API-ORDER
          predicates:
            - Path=/order/**
        - id: api-product
          uri: lb://API-PRODUCT
          predicates:
            - Path=/product/**

이렇게 변환하면 cloud 구조에서 서버의 ip 가 변경되도 서비스 이름을 찾아간다.

global filter 적용

아까 언급했던 것처럼 api-gateway는 필터를 적용한다. 그래서 이번에는 이 글로벌 필터로 스프링 클라우드 게이트웨이로 들어온 요청이 어디로 온 요청이고, status code를 확인하는 간단한 로깅 설정을 추가해보자!

먼저 api-gateway 애플리케이션의 application.yml 파일에 다음의 설정을 추가해줬다.

application.yml

spring:
  cloud:
    gateway:
      default-filters:
        - name: GlobalFilter
          args:
            preLogger: true
            postLogger: true

• spring.cloud.gateway.default-filters 는 글로벌 필터를 추가하는 설정이다.
• -name : 필터 이름을 넣어준다.
• args : 사용할

그리고 다음 소스코드를 추가해주었다.

@Component
@Slf4j
public class GlobalFilter extends AbstractGatewayFilterFactory<GlobalFilter.Config> {

    public GlobalFilter() {
        super(Config.class);
    }

    @Override
    public GatewayFilter apply(Config config) {

        return ((exchange, chain) -> {
            ServerHttpRequest req = exchange.getRequest();
            ServerHttpResponse res = exchange.getResponse();

            if (config.isPreLogger()) {
                log.info("[REQ ID : {}][REQUEST PATH]          -> {}", req.getId(), req.getPath());
                if (!req.getQueryParams().isEmpty()) {
                    log.info("[REQ ID : {}][REQUEST PATH]          -> {}", req.getId(), req.getPath());
                }
            }
            req.getQueryParams();
            return chain.filter(exchange).then(Mono.fromRunnable(() -> {
                if (config.isPostLogger()) {
                    log.info("[REQ ID : {}][RESPONSE STATUS CODE]  -> {}", req.getId(), res.getStatusCode());
                }
            }));
        });
    }

    @Data
    public static class Config {
        private boolean preLogger;
        private boolean postLogger;
    }

}

그리고 화면을 호출해보자

이렇게 로그가 찍히는 것도 확인할 수 있다.

정리

spring cloud gateway는 이렇게 로그를 공통으로 관리해줄 뿐만아니라 라우팅 기능도 제공해준다.

또한 여기에서는 다루지 않았지만 뒤에서 다룰 filter를 사용해서 공통으로 세션, 토큰 관리를 제공해주어 인증 인가에 대한 메커니즘도 구현할 수 있고, 서킷브레이커에 대한 기능도 다룰수 있다.

자세한 것은 이후 spring cloud gateway 2에서 다뤄보자