APIゲートウェイの役割とZuulの概要

マイクロサービスアーキテクチャにおいて、外部クライアントからのリクエストを一元管理するための中間層としてAPIゲートウェイが利用されます。Netflix社が提供しているZuulは、Servlet仕様準拠のWebアプリケーションとして動作し、動的ルーティング、フィルタリング、モニタリング、およびセキュリティ検査を実装するための基盤フレームワークです。Zuulは、各サービスインスタンスへの直接アクセスを遮断し、ゲートウェイ経由でのみ許可されたパスへのフォワーディングを行うことで、システムのエッジ層を強化します。

Maven依存関係の定義

Spring BootプロジェクトにZuulおよびEurekaクライアントの依存ライブラリを追加し、ゲートウェイモジュールのビルド環境を構築します。以下の設定では、Spring Cloud Finchleyラインを使用し、必要なStarter依存性を宣言しています。

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.0.5.RELEASE</version>
    </parent>

    <groupId>com.microservice.gateway</groupId>
    <artifactId>zuul-routing-gateway</artifactId>
    <version>1.0.0-SNAPSHOT</version>
    <packaging>jar</packaging>

    <properties>
        <java.version>1.8</java.version>
        <spring-cloud.version>Finchley.SR2</spring-cloud.version>
    </properties>

    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-dependencies</artifactId>
                <version>${spring-cloud.version}</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-zuul</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>
</project>

ゲートウェイプロキシの有効化

アプリケーション起動クラスに@EnableZuulProxyアノテーションを付与することで、Zuulのリバースプロキシ機能がアクティブになります。このアノテーションにより、Eurekaサーバーから登録情報を取得し、サービスIDベースの動的ルーティングが有効化されます。

package com.microservice.gateway;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.netflix.zuul.EnableZuulProxy;

@SpringBootApplication
@EnableZuulProxy
public class GatewayRoutingApplication {

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

ルーティング設定とレジストリ連携

外部からアクセスされるURLパスと、内部サービスインスタントとのマッピングは設定ファイルで定義します。以下では、/api-v1/** で始まるリクエストを特定のサービスIDへ転送し、Eurekaサーバーへの接続先を指定しています。

spring.application.name=zuul-gateway-node
server.port=9090

# ルーティングパスとターゲットサービスIDの紐付け
zuul.routes.internal-api.path=/api-v1/**
zuul.routes.internal-api.serviceId=client-node

# サービスレジストリへの接続先
eureka.client.service-url.defaultZone=http://localhost:8761/eureka/

実行確認と負荷分散の動作検証

Eurekaサーバー、バックエンドサービスインスタンス、および構築したゲートウェイモジュールを順次起動し、ブラウザまたはHTTPクライアントツールを用いてhttp://localhost:9090/api-v1/hello にリクエストを送信します。Zuulは内部でRibbonと連携しているため、同一サービスIDを持つ複数のインスタンスが存在する場合、リクエストがラウンドロビン方式で分配されます。連続してアクセスを繰り返し、レスポンス元が動的に切り替わることを確認することで、ゲートウェイ経由での負荷分散機能が正常に動作していることが検証できます。