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

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

🔊 앞서, API Gateway의 라우팅을 설정했는데 실행했을 때 결과 값이 다르게 나타났다. 그 이유에 대해 알아보자.

 

API Gateway 파트 3

 

우선, 작성한 코드를 살펴보자.

1. 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.RestController;

@RestController
public class UserController {

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

 

user- service 서버 실행

http://localhost:8081/

 

2. 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/**
        - id: beverage-service
          uri: http://localhost:8082/
          predicates:
            - Path=/beverage-service/**
        - id: community-service
          uri: http://localhost:8083/
          predicates:
            - path=/community-service/**

 

apigateway-service 서버 실행

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

• 404 에러 발생

 

 

❓라우팅 연결을 했는데 두 주소의 결과가 다르게 나타난다. 다시 말해, API Gateway service의 라우팅 설정을 마쳤는데 각 서비스로 연결이 되지 않는 문제가 발생했다. apigateway-service의 yml 파일에 설정을 했는데 8000번 포트에서 8081, 8082, 8083 포트로 연결이 안 된다.😨

• http://localhost:8000/user-service/에서 http://localhost:8081/로 연결이 안된다.
• http://localhost:8000/beverage-service/에서 http://localhost:8082/로 연결이 안된다.
• http://localhost:8000/community-service/에서 http://localhost:8083/으로 연결이 안된다.

왜 그럴까? 그 이유를 찾기 위해 또 열심히 구글 검색을 했다.

결론적으로, 이 문제는 Gateway 설정 경로와 실제 서비스 코드 간의 API 통신 경로 불일치로 인해 발생한다는 것을 알아냈다. 위의 코드 설정에 따르면 http://localhost:8000/user-service/로 들어오는 요청이 http://localhost:8081/로프락시되는 것을 예상했으나 실제로는 http://localhost:8081/user-service/로 전달되는 것이었다.

 

이 문제를 해결하기 위해 두 가지 방법을 찾았다.

1. 첫 번째 방법은 간단히 경로를 수정하여 서비스 코드와 일치시키는 것이다.
2. 두 번째 방법은 Spring Cloud Gateway에서 URI 경로를 재작성하는 필터를 적용하는 것이다. Gateway는 이러한 필터를 통해 들어오는 요청과 나가는 응답을 수정할 수 있으며, 이를 통해 Gateway와 서비스 간의 일관성을 유지할 수 있다.

---

⭐API Gateway에서 마이크로서비스로 라우팅 연결이 제대로 되지 않은 이유?

결론부터 말하자면,

Gateway 구성에서 정의된 경로 및 프락시 설정과 실제 서비스 코드 간의 불일치 때문에 문제가 발생했다.

• Gateway 설정 경로
  • http://localhost:8000/user-service/** 으로 요청하면
  • http://localhost:8081/user-service/** 으로 요청이 넘어간다.
• user-service 서비스 경로
  • user-service 서비스 API @GetMapping("/") 으로 설정되어있다.
  • http://localhost:8081/ 으로 API 통신을 하고있다.
  • 즉, http://localhost:8000/user-service/ 에 대해서는 API가 설정되어 있지 않아 404에러가 발생한다.

 

상세히 설명하면,

먼저, Spring Cloud Gateway 설정을 살펴보면 라우터 설정이 다음과 같다.

# apigateway-service: application.yml

spring:
  application:
    name: apigateway-service
  cloud:
    gateway:
      routes:
        - id: user-service
          # 어디로 갈꺼니?
          uri: http://localhost:8081/
          # 조건절
          predicates:
            - Path=/user-service/**

 

이 설정은 Gateway에 들어오는 /user-service/로 시작하는 요청을 http://localhost:8081/user-service/로 프록시 하라는 의미이다. 

현재 Spring Cloud Gateway 설정은 http://localhost:8081/에 user-service/**가 추가되어 http://localhost:8081/user-service/**로 요청된다.

• http://localhost:8081/ + user-service/**

http://localhost:8000/user-service/** 으로 요청하면 http://localhost:8081/user-service/** 으로 요청이 넘어간다.

 

user-service의 컨트롤러의 API 통신 코드는 다음과 같다.

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

@RestController
public class UserController {

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

 

user-service의 컨트롤러는 "/" 경로에 대해서만 응답하고 있다. 따라서 실제로는 http://localhost:8081/에서 대해서만 동작한다. 하지만, Gateway는 /user-service/로 시작하는 요청을 기대하고 있기 때문에 이 요청을 처리하지 못한다.

 

정리하자면,

이 문제는 Gateway 설정 경로와 실제 서비스 코드 간의 API 통신 경로 불일치로 인해 발생한다.

1. 현재 설정에 따르면, Gateway에서 요청이 http://localhost:8000/user-service/** 으로 들어오면 실제로는 http://localhost:8081/user-service/** 으로 전달된다.
2. 그러나 실제 서비스 코드에서는 http://localhost:8081/user-service/가 아닌 http://localhost:8081/에서만 API가 설정되어 있다.
3. 이 불일치로 인해 요청이 올바른 엔드포인트로 전달되지 않고 서비스 코드의 다른 경로로 이동하게 되어 404에러가 발생한다.

 

다른 API 주소로 예를 들면, 

@GetMapping("/welcome")  으로 되어있을 때,

Gateway에서 http://localhost:8000/user-service/welcome로 요청이 전달되면 실제로는 http://localhost:8081/user-service/welcome로 전달되어야 한다. 그러나 실제 서비스 코드에서는 http://localhost:8081/welcome 경로에 API가 설정되어 있다.

 

반응형

 

---

1. API Gateway 라우팅 경로 수정하기

이 문제를 해결하기 위해서는 user-service의 컨트롤러가 /user-service/ 경로에 대해서 응답하도록 수정해야 한다. 이렇게 하면 Gateway 설정과 실제 서비스의 경로가 일치하게 되어 요청이 올바르게 프락시 될 것이다.

user-service의 UserController.java  파일 수정

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

@RestController
@RequestMapping("/user-service")
public class UserController {

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

클라이언트가 http://localhost:8000/user-service/로 요청을 보내면, API Gateway는 이 요청을 http://localhost:8081/user-service/로 프락시한다.

 

user- service 서버 실행

user-service

 

apigateway-service 서버 실행

apiateway-service

 

이 경우는 필터를 사용하지 않고, 단순히 경로를 라우팅 대상으로 전달한 것이다.

 

경로 예시

http://localhost:8000/user-service/name  ➡️  http://localhost:8081/user-service/name
http://localhost:8000/beverage-service/10  ➡️  http://localhost:8082/beverage-service/10
http://localhost:8000/community-service/feed  ➡️  http://localhost:8083/community-service/feed

 

---

참고자료

https://spring.io/blog/2022/08/26/creating-a-custom-spring-cloud-gateway-filter