🌐 Spring Cloud Gateway MVC - Reactive에서 마이그레이션

조제·2025년 3월 26일

최근 Spring Cloud Gateway는 기존의 Reactive 기반 외에도 MVC 기반의 구현을 지원하게 되었습니다. 이번 글에서는 MVC Gateway의 문제점과 Reactive Gateway와의 비교를 통해 어떤 방식이 더 적절한지 살펴보겠습니다.

🛠️ build.gradle

    // Reactive Gateway
    implementation 'org.springframework.cloud:spring-cloud-starter-gateway'
    
    // MVC Gateway
    implementation 'org.springframework.cloud:spring-cloud-starter-gateway-mvc'

🔀 Route

Reactive Gateway의 application.yaml

spring:
  cloud:
    gateway:
      routes:
        - id: demo
          uri: http://localhost:10001
          predicates:
            - Path=/demo/**
          filters:
            - StripPrefix=1

MVC Gateway의 application.yaml

spring:
  cloud:
    gateway:
      mvc:
        routes:
          - id: demo
            uri: http://localhost:10001
            predicates:
              - Path=/demo/**
            filters:
              - StripPrefix=1

routes는 spring.cloud.gateway 대신 spring.cloud.gateway.mvc에서 정의됩니다.

🧰 Filter

Reactive Gateway

Reactive Gateway에서는 다양한 필터를 제공합니다. 예시로 모든 요청에 동작하는 Global Filter와 특정 라우트에만 동작하는 Gateway Filter등이 있습니다.

AuthenticationGlobalFilter.java

public class AuthenticationGlobalFilter implements GlobalFilter {

    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        ServerHttpRequest originalRequest = exchange.getRequest();
    	...
    }
    
}

MVC Gateway

MVC Gateway에서는 기본으로 제공하는 필터가 없기 때문에 OncePerRequestFilter 같은 Spring MVC의 기존 필터 클래스를 사용해야 합니다.

AuthenticationFilter.java

public class AuthenticationFilter extends OncePerRequestFilter {

    @Override
    protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain) throws ServletException, IOException {
    	...
    }
    
}

🚑 Health Check와 같은 요청에도 필터가 걸리는 문제

MVC에서는 모든 요청에 대해 필터링이 적용되므로 특정 URL 패턴을 등록하는 과정이 필요합니다.

따라서 routes에 등록한 후 다시 filterConfig에도 추가 등록해야 하는 번거로움이 있습니다.

application.yaml

spring:
  cloud:
    gateway:
      mvc:
        routes:
          - id: demo
            uri: http://localhost:10001
            predicates:
              - Path=/demo/**
            filters:
              - StripPrefix=1

FilterConfig.java

    @Bean
    public FilterRegistrationBean<LoggingFilter> loggingFilter() {
        FilterRegistrationBean<LoggingFilter> registrationBean = new FilterRegistrationBean<>();
        registrationBean.setFilter(new LoggingFilter());
        registrationBean.addUrlPatterns("/demo/*");
        registrationBean.setOrder(1);
        return registrationBean;
    }

하지만 모든 요청에 대해 필터링이 적용되어도 상관없고, Health Check와 같은 특정 URL만 제외하는 방식이 더 간단하고 유지보수가 쉬울 수 있습니다.

이를 위해 OncePerRequestFilter 클래스의 shouldNotFilter() 메서드를 활용할 수 있습니다.

    @Override
    protected boolean shouldNotFilter(HttpServletRequest request) throws ServletException {
    	return request.getRequestURI().startsWith("/health");
    }

📡 Request

Reactive Gateway

Reactive Gateway에서는 ServerHttpRequest의 mutate() 메서드를 활용하여 손쉽게 요청 헤더를 추가할 수 있습니다.

	ServerHttpRequest mutatedRequest = originalRequest.mutate()
    	.header("X-Account-Info", encodedInfo)
        .build();

MVC Gateway

MVC Gateway에서는 HttpServletRequest에 직접 헤더를 추가할 수 없기 때문에, 이를 해결하기 위해 별도의 래핑 클래스를 구현해야 합니다.

예제에서는 커스텀 ModifiableHeaderRequest 래핑 클래스 활용

private static class ModifiableHeaderRequest extends HttpServletRequestWrapper {
    private final Map<String, String> customHeaders = new HashMap<>();

    public ModifiableHeaderRequest(HttpServletRequest request) {
        super(request);
    }

    public void addHeader(String name, String value) {
        customHeaders.put(name, value);
    }

    @Override
    public String getHeader(String name) {
        return customHeaders.getOrDefault(name, super.getHeader(name));
    }

    @Override
    public Enumeration<String> getHeaderNames() {
        Set<String> headerNames = new HashSet<>();
        Enumeration<String> originalHeaderNames = super.getHeaderNames();
        while (originalHeaderNames.hasMoreElements()) {
            headerNames.add(originalHeaderNames.nextElement());
        }
        headerNames.addAll(customHeaders.keySet());

        return Collections.enumeration(headerNames);
    }

    @Override
    public Enumeration<String> getHeaders(String name) {
        if (customHeaders.containsKey(name)) {
            return Collections.enumeration(Collections.singleton(customHeaders.get(name)));
        }
        return super.getHeaders(name);
    }
}

	// 필터에서 활용
    ModifiableHeaderRequest modifiableRequest = new ModifiableHeaderRequest(request);
    modifiableRequest.addHeader("X-Account-Info", encodedInfo);

⚖️ 비교

특징	Reactive Gateway	MVC Gateway
동시성	높은 동시성과 확장성 제공	Virtual Thread 사용 시 성능 개선 가능
기능 제공	Spring Cloud Gateway의 다양한 기능 제공	기본 필터 미제공으로 일부 기능 커스텀 필요
코드 복잡도	러닝 커브가 높고 유지보수가 어려울 수 있음	코드가 더 직관적이며 유지보수 용이
예외 처리	논블로킹 방식으로 예외 처리 및 스택 트레이스 확인이 어려울 수 있음	동기 코드 기반으로 예외 처리 및 디버깅이 쉬움