Spring Boot 4 Complete Guide · レッスン

Spring Cloud GatewayによるAPI Gateway

Spring Cloud Gatewayを使用してAPI Gatewayを構築し、リクエストのルーティング、セキュリティ処理、横断的関心事の管理を行います。

レッスン 3/411 ステップ

「Spring Cloud GatewayによるAPI Gateway」はCoddyKit上の無料Spring Boot 4 Complete Guideレッスンです。これはレッスン3/4です。下記で完全なレッスンを無料で読むことができます。その後、ブラウザ内の組み込みコードエディタと24時間対応のAIチューターでハンズオン演習できます。これはSpring Boot 4 Complete Guide学習パスの一部であり、ウェブとCoddyKitアプリ全体で進捗が同期されます。 Spring Boot 4 Complete Guideコースには全4レッスンが含まれています。

このレッスンの一部はまだ翻訳されておらず、英語で表示されています。

API Gateway: The Front Door

In a microservices architecture, you often have many small, independent services. How do client applications (like a mobile app or web browser) interact with them?

An API Gateway acts as a single, unified entry point for all client requests. Instead of clients needing to know about and call individual services, they simply communicate with the gateway.

Why Use an API Gateway?

Gateways centralize common functionalities that would otherwise be duplicated across multiple services or handled by clients. This simplifies development and enhances service management. Key benefits include:

Request Routing: Directing incoming requests to the correct backend microservice.
Security: Handling authentication and authorization at the edge.
Rate Limiting: Protecting services from being overwhelmed by too many requests.
Monitoring & Logging: Centralized collection of request metrics and logs.
Circuit Breaking: Improving resilience against failures in downstream services.

Introducing Spring Cloud Gateway

Spring Cloud Gateway (SCG) is a powerful, reactive API Gateway built on Spring WebFlux. It's designed for high performance and scalability, making it ideal for modern microservices.

SCG replaced the older Netflix Zuul and provides a more modern, non-blocking way to manage API traffic efficiently.

Setting Up Your Gateway Project

To start building an API Gateway, you need a Spring Boot project with specific dependencies. The core ones are:

spring-cloud-starter-gateway: Provides the gateway capabilities.
spring-boot-starter-webflux: The reactive web framework SCG is built upon.

You can easily generate a project with these dependencies using Spring Initializr.

Code: A Minimal Gateway

This is a minimal Spring Cloud Gateway application. It defines a simple route using Java configuration (an alternative to application.yml) that forwards requests from /hello to httpbin.org/get.

Try running it! Then, open your browser and access http://localhost:8080/hello. You should see a JSON response from httpbin.org.

package com.coddykit.gateway;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.gateway.route.RouteLocator;
import org.springframework.cloud.gateway.route.builder.RouteLocatorBuilder;
import org.springframework.context.annotation.Bean;

@SpringBootApplication
public class GatewayApplication {

  public static void main(String[] args) {
    SpringApplication.run(GatewayApplication.class, args);
  }

  @Bean
  public RouteLocator customRouteLocator(RouteLocatorBuilder builder) {
    return builder.routes()
      .route("hello_route", r -> r.path("/hello")
        .uri("http://httpbin.org/get"))
      .build();
  }
}

Configuring Routes with YAML

While Java configuration is useful for programmatic routes, the most common and flexible way to define routes in Spring Cloud Gateway is using application.yml or application.properties.

This allows for externalizing configuration and easier management. Each route consists of an id, a target uri, and predicates to match incoming requests.

Example application.yml snippet:

spring:
  cloud:
    gateway:
      routes:
        - id: my_service_route
          uri: http://localhost:8081
          predicates:
            - Path=/api/myservice/**
server:
  port: 8080

Request Predicates: The Matchmakers

Predicates are crucial components of a route. They are conditions that must be met for a route to be applied to an incoming request. They evaluate various aspects of the HTTP request.

Common predicates include:

Path=/users/**: Matches requests based on the URI path.
Method=GET,POST: Matches specific HTTP methods.
Host=*.example.com: Matches requests based on the host header.
Header=X-Request-Id, \d+: Matches requests with a specific header and a regex value.

Code: Routing with Path Predicate

Let's configure a route using application.yml that uses the Path predicate to forward requests starting with /backend/** to a service running on port 8081.

Place this in your src/main/resources/application.yml:

spring:
  cloud:
    gateway:
      routes:
        - id: backend_service_route
          uri: http://localhost:8081
          predicates:
            - Path=/backend/**
  application:
    name: api-gateway
server:
  port: 8080

When you access http://localhost:8080/backend/hello, the gateway will route it to http://localhost:8081/hello.

Gateway Filters: Request & Response Magic

Filters allow you to modify the incoming request or the outgoing response. They can be applied to specific routes (route-specific filters) or to all routes (global filters).

Examples of built-in filters:

AddRequestHeader: Adds a header to the request before sending it to the downstream service.
AddResponseHeader: Adds a header to the response before sending it back to the client.
RateLimiter: Controls the number of requests allowed per unit of time, preventing abuse.

Test Your Gateway Knowledge

Consider a Spring Cloud Gateway application configured with the following route:

spring:
  cloud:
    gateway:
      routes:
        - id: my_product_route
          uri: lb://PRODUCT-SERVICE
          predicates:
            - Path=/products/{segment}
          filters:
            - AddRequestHeader=X-Request-Source, Gateway

Which of the following statements are TRUE about this configuration?

対話的なレッスンで答える

Recap: Gateway Essentials

You've learned about the fundamental role of API Gateways in a microservices architecture and how Spring Cloud Gateway implements this pattern.

An API Gateway acts as a single, central entry point for clients.
Routes define how incoming requests are mapped to backend services.
Predicates are conditions that determine which requests a route applies to.
Filters allow you to modify requests or responses, handling cross-cutting concerns like security or rate limiting.

Mastering SCG is key to building robust and scalable microservice systems!

無料で開始

AI チューターと学ぶ Java — 無料

ブラウザでリアルコードを書いて実行し、24/7 の AI チューターから瞬時にサポートを受け、ウェブまたはアプリで続きから学習できます。

コース: 21
レッスン: 84

無料で学習を始めるコース全体を表示

よくある質問

「Spring Cloud GatewayによるAPI Gateway」レッスンは無料ですか？

はい。「Spring Cloud GatewayによるAPI Gateway」の完全なテキストはこのウェブで無料で読めます。インタラクティブに演習し（組み込みコードエディタと24時間対応のAIチューター）、Spring Boot 4 Complete Guideコースの残りをアンロックするには、CoddyKit PROにアップグレードしてください。 Spring Boot 4 Complete Guideコースには全4レッスンが含まれています。

「Spring Cloud GatewayによるAPI Gateway」で何を学びますか？

Spring Cloud Gatewayを使用してAPI Gatewayを構築し、リクエストのルーティング、セキュリティ処理、横断的関心事の管理を行います。ブラウザで直接実行するハンズオンコードでSpring Boot 4 Complete Guideを演習し、24時間対応のAIチューターがレッスンを進める中での質問に答えます。

Spring Boot 4 Complete Guideを始めるのに経験は必要ですか？

事前経験は必要ありません。CoddyKitのSpring Boot 4 Complete Guideは初級者から上級者向けに構成されているため、ここから始めるか最初から始めて、自分のペースで進むことができます。これはレッスン3/4です。

「Spring Cloud GatewayによるAPI Gateway」レッスンにはどのくらい時間がかかりますか？

ほとんどのCoddyKitレッスンは約5～10分かかります。各レッスンはコンパクトでインタラクティブなので、着実に進歩し、ウェブとアプリ全体で正確に前回の場所から再開できます。

このSpring Boot 4 Complete Guideレッスンでコードを書いて実行できますか？

はい。すべてのSpring Boot 4 Complete Guideレッスンに組み込みコードエディタが含まれているため、ブラウザでリアルコードを書いて実行し、即座のAIフィードバックを取得できます。ローカル設定は不要です。

このコースのすべてのレッスン

← Spring Boot 4 Complete Guideに戻る