[MSA 구축하기] 8. Spring Cloud Gateway에 필터 적용하기 (API Gateway)

🔊 우리는 Spring Cloud를 활용하여 MSA를 구축한다.

🔊 이번에는, Spring Cloud Gateway Routes의 Filters를 설정할 것이다.

 

API Gateway 파트 4

 

https://bu119.tistory.com/94

[MSA 구축하기] 6. Spring Cloud Gateway 라우팅 설정하기 (API Gateway)

Spring Cloud Gateway 라우팅을 설정했지만 서버를 실행했을 때 제대로 연결되지 않았다. 이러한 문제는 Gateway 설정 경로 및 프록시 설정과 실제 서비스 코드 간의 불일치 때문에 발생했다.

 

https://bu119.tistory.com/97

[MSA 구축하기] 7. Spring Cloud Gateway를 활용한 경로 수정 (API Gateway)

Gateway 설정 경로와 서비스 경로 일치를 위해 user-service의 컨트롤러 경로를 수정했다. 이 경우는 필터를 사용하지 않고, 단순히 경로를 라우팅 대상으로 전달하는 것으로 문제를 해결했다.

 

❓경로 수정으로 문제를 해결하면, user-service의 모든 컨트롤러에 @RequestMapping("/user-service") 을 추가해야 하는 상황이 발생한다. 다른 마이크로서비스들도 각 서비스의 이름으로 @RequestMapping을 추가해야 히고 이러한 부분이 상당히 비효율적이라고 느껴졌다. 구글 검색을 통해 다른 방법을 찾을 수 있었다. Gateway의 Filter를 사용하여 URI 경로를 재작성하여 요청을 백엔드 서비스로 라우팅 하는 방법이 있다.

---

⭐API Gateway 라우팅 필터 설정을 해야 하는 이유?

클라이언트가 http://localhost:8000/user-service/으로 요청을 보냈을 때 http://localhost:8081/user-service/로 프록시하기 위해서는 user-service의 모든 컨트롤러에@RequestMapping("/user-service")을 추가해줘야 하는 상황이 발생한다.

 

그러나 이러한 접근 방식은 많은 양의 코드를 수정해야 하고, 유지보수에 어려움을 줄 수 있다. 또한, 서비스를 추가하거나 제거할 때마다 코드를 변경해야 하므로 유연성이 떨어진다.

 

따라서, Gateway의 Filter를 사용하여 URI 경로를 재작성하여 요청을 백엔드 서비스로 라우팅 할 수 있다.

클라이언트가 http://localhost:8000/user-service/로 요청을 보내면, Gateway의 Filter가 요청의 URI를 수정하여 http://localhost:8081로 프록시 하게 된다.

 

다시 말해, 아래의 형태로 라우팅 하려면 Gateway의 Filter를 사용하여 URI 경로를 재작성해야 한다. 

http://localhost:8000/user-service/name  ➡️  http://localhost:8081/name

  

---

 

 

Spring Cloud Gateway Filter 적용 방법

Filter 를 정의하는 방법은 크게 2가지가 있다.

1. yml 또는 properties 파일에 정의할 수 있다.
2. Java 코드로 정의할 수 있다.

 

🔊 현재, 우리는 yml 파일을 통해 Spring Cloud Gateway Filter를 정의할 것이다.

 

반응형

---

우리의 서비스에는 3개의 마이크로서비스가 있다.

1. user-service
2. beverage-service
3. community-service

 

2. application.yml를 통한 경로 설정

apigateway-service의 application.yml에 filters 추가

RewritePath 필터를 사용하여, 게이트웨이가 요청을 프록시할 때 백엔드 서비스가 요구하는 경로로 요청을 재작성한다.

# apigateway-service: application.yml

spring:
  application:
    name: apigateway-service
  cloud:
    gateway:
      routes:
        - id: user-service
          uri: http://localhost:8081
          predicates:
            - Path=/user-service/**
          filters:
            - RewritePath=/user-service/(?<segment>.*),/$\{segment} # 추가

• RewritePath 필터는 요청의 경로를 재작성한다.
• =/user-service/(?<segment>.*)는 정규 표현식을 사용하여 경로를 다시 쓰는 패턴을 정의한다.
  • 여기서 /user-service/ 다음에 오는 모든 것을 포함하는 부분을 캡처하여 $\{segment}에 할당한다.
  • 이것은 URI 경로에서 /user-service/ 부분을 캡처하지 않고 그 뒤의 모든 것을 캡처한다.
• /$\{segment}는 재작성된 경로를 나타낸다.
  • ${segment}는 앞서 캡처한 새로운 경로 세그먼트를 나타낸다.
  • 따라서, 이 필터는 /user-service/ 뒤에 오는 모든 것을 끝에 슬래시가 없는 경로로 재작성한다.

다시 말해,

RewritePath  필터는 요청이 게이트웨이를 통과할 때 /user-service/로 시작하는 모든 경로를 해당 경로 뒤에 슬래시가 없는 형태로 재작성한다. 예를 들어, /user- service/profile은 /profile로 재작성된다.

이러한 필터는 라우터가 백엔드 서비스에 전달되기 전에 요청을 변경하거나 수정할 필요가 있는 경우에 유용하다.

 

apigateway-service의 application.yml 전체 코드

# apigateway-service: application.yml

server:
  port: 8000

spring:
  application:
    name: apigateway-service
  cloud:
    gateway:
      routes:
        - id: user-service
          uri: http://localhost:8081/
          predicates:
            - Path=/user-service/**
          filters:
            - RewritePath=/user-service/(?<segment>.*),/$\{segment}
        - id: beverage-service
          uri: http://localhost:8082/
          predicates:
            - Path=/beverage-service/**
          filters:
            - RewritePath=/beverage-service/(?<segment>.*),/$\{segment}
        - id: community-service
          uri: http://localhost:8083/
          predicates:
            - Path=/community-service/**
          filters:
            - RewritePath=/community-service/(?<segment>.*),/$\{segment}

 

user-service의 UserController.java

// user-service: UserController.java (8081 포트 사용)

package com.caffeinedoctor.userservice.controller;

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class UserController {

    @GetMapping("/")
    public String getServiceName(){
        return "user-service";
    }
}

 

각 마이크로서비스 서버 실행

http://localhost:8081/

user-service

http://localhost:8082/

beverage-service

http://localhost:8083/

community-service

apigateway-service 서버 실행

http://localhost:8000/user-service/

apigateway-service

 

http://localhost:8000/beverage-service/

apigateway-service

http://localhost:8000/community-service/

apigateway-service

 

 

🔊 정리하자면,

첫 번째 "7. Spring Cloud Gateway를 활용한 경로 수정" 방법은 요청된 경로를 변경하지 않고 그대로 전달하고,

두 번째 "8. Spring Cloud Gateway에 필터 적용하기" 방법은 요청된 경로를 수정하여 서버로 전달한다.

---

 

참고자료

https://docs.spring.io/spring-cloud-gateway/docs/current/reference/html/