API Gateway & Reverse Proxy (Nginx + Spring Cloud Gateway) · レッスン

Eureka／Consulとの統合

Spring Cloud GatewayをEurekaやConsulなどのサービスレジストリに登録し、サービスを検出できるよう設定します。

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

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

What is Service Discovery?

In a microservices architecture, services are often dynamic. They can scale up or down, and their network locations (IP addresses, ports) can change frequently.

Service discovery is a mechanism that helps applications and services find each other without needing to hardcode their network locations. It's like a dynamic phone book for your services!

Service Registries: Eureka & Consul

A service registry is a central server that maintains a list of available service instances and their network locations.

Netflix Eureka: A very popular choice, especially within the Spring Cloud ecosystem. Services register themselves with Eureka.
HashiCorp Consul: Another robust option, offering service discovery along with a distributed key-value store and health checks.

Both allow services to register themselves and discover others.

Gateway's Need for Discovery

Spring Cloud Gateway acts as the entry point to your microservices.

Instead of configuring routes with fixed URLs for each backend service, the Gateway can query a service registry:

"Where is the 'user-service' running right now?"
"Give me an available instance of 'product-service'."

This enables flexible, dynamic, and resilient routing, as the Gateway doesn't need to know service locations upfront.

Sample Service: Eureka Client Config

First, let's look at how a simple Spring Boot service is configured to register itself with a Eureka server.

We'll use a service named hello-service. Its application.yml will point to the Eureka server's default zone.

spring:
  application:
    name: hello-service
server:
  port: 8081
eureka:
  client:
    serviceUrl:
      defaultZone: http://localhost:8761/eureka

Enabling Eureka Client in Service

To make our hello-service actually register with Eureka, we need to add the @EnableEurekaClient annotation to its main application class.

This annotation activates the Eureka Discovery Client functionality.

package com.example.helloservice;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.netflix.eureka.EnableEurekaClient;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@EnableEurekaClient
@SpringBootApplication
@RestController
public class HelloServiceApplication {

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

    @GetMapping("/hello")
    public String hello() {
        return "Hello from Hello Service!";
    }
}

Gateway Configuration for Eureka

Now, let's configure our Spring Cloud Gateway to connect to the same Eureka server. The Gateway itself also acts as a Eureka client to discover other services.

Its application.yml will specify the Eureka server URL and its own application name.

server:
  port: 8080
eureka:
  client:
    serviceUrl:
      defaultZone: http://localhost:8761/eureka
  instance:
    hostname: localhost
spring:
  application:
    name: api-gateway

Enabling Discovery in Gateway

Similar to the backend service, the Gateway's main application class needs an annotation to enable its discovery capabilities.

Use @EnableDiscoveryClient to tell Spring Boot to activate the discovery client for the Gateway.

package com.example.apigateway;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.client.discovery.EnableDiscoveryClient;

@EnableDiscoveryClient
@SpringBootApplication
public class ApiGatewayApplication {

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

Routing via Service ID

With discovery enabled, we can define Gateway routes using a service's registered ID instead of a fixed URL.

The lb:// prefix (for 'load balancer') tells the Gateway to use its discovery client to find instances of the specified service name (e.g., hello-service) and then route the request.

spring:
  cloud:
    gateway:
      routes:
        - id: hello_route
          uri: lb://hello-service
          predicates:
            - Path=/hello/**

The Request Flow

Let's trace a request to http://localhost:8080/hello:

The Gateway (listening on port 8080) receives the request.
It matches the /hello/** path predicate to the hello_route.
The Gateway uses its Eureka client to look up an available instance of hello-service.
Eureka returns the address of an instance (e.g., localhost:8081).
The Gateway forwards the request to http://localhost:8081/hello.
The hello-service processes the request and returns a response, which the Gateway then sends back to the client.

Consul: Another Option

While Eureka is widely used, Consul by HashiCorp is another powerful service discovery and configuration management tool.

To use Consul, you'd typically add the Spring Cloud Consul Discovery dependency and configure your Gateway/services to point to the Consul agent (usually running on port 8500).

The principle remains the same: the Gateway uses service IDs (e.g., lb://my-service) to dynamically discover and route to services registered in Consul.

spring:
  cloud:
    consul:
      host: localhost
      port: 8500
      discovery:
        service-name: api-gateway

Gateway Discovery Check

You've configured your Spring Cloud Gateway to use Eureka for service discovery, and you have a service named my-service registered in Eureka.

Which uri configuration would correctly route requests to my-service via discovery?

Lesson Summary

In this lesson, you learned about:

The importance of service discovery in dynamic microservice environments.
How Eureka and Consul serve as central service registries.
Configuring both backend services and Spring Cloud Gateway as discovery clients.
Defining Gateway routes using service IDs (e.g., lb://service-name) for dynamic routing.

This integration is fundamental for building scalable and resilient microservice architectures. Next, we'll explore more dynamic routing rules and predicates.

よくある質問

「Eureka／Consulとの統合」レッスンは無料ですか？

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

「Eureka／Consulとの統合」で何を学びますか？

Spring Cloud GatewayをEurekaやConsulなどのサービスレジストリに登録し、サービスを検出できるよう設定します。ブラウザで直接実行するハンズオンコードでAPI Gateway & Reverse Proxy (Nginx + Spring Cloud Gateway)を演習し、24時間対応のAIチューターがレッスンを進める中での質問に答えます。

API Gateway & Reverse Proxy (Nginx + Spring Cloud Gateway)を始めるのに経験は必要ですか？

事前経験は必要ありません。CoddyKitのAPI Gateway & Reverse Proxy (Nginx + Spring Cloud Gateway)は初級者から上級者向けに構成されているため、ここから始めるか最初から始めて、自分のペースで進むことができます。これはレッスン1/4です。

「Eureka／Consulとの統合」レッスンにはどのくらい時間がかかりますか？

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

このAPI Gateway & Reverse Proxy (Nginx + Spring Cloud Gateway)レッスンでコードを書いて実行できますか？

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

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

← API Gateway & Reverse Proxy (Nginx + Spring Cloud Gateway)に戻る