<div id="readability-page-1" class="page"><div>
                <p><a href="/m/category/JAVA/spring"><span>JAVA/spring</span></a></p><h3>Spring API Gateway 간단한 예제</h3>
              </div><p><cite>Berno</cite>
                <span> 2023. 12. 10. 13:23</span>
              </p><div>
                                <h3 data-ke-size="size23"><b>0. 이 글을 작성하는 이유</b></h3>
<p data-ke-size="size16">Spring API Gateway를 사용하며 정리하기 위해</p>

<h3 data-ke-size="size23"><b>1. 이전 글에서 좀 달라진 점</b></h3>
<p data-ke-size="size16">이전 글 : <a href="https://developer-youn.tistory.com/174" target="_blank" rel="noopener&nbsp;noreferrer">https://developer-youn.tistory.com/174</a></p>
<figure id="og_1702181994768" contenteditable="false" data-ke-type="opengraph" data-ke-align="alignCenter" data-og-type="article" data-og-title="Spring Cloud Netflix Zuul을 바라보며" data-og-description="0. 이 글을 작성하는 이유 회사에서 API Gateway에 Spring Cloud Netflix Zuul이 적용되어 있는데 이게 뭐 하는 놈인지 간단하게 알고 가기 위함(추후 더 자세히 작성되는 글이 올라올 수도..) 1. Spring Cloud와 " data-og-host="developer-youn.tistory.com" data-og-source-url="https://developer-youn.tistory.com/174" data-og-url="https://developer-youn.tistory.com/174" data-og-image="https://scrap.kakaocdn.net/dn/bIrmDw/hyUL6JTK9I/pu7fqRgSW8cFxNIJt4KV51/img.png?width=800&amp;height=554&amp;face=0_0_800_554,https://scrap.kakaocdn.net/dn/ccJjJY/hyULZcV7V6/Rh1Hvjre2NZfFokIRbcvqK/img.png?width=800&amp;height=554&amp;face=0_0_800_554,https://scrap.kakaocdn.net/dn/ZIjtM/hyUIBLy8ag/UzCQJQOuexyyQexEeOl3M0/img.png?width=1013&amp;height=790&amp;face=0_0_1013_790"><a href="https://developer-youn.tistory.com/174" target="_blank" rel="noopener" data-source-url="https://developer-youn.tistory.com/174">

<div>
<p data-ke-size="size16">Spring Cloud Netflix Zuul을 바라보며</p>
<p data-ke-size="size16">0. 이 글을 작성하는 이유 회사에서 API Gateway에 Spring Cloud Netflix Zuul이 적용되어 있는데 이게 뭐 하는 놈인지 간단하게 알고 가기 위함(추후 더 자세히 작성되는 글이 올라올 수도..) 1. Spring Cloud와</p>
<p data-ke-size="size16">developer-youn.tistory.com</p>
</div>
</a><img src="https://scrap.kakaocdn.net/dn/bIrmDw/hyUL6JTK9I/pu7fqRgSW8cFxNIJt4KV51/img.png?width=800&amp;height=554&amp;face=0_0_800_554,https://scrap.kakaocdn.net/dn/ccJjJY/hyULZcV7V6/Rh1Hvjre2NZfFokIRbcvqK/img.png?width=800&amp;height=554&amp;face=0_0_800_554,https://scrap.kakaocdn.net/dn/ZIjtM/hyUIBLy8ag/UzCQJQOuexyyQexEeOl3M0/img.png?width=1013&amp;height=790&amp;face=0_0_1013_790"></figure>

<p data-ke-size="size16">토이프로젝트에서 kotlin + jdk17 + spring boot3을 사용하며 API Gateway를 사용하려고 했는데 netflix-zuul의 경우 더 이상 기능 개발도 안 한다고 해서 cloud-gateway로 넘어가라고 했다.</p>
<p data-ke-size="size16"><a href="https://github.com/spring-cloud/spring-cloud-netflix/issues/4158" target="_blank" rel="noopener&nbsp;noreferrer">https://github.com/spring-cloud/spring-cloud-netflix/issues/4158</a></p>
<figure id="og_1702181966357" contenteditable="false" data-ke-type="opengraph" data-ke-align="alignCenter" data-og-type="object" data-og-title="spring-cloud-starter-netflix-zuul not work with spring-boot 3.0 and spring 6.0 · Issue #4158 · spring-cloud/spring-cloud-netfl" data-og-description="Hi. I see that spring-cloud-starter-netflix-zuul does not support working with spring-boot 3.0. For example, ZuulHandlerMapping use javax.servlet.http.HttpServletRequest, but in new version spring ..." data-og-host="github.com" data-og-source-url="https://github.com/spring-cloud/spring-cloud-netflix/issues/4158" data-og-url="https://github.com/spring-cloud/spring-cloud-netflix/issues/4158" data-og-image="https://scrap.kakaocdn.net/dn/mzw6Y/hyULQ1m1zs/pKlgaKxs68Kjkl4fXckT7k/img.png?width=1200&amp;height=600&amp;face=0_0_1200_600"><a href="https://github.com/spring-cloud/spring-cloud-netflix/issues/4158" target="_blank" rel="noopener" data-source-url="https://github.com/spring-cloud/spring-cloud-netflix/issues/4158">

<div>
<p data-ke-size="size16">spring-cloud-starter-netflix-zuul not work with spring-boot 3.0 and spring 6.0 · Issue #4158 · spring-cloud/spring-cloud-netfl</p>
<p data-ke-size="size16">Hi. I see that spring-cloud-starter-netflix-zuul does not support working with spring-boot 3.0. For example, ZuulHandlerMapping use javax.servlet.http.HttpServletRequest, but in new version spring ...</p>
<p data-ke-size="size16">github.com</p>
</div>
</a><img src="https://scrap.kakaocdn.net/dn/mzw6Y/hyULQ1m1zs/pKlgaKxs68Kjkl4fXckT7k/img.png?width=1200&amp;height=600&amp;face=0_0_1200_600"></figure>

<h3 data-ke-size="size23"><b>2. 그래서 내 Gradle은</b></h3>
<p data-ke-size="size16">이렇게 나왔다.</p>
<pre id="code_1702182017089" data-ke-language="kotlin" data-ke-type="codeblock"><code>import org.jetbrains.kotlin.gradle.tasks.KotlinCompile

plugins {
    id("org.springframework.boot") version "3.0.6"
    id("io.spring.dependency-management") version "1.1.4"
    kotlin("jvm") version "1.9.20"
    kotlin("plugin.spring") version "1.9.20"
}

extra["springCloudVersion"] = "2022.0.3"

group = "com.cooffee"
version = "0.0.1-SNAPSHOT"

java {
    sourceCompatibility = JavaVersion.VERSION_17
}

repositories {
    mavenCentral()
}

dependencyManagement {
    imports {
        mavenBom("org.springframework.cloud:spring-cloud-dependencies:${property("springCloudVersion")}")
    }
}

dependencies {
    implementation("org.springframework.boot:spring-boot-starter-web")
    implementation("com.fasterxml.jackson.module:jackson-module-kotlin")
    implementation("org.jetbrains.kotlin:kotlin-reflect")
    implementation("org.jetbrains.kotlin:kotlin-stdlib-jdk8")
    implementation("org.springframework.cloud:spring-cloud-starter-gateway")
    implementation("io.netty:netty-resolver-dns-native-macos:4.1.68.Final:osx-aarch_64")
    testImplementation("org.springframework.boot:spring-boot-starter-test")
}

tasks.withType&lt;KotlinCompile&gt; {
    kotlinOptions {
        freeCompilerArgs += "-Xjsr305=strict"
        jvmTarget = "17"
    }
}

tasks.withType&lt;Test&gt; {
    useJUnitPlatform()
}</code></pre>

<h3 data-ke-size="size23"><b>3. Routing전략(with application.yml)</b></h3>
<p data-ke-size="size16">토이 프로젝트는 MSA환경으로 끌고 갈 생각이었다.</p>
<p data-ke-size="size16">API Gateway는 18080포트로, 그 이하는 18081, 18082로 넘기는 걸 예시로 했다.</p>

<p data-ke-size="size16">cloud.gateway.routes를 통해 어디로 routing해줄지 정해준다. id로 구분을 하며 Predicates를 통해 어떤 경로가 들어왔을 경우인지에 대해 힌트를 제공해 준다. 여기 있는 작업들은 java/kotlin 코드로도 작성이 가능하다.</p>
<p data-ke-size="size16">그리고 rewrtie path옵션을 달아두었다.</p>
<p data-ke-size="size16">Rewrite를 하는 이유는 우리가 요청받은 path는 account의 경우 /account/login 같이 이루어질 텐데 account의 경우는 routing이 되면 필요가 없어 login만 던지기 위함이다.</p>
<pre id="code_1702182087943" data-ke-language="bash" data-ke-type="codeblock"><code>server:
  port: 18080

spring:
  main:
    web-application-type: reactive
  application:
    name: user-api-gateway
  cloud:
    gateway:
      routes:
        - id: account-service
          uri: http://localhost:18081
          predicates:
            - Path=/account/**
          filters:
            - RewritePath=/account/(?&lt;segment&gt;.*), /$\{segment}
        - id: shopping
          uri: http://localhost:18082
          predicates:
            - Path=/shopping/**

      filter:
        rewrite-path:
          enabled: true</code></pre>

<h3 data-ke-size="size23"><b>4. Account service</b></h3>
<p data-ke-size="size16">이제 간단하게 account service를 만들어보자.</p>
<p data-ke-size="size16">yml파일에서는 간단하게 서버 포트만 지정해 주었다.</p>
<pre id="code_1702182121830" data-ke-language="bash" data-ke-type="codeblock"><code>server:
  port: 18081</code></pre>
<p data-ke-size="size16">routing에 대한 테스트를 위해 간단한 컨트롤러를 하나 붙였다.</p>
<pre id="code_1702182137824" data-ke-language="kotlin" data-ke-type="codeblock"><code>@RestController
class TestController {
    @GetMapping("/abc")
    fun foo(): String{
        println("call!!")
        return ""
    }

}</code></pre>

<h3 data-ke-size="size23"><b>5. Test(with postman)</b></h3>
<figure data-ke-mobilestyle="widthOrigin" data-origin-width="1510" data-origin-height="1018">
    <span data-url="https://blog.kakaocdn.net/dn/nnhc7/btsBDLfLnYJ/8q5ZbYFskf8M0UraZeoPxK/img.png" data-lightbox="lightbox">
        <img src="https://blog.kakaocdn.net/dn/nnhc7/btsBDLfLnYJ/8q5ZbYFskf8M0UraZeoPxK/img.png" onerror="this.onerror=null; this.src='//t1.daumcdn.net/tistory_admin/static/images/no-image-v1.png'; this.srcset='//t1.daumcdn.net/tistory_admin/static/images/no-image-v1.png';" width="781" height="527" data-origin-width="1510" data-origin-height="1018">
    </span>
    
</figure>

<p data-ke-size="size16">ref</p>
<p data-ke-size="size16"><a href="https://spring.io/projects/spring-cloud-gateway" target="_blank" rel="noopener&nbsp;noreferrer">https://spring.io/projects/spring-cloud-gateway</a></p>
<figure id="og_1702181946425" contenteditable="false" data-ke-type="opengraph" data-ke-align="alignCenter" data-og-type="website" data-og-title="Spring Cloud Gateway" data-og-description="This project provides a libraries for building an API Gateway on top of Spring WebFlux or Spring WebMVC. Spring Cloud Gateway aims to provide a simple, yet effective way to route to APIs and provide cross cutting concerns to them such as: security, monitor" data-og-host="spring.io" data-og-source-url="https://spring.io/projects/spring-cloud-gateway" data-og-url="https://spring.io/projects/spring-cloud-gateway" data-og-image="https://scrap.kakaocdn.net/dn/bsJwxm/hyUL0iBVcx/nWh7syg5Q8Kr0Iz6gZUWL1/img.png?width=1200&amp;height=600&amp;face=0_0_1200_600,https://scrap.kakaocdn.net/dn/bPtzhQ/hyUIqQNNiw/Vbuv8qEkncLw8IIBNNopUk/img.png?width=1200&amp;height=600&amp;face=0_0_1200_600"><a href="https://spring.io/projects/spring-cloud-gateway" target="_blank" rel="noopener" data-source-url="https://spring.io/projects/spring-cloud-gateway">

<div>
<p data-ke-size="size16">Spring Cloud Gateway</p>
<p data-ke-size="size16">This project provides a libraries for building an API Gateway on top of Spring WebFlux or Spring WebMVC. Spring Cloud Gateway aims to provide a simple, yet effective way to route to APIs and provide cross cutting concerns to them such as: security, monitor</p>
<p data-ke-size="size16">spring.io</p>
</div>
</a><img src="https://scrap.kakaocdn.net/dn/bsJwxm/hyUL0iBVcx/nWh7syg5Q8Kr0Iz6gZUWL1/img.png?width=1200&amp;height=600&amp;face=0_0_1200_600,https://scrap.kakaocdn.net/dn/bPtzhQ/hyUIqQNNiw/Vbuv8qEkncLw8IIBNNopUk/img.png?width=1200&amp;height=600&amp;face=0_0_1200_600"></figure>
<p data-ke-size="size16"><span></span><a href="https://ykh6242.tistory.com/entry/Spring-Cloud-Gateway%EA%B0%80-netty-%EA%B8%B0%EB%B0%98-reactive-web-application%EC%9C%BC%EB%A1%9C-%EA%B5%AC%EB%8F%99%EB%90%98%EB%8A%94-%EC%9D%B4%EC%9C%A0">https://ykh6242.tistory.com/entry/Spring-Cloud-Gateway가-netty-기반-reactive-web-application으로-구동되는-이유</a></p>
<figure id="og_1702182178560" contenteditable="false" data-ke-type="opengraph" data-ke-align="alignCenter" data-og-type="article" data-og-title="Spring Cloud Gateway가 netty 기반 reactive web application으로 구동되는 이유" data-og-description="개요 Spring Cloud Gateway 애플리케이션을 구동하게 되면 기존의 임베디드 톰켓 기반의 Spring Boot Web 애플리케이션과는 다르게 Netty 기반의 비동기 통신을 지원하는 형태의 웹 애플리케이션으로 실행" data-og-host="ykh6242.tistory.com" data-og-source-url="https://ykh6242.tistory.com/entry/Spring-Cloud-Gateway가-netty-기반-reactive-web-application으로-구동되는-이유" data-og-url="https://ykh6242.tistory.com/entry/Spring-Cloud-Gateway%EA%B0%80-netty-%EA%B8%B0%EB%B0%98-reactive-web-application%EC%9C%BC%EB%A1%9C-%EA%B5%AC%EB%8F%99%EB%90%98%EB%8A%94-%EC%9D%B4%EC%9C%A0" data-og-image="https://scrap.kakaocdn.net/dn/ca2FSz/hyUIvR6xTv/rZaDTa7Gq8CyoRJck0KsHk/img.png?width=800&amp;height=800&amp;face=0_0_800_800,https://scrap.kakaocdn.net/dn/yVs8Q/hyUL6XqiFc/Os0nyih1TFkTPH1dEZPGJk/img.png?width=800&amp;height=800&amp;face=0_0_800_800"><a href="https://ykh6242.tistory.com/entry/Spring-Cloud-Gateway%EA%B0%80-netty-%EA%B8%B0%EB%B0%98-reactive-web-application%EC%9C%BC%EB%A1%9C-%EA%B5%AC%EB%8F%99%EB%90%98%EB%8A%94-%EC%9D%B4%EC%9C%A0" target="_blank" rel="noopener" data-source-url="https://ykh6242.tistory.com/entry/Spring-Cloud-Gateway가-netty-기반-reactive-web-application으로-구동되는-이유">

<div>
<p data-ke-size="size16">Spring Cloud Gateway가 netty 기반 reactive web application으로 구동되는 이유</p>
<p data-ke-size="size16">개요 Spring Cloud Gateway 애플리케이션을 구동하게 되면 기존의 임베디드 톰켓 기반의 Spring Boot Web 애플리케이션과는 다르게 Netty 기반의 비동기 통신을 지원하는 형태의 웹 애플리케이션으로 실행</p>
<p data-ke-size="size16">ykh6242.tistory.com</p>
</div>
</a><img src="https://scrap.kakaocdn.net/dn/ca2FSz/hyUIvR6xTv/rZaDTa7Gq8CyoRJck0KsHk/img.png?width=800&amp;height=800&amp;face=0_0_800_800,https://scrap.kakaocdn.net/dn/yVs8Q/hyUL6XqiFc/Os0nyih1TFkTPH1dEZPGJk/img.png?width=800&amp;height=800&amp;face=0_0_800_800"></figure>

            
            
                </div></div>

흔한 컴공출신 개발자

bernoyoun

0. 이 글을 작성하는 이유
Spring API Gateway를 사용하며 정리하기 위해
 
1. 이전 글에서 좀 달라진 점
이전 글 : https://developer-youn.tistory.com/174
 
토이프로젝트에서 kotlin + jdk17 + spring boot3을 사용하며 API Gateway를 사용하려고 했는데 netflix-zuul의 경우 더 이상 기능 개발도 안 한다고 해서 cloud-gateway로 넘어가라고 했다.
https://github.com/spring-cloud/spring-cloud-netflix/issues/4158
 
2. 그래서 내 Gradle은
이렇게 나왔다.
import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
plugins {
    id("org.springframework.boot") version "3.0.6"
    id("io.spring.dependency-management") version "1.1.4"
    kotlin("jvm") version "1.9.20"
    kotlin("plugin.spring") version "1.9.20"
}
extra["springCloudVersion"] = "2022.0.3"
group = "com.cooffee"
version = "0.0.1-SNAPSHOT"
java {
    sourceCompatibility = JavaVersion.VERSION_17
}
repositories {
    mavenCentral()
}
dependencyManagement {
    imports {
        mavenBom("org.springframework.cloud:spring-cloud-dependencies:${property("springCloudVersion")}")
    }
}
dependencies {
    implementation("org.springframework.boot:spring-boot-starter-web")
    implementation("com.fasterxml.jackson.module:jackson-module-kotlin")
    implementation("org.jetbrains.kotlin:kotlin-reflect")
    implementation("org.jetbrains.kotlin:kotlin-stdlib-jdk8")
    implementation("org.springframework.cloud:spring-cloud-starter-gateway")
    implementation("io.netty:netty-resolver-dns-native-macos:4.1.68.Final:osx-aarch_64")
    testImplementation("org.springframework.boot:spring-boot-starter-test")
}
tasks.withType<KotlinCompile> {
    kotlinOptions {
        freeCompilerArgs += "-Xjsr305=strict"
        jvmTarget = "17"
    }
}
tasks.withType<Test> {
    useJUnitPlatform()
}
 
3. Routing전략(with application.yml)
토이 프로젝트는 MSA환경으로 끌고 갈 생각이었다.
API Gateway는 18080포트로, 그 이하는 18081, 18082로 넘기는 걸 예시로 했다.
 
cloud.gateway.routes를 통해 어디로 routing해줄지 정해준다. id로 구분을 하며 Predicates를 통해 어떤 경로가 들어왔을 경우인지에 대해 힌트를 제공해 준다. 여기 있는 작업들은 java/kotlin 코드로도 작성이 가능하다.
그리고 rewrtie path옵션을 달아두었다.
Rewrite를 하는 이유는 우리가 요청받은 path는 account의 경우 /account/login 같이 이루어질 텐데 account의 경우는 routing이 되면 필요가 없어 login만 던지기 위함이다.
server:
  port: 18080
spring:
  main:
    web-application-type: reactive
  application:
    name: user-api-gateway
  cloud:
    gateway:
      routes:
        - id: account-service
          uri: http://localhost:18081
          predicates:
            - Path=/account/**
          filters:
            - RewritePath=/account/(?<segment>.*), /$\{segment}
        - id: shopping
          uri: http://localhost:18082
          predicates:
            - Path=/shopping/**
      filter:
        rewrite-path:
          enabled: true
 
4. Account service
이제 간단하게 account service를 만들어보자.
yml파일에서는 간단하게 서버 포트만 지정해 주었다.
server:
  port: 18081
routing에 대한 테스트를 위해 간단한 컨트롤러를 하나 붙였다.
@RestController
class TestController {
    @GetMapping("/abc")
    fun foo(): String{
        println("call!!")
        return ""
    }
}
 
5. Test(with postman)
 
ref
https://spring.io/projects/spring-cloud-gateway
https://ykh6242.tistory.com/entry/Spring-Cloud-Gateway가-netty-기반-reactive-web-application으로-구동되는-이유

Spring API Gateway 간단한 예제

댓글